OracleCommand Class

OracleCommand Class

 
Note: This API is now obsolete.

Represents an SQL statement or stored procedure to execute against a database. This class cannot be inherited.

Namespace:   System.Data.OracleClient
Assembly:  System.Data.OracleClient (in System.Data.OracleClient.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbCommand
        System.Data.OracleClient.OracleCommand

[ObsoleteAttribute("OracleCommand has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260", 
	false)]
public sealed class OracleCommand : DbCommand, ICloneable

NameDescription
System_CAPS_pubmethodOracleCommand()

Initializes a new instance of the OracleCommand.

System_CAPS_pubmethodOracleCommand(String)

Initializes a new instance of the OracleCommand class with the text of the query.

System_CAPS_pubmethodOracleCommand(String, OracleConnection)

Initializes a new instance of the OracleCommand class with the text of the query and an OracleConnection object.

System_CAPS_pubmethodOracleCommand(String, OracleConnection, OracleTransaction)

Initializes a new instance of the OracleCommand class with the text of the query, an OracleConnection object, and an OracleTransaction.

NameDescription
System_CAPS_pubpropertyCommandText

Gets or sets the SQL statement or stored procedure to execute against the database.(Overrides DbCommand.CommandText.)

System_CAPS_pubpropertyCommandTimeout

Gets or sets the wait time before terminating the attempt to execute a command and generating an error.(Overrides DbCommand.CommandTimeout.)

System_CAPS_pubpropertyCommandType

Gets or sets a value indicating how the CommandText property is interpreted.(Overrides DbCommand.CommandType.)

System_CAPS_pubpropertyConnection

Gets or sets the OracleConnection used by this instance of the OracleCommand.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyDesignTimeVisible

Gets or sets a value indicating whether the command object should be visible in a customized interface control.(Overrides DbCommand.DesignTimeVisible.)

System_CAPS_pubpropertyParameters
System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTransaction

Gets or sets the OracleTransaction within which the OracleCommand executes.

System_CAPS_pubpropertyUpdatedRowSource

Gets or sets a value that specifies how the Update method should apply command results to the DataRow.(Overrides DbCommand.UpdatedRowSource.)

NameDescription
System_CAPS_pubmethodCancel()

Attempts to cancel the execution of an OracleCommand.(Overrides DbCommand.Cancel().)

System_CAPS_pubmethodClone()

Creates a copy of this OracleCommand object.

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodCreateParameter()

Creates a new instance of an OracleParameter object.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExecuteNonQuery()

Executes an SQL statement against the Connection and returns the number of rows affected.(Overrides DbCommand.ExecuteNonQuery().)

System_CAPS_pubmethodExecuteNonQueryAsync()

An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.

Invokes ExecuteNonQueryAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteNonQueryAsync(CancellationToken)

This is the asynchronous version of ExecuteNonQuery. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteNonQuery method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteOracleNonQuery(OracleString)

Executes an SQL statement against the Connection and returns the number of rows affected.

System_CAPS_pubmethodExecuteOracleScalar()

Executes the query, and returns the first column of the first row in the result set returned by the query as an Oracle-specific data type. Extra columns or rows are ignored.

System_CAPS_pubmethodExecuteReader()

Sends the CommandText to the Connection and builds an OracleDataReader.

System_CAPS_pubmethodExecuteReader(CommandBehavior)

Sends the CommandText to the Connection, and builds an OracleDataReader using one of the CommandBehavior values.

System_CAPS_pubmethodExecuteReaderAsync()

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CancellationToken)

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader. This method propagates a notification that operations should be canceled.

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior)

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior, CancellationToken)

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteScalar()

Executes the query, and returns the first column of the first row in the result set returned by the query as a .NET Framework data type. Extra columns or rows are ignored.(Overrides DbCommand.ExecuteScalar().)

System_CAPS_pubmethodExecuteScalarAsync()

An asynchronous version of ExecuteScalar, which executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.

Invokes ExecuteScalarAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteScalarAsync(CancellationToken)

This is the asynchronous version of ExecuteScalar. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteScalar method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteScalar will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.(Inherited from DbCommand.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodPrepare()

Creates a prepared (or compiled) version of the command at the data source.(Overrides DbCommand.Prepare().)

System_CAPS_pubmethodResetCommandTimeout()

Resets the CommandTimeout property to the default value.

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.CreateParameter()

Creates a new instance of an IDbDataParameter object.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.ExecuteReader()

Executes the CommandText against the Connection and builds an IDataReader.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.ExecuteReader(CommandBehavior)

Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Connection

Gets or sets the IDbConnection used by this instance of the IDbCommand.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Parameters

Gets the IDataParameterCollection.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Transaction

Gets or sets the DbTransaction within which this DbCommand object executes.(Inherited from DbCommand.)

This type is deprecated and will be removed in a future version of the .NET Framework. For more information, see Oracle and ADO.NET.

The OracleCommand class provides the following methods for executing commands against a data source:

Item

Description

ExecuteReader

Executes commands that return rows.

ExecuteOracleNonQuery

Executes an SQL statement against the Connection and returns the number of rows affected.

ExecuteNonQuery

Executes commands such as SQL INSERT, DELETE, UPDATE, and SET statements.

ExecuteScalar

Retrieves a single value (for example, an aggregate value) from a database as a .NET Framework data type.

ExecuteOracleScalar

Retrieves a single value (for example, an aggregate value) from a database as an Oracle-specific data type.

You can reset the CommandText property and reuse the OracleCommand object.

If execution of the command results in a fatal OracleException, the OracleConnection may close. However, the user can reopen the connection and continue.

System_CAPS_noteNote

Unlike the Command object in the other .NET Framework data providers (SQL Server, OLE DB, and ODBC), the OracleCommand object does not support a CommandTimeout property. Setting a command timeout has no effect and the value returned is always zero.

The following example uses the ExecuteReader method of OracleCommand, along with OracleDataReader and OracleConnection, to select rows from a table.

public void ReadMyData(string connectionString)
{
    string queryString = "SELECT EmpNo, DeptNo FROM Scott.Emp";
    using (OracleConnection connection = new OracleConnection(connectionString))
    {
        OracleCommand command = new OracleCommand(queryString, connection);
        connection.Open();
        OracleDataReader reader = command.ExecuteReader();
        try
        {
            while (reader.Read())
            {
                Console.WriteLine(reader.GetInt32(0) + ", " + reader.GetInt32(1));
            }
        }
        finally
        {
            // always call Close when done reading.
            reader.Close();
        }
    }
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft