Class CqlQueryBase<TEntity>

Inheritance
object
Statement
CqlQueryBase<TEntity>
CqlQuerySingleElement<TEntity>
CqlQuery<TEntity>
CqlScalar<TEntity>
Implements
Inherited Members
Namespace: Cassandra.Data.Linq
Assembly: Cassandra.dll
Syntax
public abstract class CqlQueryBase<TEntity> : Statement, IStatement
Type Parameters
Name Description
TEntity

Properties

ElementType

Declaration
public Type ElementType { get; }
Property Value
Type Description
Type

Expression

Declaration
public Expression Expression { get; }
Property Value
Type Description
Expression

Keyspace

Returns the keyspace this query operates on.

Note that not all Statement implementations specify on which keyspace they operate on so this method can return null. If null, it will operate on the default keyspace set during initialization (if it was set).

The keyspace returned is used as a hint for token-aware routing.

Declaration
public override string Keyspace { get; }
Property Value
Type Description
string
Overrides
Remarks

Consider using a ISession connected to single keyspace using Connect(string).

QueryAbortTimeout

Declaration
protected int QueryAbortTimeout { get; }
Property Value
Type Description
int

QueryTrace

After being executed, it retrieves the trace of the CQL query.

Use EnableTracing(bool) to enable tracing.

Note that enabling query trace introduces server-side overhead by storing request information, so it's recommended that you only enable query tracing when trying to identify possible issues / debugging.

Declaration
public QueryTrace QueryTrace { get; protected set; }
Property Value
Type Description
QueryTrace

RoutingKey

The routing key (in binary raw form) to use for token aware routing of this query.

The routing key is optional in the sense that implementers are free to return null. The routing key is an hint used for token aware routing (see

TokenAwarePolicy), and if provided should correspond to the binary value for the query partition key. However, not providing a routing key never causes a query to fail and if the load balancing policy used is not token aware, then the routing key can be safely ignored.
Declaration
public override RoutingKey RoutingKey { get; }
Property Value
Type Description
RoutingKey
Overrides

Methods

BeginExecute(AsyncCallback, object)

Declaration
public IAsyncResult BeginExecute(AsyncCallback callback, object state)
Parameters
Type Name Description
AsyncCallback callback
object state
Returns
Type Description
IAsyncResult

EndExecute(IAsyncResult)

Declaration
public IEnumerable<TEntity> EndExecute(IAsyncResult ar)
Parameters
Type Name Description
IAsyncResult ar
Returns
Type Description
IEnumerable<TEntity>

Execute()

Evaluates the Linq query, executes the cql statement and adapts the results.

Declaration
public IEnumerable<TEntity> Execute()
Returns
Type Description
IEnumerable<TEntity>

Execute(string)

Evaluates the Linq query, executes the cql statement with the provided execution profile and adapts the results.

Declaration
public IEnumerable<TEntity> Execute(string executionProfile)
Parameters
Type Name Description
string executionProfile
Returns
Type Description
IEnumerable<TEntity>

ExecuteAsync()

Evaluates the Linq query, executes asynchronously the cql statement and adapts the results.

Declaration
public Task<IEnumerable<TEntity>> ExecuteAsync()
Returns
Type Description
Task<IEnumerable<TEntity>>

ExecuteAsync(string)

Evaluates the Linq query, executes asynchronously the cql statement with the provided execution profile and adapts the results.

Declaration
public Task<IEnumerable<TEntity>> ExecuteAsync(string executionProfile)
Parameters
Type Name Description
string executionProfile
Returns
Type Description
Task<IEnumerable<TEntity>>

GetCql(out object[])

Declaration
protected abstract string GetCql(out object[] values)
Parameters
Type Name Description
object[] values
Returns
Type Description
string

GetTable()

Declaration
public ITable GetTable()
Returns
Type Description
ITable

InternalExecuteWithProfileAsync(string, string, object[])

Declaration
protected Task<RowSet> InternalExecuteWithProfileAsync(string executionProfile, string cqlQuery, object[] values)
Parameters
Type Name Description
string executionProfile
string cqlQuery
object[] values
Returns
Type Description
Task<RowSet>

Implements