Class Statement

Base class for statements that contains the options.

Inheritance
System.Object
Statement
BatchStatement
BoundStatement
Batch
CqlQueryBase<TEntity>
RegularStatement
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Dse
Assembly: Dse.dll
Syntax
public abstract class Statement : IStatement

Constructors

Statement()

Declaration
protected Statement()

Statement(QueryProtocolOptions)

Declaration
protected Statement(QueryProtocolOptions queryProtocolOptions)
Parameters
Type Name Description
QueryProtocolOptions queryProtocolOptions

Fields

ProxyExecuteKey

Declaration
protected const string ProxyExecuteKey = "ProxyExecute"
Field Value
Type Description
System.String

Properties

AutoPage

Declaration
public bool AutoPage { get; }
Property Value
Type Description
System.Boolean

ConsistencyLevel

Declaration
public ConsistencyLevel? ConsistencyLevel { get; }
Property Value
Type Description
System.Nullable<ConsistencyLevel>

Host

Gets the host configured on this Statement, or null if none is configured.

In the general case, the host used to execute this Statement will depend on the configured ILoadBalancingPolicy and this property will return null.

SetHost(Host)
Declaration
public Host Host { get; }
Property Value
Type Description
Host

IsIdempotent

Declaration
public bool? IsIdempotent { get; }
Property Value
Type Description
System.Nullable<System.Boolean>

IsTracing

Declaration
public bool IsTracing { get; }
Property Value
Type Description
System.Boolean

Keyspace

Declaration
public abstract string Keyspace { get; }
Property Value
Type Description
System.String

OutgoingPayload

Declaration
public IDictionary<string, byte[]> OutgoingPayload { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Byte[]>

PageSize

Declaration
public int PageSize { get; }
Property Value
Type Description
System.Int32

PagingState

Declaration
public byte[] PagingState { get; }
Property Value
Type Description
System.Byte[]

QueryValues

Declaration
public virtual object[] QueryValues { get; }
Property Value
Type Description
System.Object[]

ReadTimeoutMillis

Declaration
public int ReadTimeoutMillis { get; }
Property Value
Type Description
System.Int32

RetryPolicy

Declaration
public IRetryPolicy RetryPolicy { get; }
Property Value
Type Description
IRetryPolicy

RoutingKey

Declaration
public abstract RoutingKey RoutingKey { get; }
Property Value
Type Description
RoutingKey

SerialConsistencyLevel

Gets the serial consistency level for this query.

Declaration
public ConsistencyLevel SerialConsistencyLevel { get; }
Property Value
Type Description
ConsistencyLevel

SkipMetadata

Declaration
public bool SkipMetadata { get; }
Property Value
Type Description
System.Boolean

Timestamp

Declaration
public DateTimeOffset? Timestamp { get; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

Methods

DisableTracing()

Declaration
public IStatement DisableTracing()
Returns
Type Description
IStatement

EnableTracing(Boolean)

Declaration
public IStatement EnableTracing(bool enable = true)
Parameters
Type Name Description
System.Boolean enable
Returns
Type Description
IStatement

ExecutingAs(String)

Declaration
public IStatement ExecutingAs(string userOrRole)
Parameters
Type Name Description
System.String userOrRole
Returns
Type Description
IStatement

SetAutoPage(Boolean)

Declaration
public IStatement SetAutoPage(bool autoPage)
Parameters
Type Name Description
System.Boolean autoPage
Returns
Type Description
IStatement

SetConsistencyLevel(Nullable<ConsistencyLevel>)

Declaration
public IStatement SetConsistencyLevel(ConsistencyLevel? consistency)
Parameters
Type Name Description
System.Nullable<ConsistencyLevel> consistency
Returns
Type Description
IStatement

SetHost(Host)

Sets the Host that should handle this query.

In the general case, use of this method is heavily discouraged and should only be used in the following cases:

  • Querying node-local tables, such as tables in the system and system_views keyspaces.
  • Applying a series of schema changes, where it may be advantageous to execute schema changes in sequence on the same node.

Configuring a specific host causes the configured ILoadBalancingPolicy to be completely bypassed. However, if the load balancing policy dictates that the host is at distance Ignored or there is no active connectivity to the host, the request will fail with a NoHostAvailableException.

Declaration
public IStatement SetHost(Host host)
Parameters
Type Name Description
Host host

The host that should be used to handle executions of this statement or null to delegate to the configured load balancing policy.
Returns
Type Description
IStatement

this instance

SetIdempotence(Boolean)

Declaration
public IStatement SetIdempotence(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
IStatement

SetOutgoingPayload(IDictionary<String, Byte[]>)

Declaration
public IStatement SetOutgoingPayload(IDictionary<string, byte[]> payload)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Byte[]> payload
Returns
Type Description
IStatement

SetPageSize(Int32)

Declaration
public IStatement SetPageSize(int pageSize)
Parameters
Type Name Description
System.Int32 pageSize
Returns
Type Description
IStatement

SetPagingState(Byte[])

Declaration
public IStatement SetPagingState(byte[] pagingState)
Parameters
Type Name Description
System.Byte[] pagingState
Returns
Type Description
IStatement

SetReadTimeoutMillis(Int32)

Declaration
public IStatement SetReadTimeoutMillis(int timeout)
Parameters
Type Name Description
System.Int32 timeout
Returns
Type Description
IStatement

SetRetryPolicy(IRetryPolicy)

Declaration
public IStatement SetRetryPolicy(IRetryPolicy policy)
Parameters
Type Name Description
IRetryPolicy policy
Returns
Type Description
IStatement

SetSerialConsistencyLevel(ConsistencyLevel)

Declaration
public IStatement SetSerialConsistencyLevel(ConsistencyLevel serialConsistency)
Parameters
Type Name Description
ConsistencyLevel serialConsistency
Returns
Type Description
IStatement

SetTimestamp(DateTimeOffset)

Declaration
public IStatement SetTimestamp(DateTimeOffset value)
Parameters
Type Name Description
System.DateTimeOffset value
Returns
Type Description
IStatement

Implements