Class QueryRequest

Encapsulates all the information required to execute a query as well as the state of execution and the result.

Inheritance

System.Object

QueryRequest

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data

Assembly: TimeCockpit.Data.dll

Syntax

public class QueryRequest

Remarks

Contains the following:

Properties

Cache

Gets or sets the select cache.

Declaration

public SelectCache Cache { get; set; }

Property Value

Type	Description
SelectCache

CompletionSource

Gets the completion source for the query.

Declaration

public TaskCompletionSource<EntityObject[]> CompletionSource { get; }

Property Value

Type	Description
System.Threading.Tasks.TaskCompletionSource<EntityObject[]>

Parameters

Gets the query parameters.

Declaration

public IEnumerable<QueryParameter> Parameters { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<QueryParameter>

QueryTask

Gets the task producing the result of the query.

Declaration

public Task<EntityObject[]> QueryTask { get; }

Property Value

Type	Description
System.Threading.Tasks.Task<EntityObject[]>

QueryTCQL

Gets the string representation of the query.

Declaration

public string QueryTCQL { get; }

Property Value

Type	Description
System.String

Settings

Gets or sets the select settings.

Declaration

public SelectSettings Settings { get; set; }

Property Value

Type	Description
SelectSettings

Methods

Create(String, IEnumerable<QueryParameter>, SelectSettings)

Creates a new query object.

Declaration

public static QueryRequest Create(string query, IEnumerable<QueryParameter> parameters = null, SelectSettings settings = null)

Parameters

Type	Name	Description
System.String	query	The query to use.
System.Collections.Generic.IEnumerable<QueryParameter>	parameters	The query parameters.
SelectSettings	settings	The select settings.

Returns

Type	Description
QueryRequest	Returns a new query object.

Create(Query, IEnumerable<QueryParameter>, SelectSettings)

Creates query request using an AST representation of a Query.

Declaration

public static QueryRequest Create(Query queryAST, IEnumerable<QueryParameter> parameters = null, SelectSettings settings = null)

Parameters

Type	Name	Description
Query	queryAST	The query AST to select.
System.Collections.Generic.IEnumerable<QueryParameter>	parameters	The query parameters to use.
SelectSettings	settings	The select settings to use for the query.

Returns

Type	Description
QueryRequest	Returns the query request.

Parameter(String, Object)

Creates a query parameter for the query.

Declaration

public static QueryParameter Parameter(string name, object value)

Parameters

Type	Name	Description
System.String	name	The name of the parameter.
System.Object	value	The value of the parameter.

Returns

Type	Description
QueryParameter	Returns a new query parameter.