SphinxQLConnection Class

Represents a connection to Sphinx. This class cannot be inherited.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Data.CommonDbConnection
        SphinxConnector.SphinxQLSphinxQLConnection

Namespace: SphinxConnector.SphinxQL
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 3.12.6

Syntax

Copy

public sealed class SphinxQLConnection : DbConnection

Public NotInheritable Class SphinxQLConnection
	Inherits DbConnection

The SphinxQLConnection type exposes the following members.

Constructors

	Name	Description
	SphinxQLConnection	Initializes a new instance of the SphinxQLConnection class.
	SphinxQLConnection(String)	Initializes a new instance of the SphinxQLConnection class.

Top

Methods

	Name	Description
	BeginTransaction	Begins a new transaction.
	BeginTransaction(IsolationLevel)	Begins a new transaction with the specified isolation level. Not supported.
	ChangeDatabase	Changes the current database for an open connection. Not supported. (Overrides DbConnectionChangeDatabase(String).)
	Close	Closes the connection to Sphinx. This is the preferred method of closing any open connection. (Overrides DbConnectionClose.)
	CreateCommand	Creates and returns a SphinxQLCommand object associated with the current connection.
	CreateCommand(String)	Creates and returns a SphinxQLCommand object associated with the current connection and the provided command text.
	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.)
	Dispose	Releases all resources used by the Component. (Inherited from Component.)
	EnlistTransaction	Enlists in the specified transaction. (Overrides DbConnectionEnlistTransaction(Transaction).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetSchema	Returns schema information for the data source of this SphinxQLConnection. Not supported. (Overrides DbConnectionGetSchema.)
	GetSchema(String)	Returns schema information for the data source of this SphinxQLConnection using the specified string for the schema name. Not supported. (Overrides DbConnectionGetSchema(String).)
	GetSchema(String, String)	Returns schema information for the data source of this SphinxQLConnection using the specified string for the schema name and the specified string array for the restriction values. Not supported. (Overrides DbConnectionGetSchema(String, String).)
	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.)
	Open	Opens a connection to Sphinx. (Overrides DbConnectionOpen.)
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Properties

	Name	Description
	ConnectionString	Gets or sets the string used to open the connection. (Overrides DbConnectionConnectionString.)
	ConnectionTimeout	Gets the time (in seconds) to wait while establishing a connection before terminating the attempt and generating an error. (Overrides DbConnectionConnectionTimeout.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	Database	Always returns "Sphinx". (Overrides DbConnectionDatabase.)
	DataSource	Gets the name of the Sphinx server to which to connect. (Overrides DbConnectionDataSource.)
	ServerVersion	Gets a string that represents the version of the server to which the object is connected. (Overrides DbConnectionServerVersion.)
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	State	Gets a string that describes the state of the connection. (Overrides DbConnectionState.)

Top

Events

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	StateChange	Occurs when the state of the event changes. (Inherited from DbConnection.)

Top

Explicit Interface Implementations

	Name	Description
	IDbConnectionBeginTransaction	Begins a database transaction. (Inherited from DbConnection.)
	IDbConnectionBeginTransaction(IsolationLevel)	Begins a database transaction with the specified IsolationLevel value. (Inherited from DbConnection.)
	IDbConnectionCreateCommand	Creates and returns a DbCommand object that is associated with the current connection. (Inherited from DbConnection.)

Top

Remarks

On creation, all properties of the class are set to their initial values. The default ConnectionString is an empty string which is equivalent to "Data Source=localhost;Port=9306;pooling=false;Min Pool Size=5;Max Pool Size=20".

Examples

The following example creates a SphinxQLCommand and a SphinxQLConnection to retrieve data from an index.

Copy

string connectionString = "Data Source=localhost;Port=9306;pooling=true";

using (SphinxQLConnection connection = new SphinxQLConnection(connectionString))
{
    SphinxQLCommand sphinxQLCommand = new SphinxQLCommand("SELECT * from sakila;", sphinxQLConnection);

    connection.Open();

    using (SphinxQLDataReader sphinxQLDataReader = sphinxQLCommand.ExecuteReader())
    {
        while(sphinxQLDataReader.Read())
        {
            Console.Writeline(sphinxQLDataReader.GetInt32("id");
        }
    }
}

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.

Reference

SphinxConnector.SphinxQL Namespace