Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Node.js Driver. Switch to the latest stable version.
ExecutionOptions¶
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.
Constructor¶
new ExecutionOptions()
Creates a new instance of ExecutionOptions.
Methods¶
(abstract) getCaptureStackTrace() → {Boolean}
Determines if the stack trace before the query execution should be maintained.
Returns:
- Type
- Boolean
(abstract) getConsistency() → {Number}
Gets the Consistency level to be used for the execution.
Returns:
- Type
- Number
(abstract) getCustomPayload() → {Object}
Key-value payload to be passed to the server. On the server side, implementations of QueryHandler can use this data.
Returns:
- Type
- Object
(abstract) getFetchSize() → {Number}
Gets the amount of rows to retrieve per page.
Returns:
- Type
- Number
getFixedHost() → {Host}
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.
Returns:
- Type
- Host
(abstract) getHints() → {Array<ColumnInfo>|Array<Array<ColumnInfo>>|undefined}
Gets the type hints for parameters given in the query, ordered as for the parameters.
Returns:
- Type
- Array<ColumnInfo> | Array<Array<ColumnInfo>> | undefined
(abstract) getKeyspace() → {String}
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.
Returns:
- Type
- String
getLoadBalancingPolicy() → {LoadBalancingPolicy}
Gets the load balancing policy used for this execution.
Returns:
A LoadBalancingPolicy instance, it can't be undefined.
- Type
- LoadBalancingPolicy
(abstract) getPageState() → {Buffer}
Gets the Buffer representing the paging state.
Returns:
- Type
- Buffer
getRawQueryOptions() → {QueryOptions}
Gets the query options as provided to the execution method without setting the default values.
Returns:
- Type
- QueryOptions
(abstract) getReadTimeout() → {Number}
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.
Returns:
- Type
- Number
(abstract) getRetryPolicy() → {RetryPolicy}
Gets the retry policy to be used.
Returns:
A RetryPolicy instance, it can't be undefined.
- Type
- RetryPolicy
(abstract) getRoutingKey() → {Buffer|Array<Buffer>}
Gets the partition key(s) to determine which coordinator should be used for the query.
Returns:
- Type
- Buffer | Array<Buffer>
(abstract) getSerialConsistency() → {Number}
Gets the the consistency level to be used for the serial phase of conditional updates.
Returns:
- Type
- Number
(abstract) getTimestamp() → {Number|Long|undefined|null}
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.
Returns:
- Type
- Number | Long | undefined | null
(abstract) isAutoPage() → {Boolean}
Determines whether the driver must retrieve the following result pages automatically.
This setting is only considered by the Client#eachRow() method.
Returns:
- Type
- Boolean
(abstract) isBatchCounter() → {Boolean}
Determines whether its a counter batch. Only valid for Client#batch(), it will be ignored by other methods.
Returns:
A Boolean value, it can't be undefined.
- Type
- Boolean
(abstract) isBatchLogged() → {Boolean}
Determines whether the batch should be written to the batchlog. Only valid for Client#batch(), it will be ignored by other methods.
Returns:
A Boolean value, it can't be undefined.
- Type
- Boolean
(abstract) isIdempotent() → {Boolean}
Determines whether the query can be applied multiple times without changing the result beyond the initial application.
Returns:
- Type
- Boolean
(abstract) isPaged() → {boolean}
Determines if the query should be paged.
Returns:
- Type
- boolean
(abstract) isPrepared() → {Boolean}
Determines whether the query must be prepared beforehand.
Returns:
A Boolean value, it can't be undefined.
- Type
- Boolean
(abstract) isQueryTracing() → {Boolean}
Determines whether query tracing is enabled for the execution.
Returns:
- Type
- Boolean