Class CqlCommand

Represents a Linq query (UPDATE/INSERT/DELETE) that gets evaluated as a CQL statement.

Inheritance

object

Statement

RegularStatement

SimpleStatement

CqlCommand

CqlConditionalCommand<TEntity>

CqlDelete

CqlInsert<TEntity>

CqlUpdate

Implements

IStatement

Inherited Members

SimpleStatement.RoutingKey

SimpleStatement.Keyspace

SimpleStatement.SetRoutingKey(params RoutingKey[])

SimpleStatement.SetRoutingValues(params object[])

SimpleStatement.SetQueryString(string)

SimpleStatement.Bind(params object[])

SimpleStatement.BindObjects(object[])

SimpleStatement.SetKeyspace(string)

RegularStatement.ToString()

Statement.ProxyExecuteKey

Statement.SkipMetadata

Statement.ConsistencyLevel

Statement.SerialConsistencyLevel

Statement.PageSize

Statement.IsTracing

Statement.ReadTimeoutMillis

Statement.RetryPolicy

Statement.PagingState

Statement.Timestamp

Statement.AutoPage

Statement.OutgoingPayload

Statement.IsIdempotent

Statement.Host

Statement.ExecutingAs(string)

Statement.SetAutoPage(bool)

Statement.SetPagingState(byte[])

Statement.SetReadTimeoutMillis(int)

Statement.EnableTracing(bool)

Statement.DisableTracing()

Statement.SetRetryPolicy(IRetryPolicy)

Statement.SetIdempotence(bool)

Statement.SetPageSize(int)

Statement.SetOutgoingPayload(IDictionary<string, byte[]>)

Statement.SetHost(Host)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Cassandra.Data.Linq

Assembly: Cassandra.dll

Syntax

public abstract class CqlCommand : SimpleStatement, IStatement

Fields

_timestamp

Declaration

protected DateTimeOffset? _timestamp

Field Value

Type	Description
DateTimeOffset?

_ttl

Declaration

protected int? _ttl

Field Value

Type	Description
int?

Properties

Expression

Declaration

public Expression Expression { get; }

Property Value

Type	Description
Expression

QueryAbortTimeout

Declaration

protected int QueryAbortTimeout { get; }

Property Value

Type	Description
int

QueryString

Gets the query string.

Declaration

public override string QueryString { get; }

Property Value

Type	Description
string

Overrides

SimpleStatement.QueryString

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

QueryValues

Declaration

public override object[] QueryValues { get; }

Property Value

Type	Description
object[]

Overrides

Statement.QueryValues

Methods

BeginExecute(AsyncCallback, object)

Starts executing the statement async

Declaration

public virtual IAsyncResult BeginExecute(AsyncCallback callback, object state)

Parameters

Type	Name	Description
AsyncCallback	callback
object	state

Returns

Type	Description
IAsyncResult

EndExecute(IAsyncResult)

Starts the async executing of the statement

Declaration

public virtual void EndExecute(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar

Execute()

Executes the command using the ISession.

Declaration

public void Execute()

Execute(string)

Executes the command using the ISession with the provided execution profile.

Declaration

public RowSet Execute(string executionProfile)

Parameters

Type	Name	Description
string	executionProfile

Returns

Type	Description
RowSet

ExecuteAsync()

Evaluates the Linq command and executes asynchronously the cql statement.

Declaration

public Task<RowSet> ExecuteAsync()

Returns

Type	Description
Task<RowSet>

ExecuteAsync(string)

Evaluates the Linq command and executes asynchronously the cql statement with the provided execution profile.

Declaration

public Task<RowSet> ExecuteAsync(string executionProfile)

Parameters

Type	Name	Description
string	executionProfile

Returns

Type	Description
Task<RowSet>

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

InitializeStatement()

Declaration

protected void InitializeStatement()

SetConsistencyLevel(ConsistencyLevel?)

Declaration

public CqlCommand SetConsistencyLevel(ConsistencyLevel? consistencyLevel)

Parameters

Type	Name	Description
ConsistencyLevel?	consistencyLevel

Returns

Type	Description
CqlCommand

SetQueryTrace(QueryTrace)

Declaration

public void SetQueryTrace(QueryTrace trace)

Parameters

Type	Name	Description
QueryTrace	trace

SetSerialConsistencyLevel(ConsistencyLevel)

Declaration

public CqlCommand SetSerialConsistencyLevel(ConsistencyLevel consistencyLevel)

Parameters

Type	Name	Description
ConsistencyLevel	consistencyLevel

Returns

Type	Description
CqlCommand

SetTTL(int)

Sets the time for data in a column to expire (TTL) for INSERT and UPDATE commands .

Declaration

public CqlCommand SetTTL(int seconds)

Parameters

Type	Name	Description
int	seconds	Amount of seconds

Returns

Type	Description
CqlCommand

SetTimestamp(DateTimeOffset)

Sets the timestamp associated with this statement execution.

Declaration

public CqlCommand SetTimestamp(DateTimeOffset timestamp)

Parameters

Type	Name	Description
DateTimeOffset	timestamp

Returns

Type	Description
CqlCommand	This instance.

Implements

IStatement