ULCommand class

Represents a pre-compiled SQL statement or query, with or without IN parameters.

Visual Basic syntax

Public NotInheritable Class ULCommand
    Inherits System.Data.Common.DbCommand
    Implements System.ICloneable

C# syntax

public sealed class ULCommand : 
    System.Data.Common.DbCommand, 
    System.ICloneable

Members

All members of ULCommand class, including all inherited members.

Name	Description
ULCommand constructor	Initializes a ULCommand object.
BeginExecuteNonQuery method	Initiates the asynchronous execution of a SQL statement that is described by this ULCommand object.
BeginExecuteReader method	Initiates the asynchronous execution of a SQL statement that is described by this ULCommand object, and retrieves the result set.
Cancel method	This method is not supported in UltraLite.NET.
CreateParameter method	Provides a ULParameter object for supplying parameters to ULCommand objects.
EndExecuteNonQuery method	Finishes asynchronous execution of a SQL statement.
EndExecuteReader method	Finishes asynchronous execution of a SQL statement, returning the requested ULDataReader.
ExecuteDbDataReader method (Inherited from System.Data.Common.DbCommand)	Executes the command text against the connection.
ExecuteNonQuery method	Executes a statement that does not return a result set, such as a SQL INSERT, DELETE, or UPDATE statement.
ExecuteReader method	Executes a SQL SELECT statement and returns the result set.
ExecuteResultSet method	UL Ext: Executes a SQL SELECT statement and returns the result set as a ULResultSet object.
ExecuteScalar method	Executes a SQL SELECT statement and returns a single value.
ExecuteTable method	UL Ext: Retrieves a database table in a ULTable object for direct manipulation.
Prepare method	Pre-compiles and stores the SQL statement of this command.
CommandText property	Specifies the text of the SQL statement or the name of the table when the ULCommand.CommandType property is System.Data.CommandType.TableDirect.
CommandTimeout property	This feature is not supported by UltraLite.NET.
CommandType property	Specifies the type of command to be executed.
Connection property	The connection object on which to execute the ULCommand object.
DesignTimeVisible property	Indicates if the ULCommand object should be visible in a customized Windows Form Designer control.
IndexName property	UL Ext: Specifies the name of the index to open (sort) the table with when the ULCommand.CommandType property is System.Data.CommandType.TableDirect.
Parameters property	Specifies the parameters for the current statement.
Plan property	UL Ext: Returns the access plan UltraLite.NET uses to execute a query.
Transaction property	Specifies the ULTransaction object in which the ULCommand object executes.
UpdatedRowSource property	Specifies how command results are applied to the DataRow when used by the ULDataAdapterUpdate method.

Remarks

This object can be used to execute a statement or query efficiently multiple times.

ULCommand objects can be created directly, or with the ULConnection.CreateCommand method. This method ensures that the command has the correct transaction for executing statements on the given connection.

The ULCommand.Transaction method must be reset after the current transaction is committed or rolled back.

The ULCommand class features the following methods for executing commands on an UltraLite.NET database:

Method	Description
ULCommand.ExecuteNonQuery	Executes a statement that does not return a result set, such as a SQL INSERT, DELETE, or UPDATE statement.
ULCommand.ExecuteReader()	Executes a SQL SELECT statement and returns the result set in a ULDataReader object. Use this method for creating read-only result sets.
ULCommand.ExecuteResultSet()	UL Ext: Executes a SQL SELECT statement and returns the result set in a ULResultSet object. Use this method for creating mutable result sets.
ULCommand.ExecuteScalar	Executes a SQL SELECT statement and returns a single value.
ULCommand.ExecuteTable()	UL Ext: Retrieves a database table in a ULTable object for direct manipulation. The ULCommand.CommandText property is interpreted as the name of the table and the ULCommand.IndexName property can be used to specify a table sorting order. The ULCommand.CommandType property must be System.Data.CommandType.TableDirect.

You can reset most properties, including the ULCommand.CommandText property, and reuse the ULCommand object.

For resource management reasons, it is recommended that you explicitly dispose of commands when you are done with them. In C#, you may use a using statement to automatically call the System.ComponentModel.Component.Dispose method or explicitly call the System.ComponentModel.Component.Dispose method. In Visual Basic, you always explicitly call the System.ComponentModel.Component.Dispose method.

ULCommand class

Visual Basic syntax

C# syntax

Base classes

Members

Remarks

See also