ISphinxQLExecutorQueryT(String, QueryMetadata, Object) Method

Executes the given SphinxQL query and returns a list of results of the given type along with the query metadata. Note: 'SHOW META' is automatically appended to the query.

Definition

Namespace: SphinxConnector.FluentApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 6.1.0

C#

IList<T> Query<T>(
	string query,
	out QueryMetadata metadata,
	Object parameters = null
)

VB

Function Query(Of T) ( 
	query As String,
	<OutAttribute> ByRef metadata As QueryMetadata,
	Optional parameters As Object = Nothing
) As IList(Of T)

Parameters

query String: The query to execute.
metadata QueryMetadata: The metadata for the query.
parameters Object (Optional): Optional parameters for the query.

Type Parameters

T: The result type.

Return Value

IListT
A list of results of the given type. If the type is a built-in type like int, string, etc only the data from the first column is returned, otherwise an instance is created per row, and a case insensitive, direct mapping between column-name and member-name is assumed.

Example

The following example shows how to execute a query that returns metadata:

C#

using (IFulltextSession fulltextSession = fulltextStore.StartSession())
{            
    ISphinxQLExecutor sphinxQLExecutor = fulltextSession.Advanced.CreateSphinxQLExecutor();

    var parameters = new { query = "a product" };

    QueryMetadata metadata;
    var results = sphinxQLExecutor.Query<Product>("SELECT * FROM products WHERE MATCH(@query)", out metadata, parameters);        
}

Exceptions

ArgumentException	Occurs if query is empty.
ArgumentNullException	Occurs if query is null.
FulltextException	Occurs when there is an error during the execution of the query.