Click or drag to resize

SphinxQLCommand Class

Represents a SphinxQL statement to execute against Sphinx. This class cannot be inherited.
Inheritance Hierarchy

Namespace:  SphinxConnector.SphinxQL
Assembly:  SphinxConnector (in SphinxConnector.dll) Version: 5.3.0
Syntax
public sealed class SphinxQLCommand : DbCommand, 
	ICloneable

The SphinxQLCommand type exposes the following members.

Constructors
  NameDescription
Public methodSphinxQLCommand
Initializes a new instance of the SphinxQLCommand class.
Public methodSphinxQLCommand(SphinxQLConnection)
Initializes a new instance of the SphinxQLCommand class.
Public methodSphinxQLCommand(String)
Initializes a new instance of the SphinxQLCommand class.
Public methodSphinxQLCommand(String, SphinxQLConnection)
Initializes a new instance of the SphinxQLCommand class.
Top
Properties
  NameDescription
Public propertyCommandText
Gets or sets the command text to execute.
(Overrides DbCommandCommandText.)
Public propertyCommandTimeout
Gets or sets the wait time before terminating the attempt to execute a command and generating an error. Currently not supported.
(Overrides DbCommandCommandTimeout.)
Public propertyCode exampleCommandType
Indicates or specifies how the CommandText property is interpreted. Setting this property to TableDirect is not supported.
(Overrides DbCommandCommandType.)
Public propertyConnection
Gets or sets the SphinxQLConnection used by this SphinxQLCommand.
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyDesignTimeVisible
Gets or sets a value indicating whether the command object should be visible in a customized interface control.
(Overrides DbCommand.DesignTimeVisible.)
Public propertyParameters
Gets the collection of SphinxQLParameter objects.
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyTransaction
Gets or sets the SphinxQLTransaction within which this SphinxQLCommand object executes.
Public propertyUpdatedRowSource
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.)
Top
Methods
  NameDescription
Public methodCancel
Attempts to cancel the execution of a SphinxQLCommand. Currently not supported.
(Overrides DbCommandCancel.)
Public methodClone
Clones this instance including parameters.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodCreateParameter
Creates a new instance of a DbParameter object.
(Inherited from DbCommand.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteNonQuery
Executes a SphinxQL statement against a connection object.
(Overrides DbCommandExecuteNonQuery.)
Public methodExecuteNonQueryAsync
An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.Invokes ExecuteNonQueryAsync(CancellationToken) with CancellationToken.None.
(Inherited from DbCommand.)
Public methodExecuteNonQueryAsync(CancellationToken)
Executes a SphinxQL statement against a connection object.
(Overrides DbCommandExecuteNonQueryAsync(CancellationToken).)
Public methodExecuteReader
Executes the command text against the connection.
Public methodExecuteReader(CommandBehavior)
Executes the command text against the connection.
Public methodExecuteReaderAsync
Executes the command text against the connection.
Public methodExecuteReaderAsync(CancellationToken)
Executes the command text against the connection.
Public methodExecuteReaderAsync(CommandBehavior)
Executes the command text against the connection.
Public methodExecuteReaderAsync(CommandBehavior, CancellationToken)
Executes the command text against the connection.
Public methodExecuteScalar
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.)
Public methodExecuteScalarAsync
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.)
Public methodExecuteScalarAsync(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).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodPrepare
Creates a prepared (or compiled) version of the command on the data source. Not supported.
(Overrides DbCommandPrepare.)
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Top
Explicit Interface Implementations
Thread Safety
Any 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