DB2 Version 10.1 for Linux, UNIX, and Windows

DB2Command Members

DB2Command overview

Public Constructors

Name Description
DB2®Command()

Initializes a new instance of the DB2Command class.
DB2Command(String)

Initializes a new instance of the DB2Command class with the text of the query.
DB2Command(String, DB2Connection)

Initializes a new instance of the DB2Command class with the text of the query and a DB2Connection object.
DB2Command(String, DB2Connection, DB2Transaction)

Initializes a new instance of the DB2Command class with the text of the query, a DB2Connection object, and the Transaction.

Public Properties

Property Description
public property ArrayBindCount Gets or sets the number of entries in the array to be bound as a parameter.
public property ArrayBindCountOff Public constant value, which can be used to reset the DB2Command.ArrayBindCount property back to non-array mode.
public property AtomicArrayInput Gets or sets boolean value to determine whether to execute multi-row operations in atomic or non-atomic scope.
public property BlockForNRows Controls the number of rows to be returned to client in a single fetch request.
public property CommandText Gets or sets the SQL statement, XQuery expression, or stored procedure to run against the database.
Data Server restrictions:
All data servers other than DB2 Version 9 and later
XQuery expressions are supported only on DB2 Version 9 and later.
public property CommandTimeout Gets or sets the wait time before terminating the execution of a command and generating an error.
public property CommandType Gets or sets a value indicating how the CommandText property is interpreted.
public property Connection Gets or sets the DB2Connection that is used by an instance of the DB2Command.
public property Container (inherited from Component) Gets the IContainer that contains the Component.
public property DB2TypeOutput Determines whether the output-only parameter values associated with the DB2Command are returned as native DB2 data types (specifically, classes and structures in the IBM.Data.DB2Types namespace).
public property DbConnection Gets or sets the DbConnection used by an instance of the DB2Command.
public property DbParameterCollection Gets the DbParameterCollection object.
public property DbTransaction Gets or sets the DbTransaction within which the DB2Command runs.
public property DesignTimeVisible Gets or sets a boolean value indicating whether a DB2Command generated by a data adapter is visible.
public property DisableCursorHold Controls the effect of a transaction completion on open cursors.
public property EnableExtendedIndicators Enables the use of default and unassigned indicators as parameters.
public property Parameters Gets the DB2ParameterCollection .
public property ResultSetAsReturnValue Set this value to retrieve result sets from Informix user-defined routines (UDR) as a ReturnValue parameter. This property is ignored when a ReturnValue parameter is not bound in the parameter collection.
Data Server restrictions:
All data servers other than IBM® Informix
this property is supported only on IBM Informix.
public property RetrieveXmlInBinaryFormat The value representing whether or not XML data should be returned in binary format.
public property Site (inherited from Component) Gets or sets the ISite of the Component.
public property StatementConcentrator Gets or sets the value determining whether or not to enable statement concentrator literals.
public property Transaction Gets or sets the DB2Transaction within which the DB2Command runs.
public property UpdatedRowSource Gets or sets a value that specifies how the Update method applies command results to the DataRow.

Public Methods

Method Description
public method Cancel Attempts to cancel the execution of a DB2Command.
public method CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information that is required to generate a proxy used to communicate with a remote object.
public method CreateParameter Creates a new instance of a DB2Parameter object.
public methodDeriveParameters Retrieves parameter information for the command that is specified in this DB2Command and populates the Parameters collection of the specified DB2Command object.
public method Dispose (inherited from Component) Overridden. Releases the resources used by the Component.
public method Equals (inherited from Object) Overridden. Determines whether two Object instances are equal.
public method ExecuteNonQuery Executes an SQL statement against the Connection and returns the number of rows affected.
public method ExecutePageReader Returns a DB2DataReader instance containing a requested set of rows.
public method ExecuteReader Overloaded. Sends the CommandText to the Connection and builds a DB2DataReader .
public method ExecuteScalar Executes the query, and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.
public method ExecuteResultSet Overloaded. Sends the CommandText to the Connection and builds a DB2ResultSet.
public method ExecuteRow Sends the CommandText to the Connection and builds a DB2Record.
public method ExecuteXmlReader Sends the CommandText property to the Connection and builds an XmlReader.
public method GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures, such as a hash table.
public method GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
public method GetType (inherited from Object) Gets the Type of the current instance.
public method InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
public method Prepare Creates a prepared (or compiled) version of the command at the database.
public method ResetCommandTimeout Resets the CommandTimeout property to the default value.
public method ToString (inherited from Object) Returns a String that represents the current Object.

Public Events

Event Description
public event Disposed (inherited from Component) Adds an event handler to listen to the Disposed event on the component.

Protected Properties

Property Description
protected property DesignMode (inherited from Component) Gets a value that indicates whether the Component is in design mode.
protected property Events (inherited from Component) Gets the list of event handlers that are attached to a Component.

Protected Methods

Method Description
protected method CreateDbParameter Creates a new instance of a DbParameter object.
protected method Dispose Overloaded. Overridden. Releases the resources that are used by the DB2Command.
protected method ExecuteDbDataReader Sends the CommandText to the Connection and builds a DbDataReader object.
protected method Finalize (inherited from Object) Overridden. Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

In C# and Microsoft(R) Visual C++(R), finalizers are expressed by using the destructor syntax.
protected method GetService (inherited from Component) Returns an object that represents a service that is provided by the Component or by its Container.
protected method MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
Reference
DB2Command Class
IBM.Data.DB2 namespace