class ExecutionOptions
A base class that represents a wrapper around the user provided query options with getter methods and proper default values.
Note that getter methods might return undefined
when not set on the query options or default
Client
options.
- Global
- This class is global
Constructor
ExecutionOptions
()Creates a new instance of ExecutionOptions
.
Methods
getCaptureStackTrace
()Determines if the stack trace before the query execution should be maintained.
- Abstract
- This function is abstract
getConsistency
()Gets the Consistency level
to be used for the execution.
- Abstract
- This function is abstract
getCustomPayload
()Key-value payload to be passed to the server. On the server side, implementations of QueryHandler can use this data.
- Abstract
- This function is abstract
getFetchSize
()Gets the amount of rows to retrieve per page.
- Abstract
- This function is abstract
getFixedHost
()When a fixed host is set on the query options and the query plan for the load-balancing policy is not used, it gets the host that should handle the query.
getHints
()Gets the type hints for parameters given in the query, ordered as for the parameters.
- Abstract
- This function is abstract
getKeyspace
()Gets the keyspace for the query when set at query options level.
Note that this method will return undefined
when the keyspace is not set at query options level.
It will only return the keyspace name when the user provided a different keyspace than the current
Client
keyspace.
- Abstract
- This function is abstract
getLoadBalancingPolicy
()Gets the load balancing policy used for this execution.
getPageState
()Gets the Buffer representing the paging state.
- Abstract
- This function is abstract
getRawQueryOptions
()Gets the query options as provided to the execution method without setting the default values.
getReadTimeout
()Gets the timeout in milliseconds to be used for the execution per coordinator.
A value of 0
disables client side read timeout for the execution. Default: undefined
.
- Abstract
- This function is abstract
getRetryPolicy
()Gets the retry policy
to be used.
- Abstract
- This function is abstract
getRoutingKey
()Gets the partition key(s) to determine which coordinator should be used for the query.
- Abstract
- This function is abstract
getSerialConsistency
()Gets the the consistency level to be used for the serial phase of conditional updates.
- Abstract
- This function is abstract
getTimestamp
()Gets the provided timestamp for the execution in microseconds from the unix epoch (00:00:00, January 1st, 1970).
When a timestamp generator is used, this method returns undefined
.
- Abstract
- This function is abstract
isAutoPage
()Determines whether the driver must retrieve the following result pages automatically.
This setting is only considered by the Client#eachRow()
method.
- Abstract
- This function is abstract
isBatchCounter
()Determines whether its a counter batch. Only valid for Client#batch()
, it will be ignored by
other methods.
- Abstract
- This function is abstract
isBatchLogged
()Determines whether the batch should be written to the batchlog. Only valid for
Client#batch()
, it will be ignored by other methods.
- Abstract
- This function is abstract
isIdempotent
()Determines whether the query can be applied multiple times without changing the result beyond the initial application.
- Abstract
- This function is abstract
isPrepared
()Determines whether the query must be prepared beforehand.
- Abstract
- This function is abstract
isQueryTracing
()Determines whether query tracing is enabled for the execution.
- Abstract
- This function is abstract