 | SphinxQLCommand Class |
Represents a SphinxQL statement to execute against Sphinx. This class cannot be inherited.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Data.CommonDbCommand
SphinxConnector.SphinxQLSphinxQLCommand
SystemMarshalByRefObject
System.ComponentModelComponent
System.Data.CommonDbCommand
SphinxConnector.SphinxQLSphinxQLCommand
Namespace: SphinxConnector.SphinxQL
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 5.4.1
SyntaxThe SphinxQLCommand type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SphinxQLCommand |
Initializes a new instance of the SphinxQLCommand class.
|
| SphinxQLCommand(SphinxQLConnection) |
Initializes a new instance of the SphinxQLCommand class.
|
| SphinxQLCommand(String) |
Initializes a new instance of the SphinxQLCommand class.
|
| SphinxQLCommand(String, SphinxQLConnection) |
Initializes a new instance of the SphinxQLCommand class.
|
Properties| Name | Description | |
|---|---|---|
 | CommandText |
Gets or sets the command text to execute.
(Overrides DbCommandCommandText.) |
| CommandTimeout |
Gets or sets the wait time before terminating the attempt to execute a command and generating an error.
Currently not supported.
(Overrides DbCommandCommandTimeout.) |
 | CommandType |
Indicates or specifies how the CommandText property is interpreted.
Setting this property to TableDirect is not supported.
(Overrides DbCommandCommandType.) |
| Connection |
Gets or sets the SphinxQLConnection used by this SphinxQLCommand.
|
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| DesignTimeVisible |
Gets or sets a value indicating whether the command object should be visible in a customized interface control.
(Overrides DbCommand.DesignTimeVisible.) |
| Parameters |
Gets the collection of SphinxQLParameter objects.
|
| Site | (Inherited from Component.) |
| Transaction |
Gets or sets the SphinxQLTransaction within which this SphinxQLCommand object executes.
|
| UpdatedRowSource |
Gets or sets how command results are applied to the DataRow
when used by the Update method of a DbDataAdapter.
Currently not supported.
(Overrides DbCommandUpdatedRowSource.) |
Methods| Name | Description | |
|---|---|---|
| Cancel |
Attempts to cancel the execution of a SphinxQLCommand.
Currently not supported.
(Overrides DbCommandCancel.) |
| Clone |
Clones this instance including parameters.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| CreateParameter | Creates a new instance of a DbParameter object. (Inherited from DbCommand.) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteNonQuery |
Executes a SphinxQL statement against a connection object.
(Overrides DbCommandExecuteNonQuery.) |
| ExecuteNonQueryAsync | An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.Invokes ExecuteNonQueryAsync(CancellationToken) with CancellationToken.None. (Inherited from DbCommand.) |
| ExecuteNonQueryAsync(CancellationToken) |
Executes a SphinxQL statement against a connection object.
(Overrides DbCommandExecuteNonQueryAsync(CancellationToken).) |
| ExecuteReader |
Executes the command text against the connection.
|
| ExecuteReader(CommandBehavior) |
Executes the command text against the connection.
|
| ExecuteReaderAsync |
Executes the command text against the connection.
|
| ExecuteReaderAsync(CancellationToken) |
Executes the command text against the connection.
|
| ExecuteReaderAsync(CommandBehavior) |
Executes the command text against the connection.
|
| ExecuteReaderAsync(CommandBehavior, CancellationToken) |
Executes the command text against the connection.
|
| ExecuteScalar |
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.
(Overrides DbCommandExecuteScalar.) |
| ExecuteScalarAsync | 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(CancellationToken) with CancellationToken.None. (Inherited from DbCommand.) |
| ExecuteScalarAsync(CancellationToken) |
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.
(Overrides DbCommandExecuteScalarAsync(CancellationToken).) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| Prepare |
Creates a prepared (or compiled) version of the command on the data source. Not supported.
(Overrides DbCommandPrepare.) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IDbCommandConnection | Gets or sets the IDbConnection used by this instance of the IDbCommand. (Inherited from DbCommand.) |
 | IDbCommandCreateParameter | Creates a new instance of an IDbDataParameter object. (Inherited from DbCommand.) |
| IDbCommandExecuteReader | (Inherited from DbCommand.) |
| IDbCommandExecuteReader(CommandBehavior) | Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. (Inherited from DbCommand.) |
| ICloneableClone | |
| IDbCommandParameters | Gets the IDataParameterCollection. (Inherited from DbCommand.) |
| IDbCommandTransaction | Gets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.) |
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also