# Global Functions and Constants

## Members

(constant) Integer

Source

encoder.js, line 11

Deprecated

Integer is deprecated. See \`./types/integer.js\`

(constant) VIntCoding

Contains the methods for reading and writing vints into binary format. Exposes only 2 internal methods, the rest are hidden.

Source

utils.js, line 1011

(constant) coreConnectionsPerHostV2

Core connections per host for protocol versions 1 and 2

Source

client-options.js, line 401

(constant) coreConnectionsPerHostV3

Core connections per host for protocol version 3 and above

Source

client-options.js, line 408

(constant) emptyArray

Source

utils.js, line 1278

(constant) emptyObject

Source

utils.js, line 1280

(constant) loggingFinalizationRegistry

FinalizationRegistry that ensures the Rust logging callback is unregistered when a Client instance is garbage-collected without being explicitly shut down.

While in general FinalizationRegistry usage is discouraged, we use it here to avoid blocking the client from being cleaned up, once it's no longer used by the user, and also clean up all the resources in the process. This justifies using finalization registry, despite heavy warnings against it in the documentation.

To understand more, check the JS documentation. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry

Source

client.ts, line 66

(constant) maxInt :number

Max int that can be accurately represented with 64-bit Number (2^53)

Type:

Source

utils.js, line 16

(constant) maxRequestsPerConnectionV2

Default maxRequestsPerConnection value for protocol v1 and v2

Source

client-options.js, line 415

(constant) maxRequestsPerConnectionV3

Default maxRequestsPerConnection value for protocol v3+

Source

client-options.js, line 418

## Methods

adaptNamedParamsPrepared(params, prepared) → {Array<any>}

Adapts the parameters based on the prepared metadata. This function assumes params are passed as an associative array (Object), and it adapts the object into an array with the same order as bound parameters in the prepared statement.

Parameters:
Name Type Description
params Object
prepared PreparedInfo

Source

utils.js, line 313

Throws:

In case a parameter with a specific name is not defined.

Type
Error
Returns:

Returns an array of parameters.

Type
Array<any>

adaptNamedParamsWithHints(params, execOptions) → {Object}

Adapts the associative-array of parameters and hints for simple statements into Arrays based on the (arbitrary) position of the keys.

Parameters:
Name Type Description
params Array<any> | Object
execOptions ExecutionOptions

Source

utils.js, line 335

Returns:

Returns an array of parameters and the keys as an associative array.

Type
Object

arbitraryValueToBigInt()

Ensure the value is one of the accepted numeric types, and convert them to BigInt.

Source

new-utils.ts, line 41

arrayIterator(arr) → {Iterator}

Uses the iterator protocol to go through the items of the Array

Parameters:
Name Type Description
arr Array<any>

Source

utils.js, line 223

Returns:
Type
Iterator

asDouble()

Source

datastax/graph/wrappers.js, line 15

Deprecated

Not supported by the driver. Usage will throw an error.

asFloat()

Source

datastax/graph/wrappers.js, line 22

Deprecated

Not supported by the driver. Usage will throw an error.

asInt()

Source

datastax/graph/wrappers.js, line 8

Deprecated

Not supported by the driver. Usage will throw an error.

asTimestamp()

Source

datastax/graph/wrappers.js, line 29

Deprecated

Not supported by the driver. Usage will throw an error.

asUdt()

Source

datastax/graph/wrappers.js, line 36

Deprecated

Not supported by the driver. Usage will throw an error.

bigintToLong()

Converts from bigint provided by napi into Long type. BigInt is the way napi handles values too big for js Number type, while Long is the legacy way the code handles 64-bit integers.

Source

new-utils.ts, line 27

binarySearch(arr, key, compareFunc) → {number}

Searches the specified Array for the provided key using the binary search algorithm. The Array must be sorted.

Parameters:
Name Type Description
arr Array<any>
key
compareFunc function

Source

utils.js, line 251

Returns:

The position of the key in the Array, if it is found. If it is not found, it returns a negative number which is the bitwise complement of the index of the first element that is larger than key.

Type
number

callbackOnce(callback) → {function}

Parameters:
Name Type Description
callback function

Source

utils.js, line 40

Returns:

Returns a wrapper function that invokes the underlying callback only once.

Type
function

convertComplexType()

Convert rust ComplexType into type representation used in the driver encoder

Source

types/cql-utils.ts, line 113

convertTlsVersion(value) → {rust.TlsVersion}

According to the TS type definition, SecureVersion (the value we are handling here), can be one of the following: type SecureVersion = "TLSv1.3" | "TLSv1.2" | "TLSv1.1" | "TLSv1";

Parameters:
Name Type Description
value 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1'

Source

client-options.js, line 788

Returns:
Type
rust.TlsVersion

copyBuffer()

Creates a copy of a buffer

Source

utils.js, line 52

deepExtend(target) → {Object}

Extends the target by the most inner props of sources

Parameters:
Name Type Description
target Object

Source

utils.js, line 159

Returns:
Type
Object

defaultOptions() → {ClientOptions}

Source

client-options.js, line 427

Returns:
Type
ClientOptions

defaultPromiseFactory(handler) → {Promise}

Parameters:
Name Type Description
handler function

Source

utils.js, line 423

Returns:
Type
Promise

delay(ms) → {Promise<void>}

Creates a non-clearable timer that resolves the promise once elapses.

Parameters:
Name Type Description
ms number

Source

promise-utils.js, line 9

Returns:
Type
Promise<void>

each(arr, fn, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<any>
fn function
callback function <optional>

Source

utils.js, line 617

eachSeries(arr, fn, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<any>
fn function
callback function <optional>

Source

utils.js, line 649

encodeParams(expectedTypes, params, encoder)

Encode whole array of params according to provided type information.

Parameters:
Name Type Description
expectedTypes

List of expected types.
params
encoder

Source

types/cql-utils.ts, line 96

Throws:

ResponseError when received different amount of parameters than expected

Returns:

Returns: null for null values, undefined for unset values and encoded buffers for all other values.

ensure32SignedInteger(number, name)

Checks whether the number is a 32 bit signed integer. Throws an error, when a value that cannot be represented as i32 is passed.

Parameters:
Name Type Description
number
name

used in the thrown error

Source

new-utils.ts, line 62

Throws:
TypeError

ensure64SignedInteger(number, name)

Checks whether the number is a 64 bit signed integer. Throws an error, when a value that cannot be represented as i64 is passed.

Parameters:
Name Type Description
number
name

used in the thrown error

Source

new-utils.ts, line 90

Throws:
TypeError

extend(baseOptionsopt, userOptions) → {ClientOptions}

Extends and validates the user options

Parameters:
Name Type Attributes Description
baseOptions Object <optional>

The source object instance that will be overridden
userOptions Object

Source

client-options.js, line 484

Returns:
Type
ClientOptions

extend()

Merge the contents of two or more objects together into the first object. Similar to jQuery.extend / Object.assign. The main difference between this method is that declared properties with an undefined value are not set to the target.

Source

utils.js, line 122

fixStack()

Appends the original stack trace to the error after a tick of the event loop

Source

utils.js, line 61

forEachOf(arr, fn, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<any>
fn function
callback function <optional>

Source

utils.js, line 689

fromCallback(fn) → {Promise}

Creates a Promise from a callback based function.

Parameters:
Name Type Description
fn function

Source

promise-utils.js, line 36

Returns:
Type
Promise

fromEvent(emitter, eventName) → {Promise}

Creates a Promise that gets resolved or rejected based on an event.

Parameters:
Name Type Description
emitter object
eventName string

Source

promise-utils.js, line 19

Returns:
Type
Promise

getCallback(resolve, reject) → {function}

Gets a function that has the signature of a callback that invokes the appropriate promise handler parameters.

Parameters:
Name Type Description
resolve function
reject function

Source

promise-utils.js, line 54

Returns:
Type
function

getColumnsMetadata(result) → {Array<{name, type}>}

Parameters:
Name Type Description
result rust.QueryResultWrapper

Source

types/results-wrapper.js, line 35

Returns:
Type
Array<{name, type}>

getRowsFromResultsWrapper(result, encoder) → {Array<_Row>|undefined}

Simple way of getting results from rust driver. Call the driver O(columns \* rows) times

Parameters:
Name Type Description
result rust.QueryResultWrapper
encoder _Encoder

Source

types/results-wrapper.js, line 15

Returns:

Returns array of rows if the result is is of the RowsResult kind, and undefined otherwise

Type
Array<_Row> | undefined

hostIdToString()

Derives the hex string representation of a host id from a host id's raw bytes.

Source

host.ts, line 22

ifUndefined()

Returns the first not undefined param

Source

utils.js, line 437

ifUndefined3()

Returns the first not undefined param

Source

utils.js, line 444

insertSorted(arr, item, compareFunc)

Inserts the value in the position determined by its natural order determined by the compare func

Parameters:
Name Type Description
arr Array<any>
item
compareFunc function

Source

utils.js, line 278

isNamedParameters()

Returns true when params is a named (object) parameter set rather than an array.

Source

new-utils.ts, line 123

Throws:

In case params are of unexpected type

Type
ArgumentError

iteratorToArray(iterator) → {Array<any>}

Convert the iterator values into an array

Parameters:
Name Type Description
iterator

Source

utils.js, line 232

Returns:
Type
Array<any>

log(type, info, furtherInfoopt)

Uses the logEmitter to emit log events. Respects the logLevel option — events below the configured severity are suppressed.

Parameters:
Name Type Attributes Description
type String
info String
furtherInfo <optional>

Source

utils.js, line 77

map(arr, fn, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<any>
fn function
callback function <optional>

Source

utils.js, line 698

mapSeries(arr, fn, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<any>
fn function
callback function <optional>

Source

utils.js, line 751

newQueryPlan(lbp, keyspace, executionOptions) → {Promise<Iterator>}

Invokes the new query plan of the load balancing policy and returns a Promise.

Parameters:
Name Type Description
lbp LoadBalancingPolicy

The load balancing policy.
keyspace String

Name of currently logged keyspace at Client level.
executionOptions ExecutionOptions | null

The information related to the execution of the request.

Source

promise-utils.js, line 78

Returns:
Type
Promise<Iterator>

normalizeKey(value, name) → {string}

Normalizes a key that can be either a string or a buffer into a string.

Parameters:
Name Type Description
value string | Buffer
name string

Name of the option being normalized, used for error messages

Source

client-options.js, line 769

Returns:
Type
string

normalizePagingState()

This function normalizes the type, and combines all possible page state sources.

Page state can come from two sources:

PageState has a priority over execOptions, as execOptions.pageState will not be cleared for the following pages of the execution.

Source

client.ts, line 997

normalizeSslOptions(sslOptions) → {rust.SslOptions}

Normalizes SSL options to be passed to the Rust layer. The SslOptions class can have values as multiple types, while the Rust code expects a specific format. We could do this at the napi layer by trying all accepted types until we successfully convert it, but we can also convert it here.

Parameters:
Name Type Description
sslOptions SslOptions

Source

client-options.js, line 817

Returns:
Type
rust.SslOptions

objectValues(obj) → {Array<any>}

Returns an array containing the values of the Object, similar to Object.values(). If obj is null or undefined, it will return an empty array.

Parameters:
Name Type Description
obj Object

Source

utils.js, line 387

Returns:
Type
Array<any>

optionalCallback(promise, callbackopt) → {Promise|undefined}

Method that handles optional callbacks (dual promise and callback support). When callback is undefined it returns the promise. When using a callback, it will use it as handlers of the continuation of the promise.

Parameters:
Name Type Attributes Description
promise Promise
callback function <optional>

Source

promise-utils.js, line 98

Returns:
Type
Promise | undefined

parallel(arr, callbackopt)

Parameters:
Name Type Attributes Description
arr Array<function()>
callback function <optional>

Source

utils.js, line 799

promiseWrapper(options, originalCallback, handler) → {Promise|undefined}

Wraps the callback-based method. When no originalCallback is not defined, it returns a Promise.

Parameters:
Name Type Description
options ClientOptions
originalCallback function
handler function

Source

utils.js, line 406

Returns:
Type
Promise | undefined

series(arr, callbackopt)

Similar to async.series(), but instead accumulating the result in an Array, it callbacks with the result of the last function in the array.

Parameters:
Name Type Attributes Description
arr Array<function()>
callback function <optional>

Source

utils.js, line 828

setMetadataDependent(client)

Sets the default options that depend on the protocol version and other metadata.

Parameters:
Name Type Description
client Client

Source

client-options.js, line 886

socketAddressToString()

Returns the string representation of a given socket address.

Source

host.ts, line 13

stringRepeat(val, times) → {String}

Returns a string with a value repeated n times

Parameters:
Name Type Description
val String
times Number

Source

utils.js, line 366

Returns:
Type
String

throwNotSupported(name)

Internal utility for marking not supported endpoints.

Parameters:
Name Type Description
name

Source

new-utils.ts, line 14

Throws:
ReferenceError

times(count, limit, fn) → {Promise}

Invokes the provided function multiple times, considering the concurrency level limit.

Parameters:
Name Type Description
count Number
limit Number
fn function

Source

promise-utils.js, line 113

Returns:
Type
Promise

times(count, iteratorFunc, callbackopt)

Parameters:
Name Type Attributes Description
count Number
iteratorFunc function
callback function <optional>

Source

utils.js, line 861

timesLimit(count, limit, iteratorFunc, callbackopt)

Parameters:
Name Type Attributes Description
count Number
limit Number
iteratorFunc function
callback function <optional>

Source

utils.js, line 890

timesSeries(count, iteratorFunction, callback)

Parameters:
Name Type Description
count Number
iteratorFunction function
callback function

Source

utils.js, line 933

toBackground(promise) → {undefined}

Deals with unexpected rejections in order to avoid the unhandled promise rejection warning or failure.

Parameters:
Name Type Description
promise Promise

Source

promise-utils.js, line 136

Returns:
Type
undefined

toCallback(promise, callbacknullable) → {undefined}

Invokes the callback once outside the promise chain the promise is resolved or rejected.

Parameters:
Name Type Attributes Description
promise Promise
callback function <nullable>

Source

promise-utils.js, line 146

Returns:
Type
undefined

toLowerCaseProperties()

Returns a new object with the property names set to lowercase.

Source

utils.js, line 144

totalLength()

Gets the sum of the length of the items of an array

Source

utils.js, line 104

validateFn(fn, nameopt) → {function}

Validates the provided parameter is of type function.

Parameters:
Name Type Attributes Description
fn function

The instance to validate.
name String <optional>

Name of the function to use in the error message. Defaults to 'callback'.

Source

utils.js, line 295

Returns:
Type
function

whilst(condition, fn, callback)

Parameters:
Name Type Description
condition function
fn function
callback function

Source

utils.js, line 971

## Type Definitions

ClientOptions

Client options.

While the driver provides lots of extensibility points and configurability, few client options are required.

Default values for all settings are designed to be suitable for the majority of use cases, you should avoid fine tuning it when not needed.

See Client constructor documentation for recommended options.

Type:
Properties:
Name Type Attributes Description
contactPoints Array<string>

Array of addresses or host names of the nodes to add as contact points.

Contact points are addresses of Cassandra nodes that the driver uses to discover the cluster topology.

Only one contact point is required (the driver will retrieve the address of the other nodes automatically), but it is usually a good idea to provide more than one contact point, because if that single contact point is unavailable, the driver will not be able to initialize correctly.
localDataCenter String <optional>

The local data center to use.

If using DCAwareRoundRobinPolicy (default), this option is required and only hosts from this data center are connected to and used in query plans.

[TODO: Add support for this field]
keyspace String <optional>

The logged keyspace for all the connections created within the Client instance.
credentials Object <optional>

An object containing the username and password for plain-text authentication. It configures the authentication provider to be used against Apache Cassandra's PasswordAuthenticator or DSE's DseAuthenticator, when default auth scheme is plain-text.

Note that you should configure either credentials or authProvider to connect to an auth-enabled cluster, but not both.

Properties
Name Type Attributes Description
username String <optional>

The username to use for plain-text authentication.
password String <optional>

The password to use for plain-text authentication.
id Uuid | string <optional>

A unique identifier assigned to a Client object, that will be communicated to the server to identify the client instance created with this options. When not defined, the driver will generate a random identifier.
applicationName String <optional>

An optional setting identifying the name of the application using the Client instance.

This value is passed to database and is useful as metadata for describing a client connection on the server side.
applicationVersion String <optional>

An optional setting identifying the version of the application using the Client instance.

This value is passed to database and is useful as metadata for describing a client connection on the server side.
refreshSchemaDelay Number <optional>

The default window size in milliseconds used to debounce node list and schema refresh metadata requests. Default: 1000. [TODO: Add support for this field]
prepareOnAllHosts Boolean <optional>

Determines if the driver should prepare queries on all hosts in the cluster. Default: true. [TODO: Add support for this field]
rePrepareOnUp Boolean <optional>

Determines if the driver should re-prepare all cached prepared queries on a host when it marks it back up. Default: true. [TODO: Add support for this field]
maxPrepared Number <optional>

Determines the maximum amount of different prepared queries before evicting items from the internal cache. Reaching a high threshold hints that the queries are not being reused, like when hard-coding parameter values inside the queries. Default: 512.
policies Object <optional>
Properties
Name Type Attributes Description
loadBalancing LoadBalancingPolicy <optional>

The load balancing policy instance to be used to determine the coordinator per query.
retry RetryPolicy <optional>

The retry policy.
reconnection ReconnectionPolicy <optional>

The reconnection policy to be used. [TODO: Add support for this field]
addressResolution AddressTranslator <optional>

The address resolution policy. [TODO: Add support for this field]
speculativeExecution SpeculativeExecutionPolicy <optional>

The SpeculativeExecutionPolicy instance to be used to determine if the client should send speculative queries when the selected host takes more time than expected.

Default: NoSpeculativeExecutionPolicy

[TODO: Add support for this field]
timestampGeneration TimestampGenerator <optional>

The client-side query timestamp generator.

Default: MonotonicTimestampGenerator

Use null to disable client-side timestamp generation.

[TODO: Add support for this field]
queryOptions QueryOptions <optional>

Default options for all queries. [TODO: Add support for this field]
pooling Object <optional>

Pooling options. [TODO: Add support for this field]

Properties
Name Type Attributes Description
heartBeatInterval Number <optional>

The amount of idle time in milliseconds that has to pass before the driver issues a request on an active connection to avoid idle time disconnections. Default: 30000. [TODO: Add support for this field]
coreConnectionsPerHost Object <optional>

Associative array containing amount of connections per host distance. [TODO: Add support for this field]
maxRequestsPerConnection Number <optional>

The maximum number of requests per connection. The default value is:

  • For modern protocol versions (v3 and above): 2048
  • For older protocol versions (v1 and v2): 128

[TODO: Add support for this field]
warmup Boolean <optional>

Determines if all connections to hosts in the local datacenter must be opened on connect. Default: true. [TODO: Add support for this field]
protocolOptions Object <optional>

[TODO: Add support for this field]

Properties
Name Type Attributes Description
port Number <optional>

The port to use to connect to the Cassandra host. If not set through this method, the default port (9042) will be used instead. [TODO: Add support for this field]
maxSchemaAgreementWaitSeconds Number <optional>

The maximum time in seconds to wait for schema agreement between nodes before returning from a DDL query. Default: 10. [TODO: Add support for this field]
maxVersion Number <optional>

When set, it limits the maximum protocol version used to connect to the nodes. Useful for using the driver against a cluster that contains nodes with different major/minor versions of Cassandra. [TODO: Add support for this field]
socketOptions Object <optional>

[TODO: Add support for this field]

Properties
Name Type Attributes Description
connectTimeout Number <optional>

Connection timeout in milliseconds. Default: 5000. [TODO: Add support for this field]
defunctReadTimeoutThreshold Number <optional>

Determines the amount of requests that simultaneously have to timeout before closing the connection. Default: 64. [TODO: Add support for this field]
keepAlive Boolean <optional>

Whether to enable TCP keep-alive on the socket. Default: true. [TODO: Add support for this field]
keepAliveDelay Number <optional>

TCP keep-alive delay in milliseconds. Default: 0. [TODO: Add support for this field]
readTimeout Number <optional>

Per-host read timeout in milliseconds.

Please note that this is not the maximum time a call to Client#execute may have to wait; this is the maximum time that call will wait for one particular Cassandra host, but other hosts will be tried if one of them timeout. In other words, a Client#execute call may theoretically wait up to readTimeout \* number_of_cassandra_hosts (though the total number of hosts tried for a given query also depends on the LoadBalancingPolicy in use).

When setting this value, keep in mind the following:

  • the timeout settings used on the Cassandra side (\*_request_timeout_in_ms in cassandra.yaml) should be taken into account when picking a value for this read timeout. You should pick a value a couple of seconds greater than the Cassandra timeout settings.
  • the read timeout is only approximate and only control the timeout to one Cassandra host, not the full query.

Setting a value of 0 disables read timeouts. Default: 12000. [TODO: Add support for this field]
tcpNoDelay Boolean <optional>

When set to true, it disables the Nagle algorithm. Default: true. [TODO: Add support for this field]
coalescingThreshold Number <optional>

Buffer length in bytes use by the write queue before flushing the frames. Default: 8000. [TODO: Add support for this field]
authProvider AuthProvider <optional>

Provider to be used to authenticate to an auth-enabled cluster. [TODO: Add support for this field]
requestTracker RequestTracker <optional>

The instance of RequestTracker used to monitor or log requests executed with this instance. [TODO: Add support for this field]
sslOptions SslOptions <optional>

Client-to-node ssl options. When set the driver will use the secure layer. You can specify cert, ca, ... options named after the Node.js tls.connect() options.

It uses the same default values as Node.js tls.connect() [TODO: For now, only limited subset of ssl options is supported]
encoding Object <optional>

Encoding options. [TODO: Add support for this field]

Properties
Name Type Attributes Description
map function <optional>

Map constructor to use for Cassandra map<k,v> type encoding and decoding. If not set, it will default to Javascript Object with map keys as property names. [TODO: Add support for this field]
set function <optional>

Set constructor to use for Cassandra set type encoding and decoding. If not set, it will default to Javascript Array. [TODO: Add support for this field]
copyBuffer Boolean <optional>

Determines if the network buffer should be copied for buffer based data types (blob, uuid, timeuuid and inet).

Setting it to true will cause that the network buffer is copied for each row value of those types, causing additional allocations but freeing the network buffer to be reused. Setting it to true is a good choice for cases where the Row and ResultSet returned by the queries are long-lived objects.

Setting it to false will cause less overhead and the reference of the network buffer to be maintained until the row / result set are de-referenced. Default: true.

[TODO: Add support for this field]
useUndefinedAsUnset Boolean <optional>

Valid for Cassandra 2.2 and above. Determines that, if a parameter is set to undefined it should be encoded as unset.

By default, ECMAScript undefined is encoded as null in the driver. Cassandra 2.2 introduced the concept of unset. At driver level, you can set a parameter to unset using the field types.unset. Setting this flag to true allows you to use ECMAScript undefined as Cassandra unset.

Default: true.
useBigIntAsLong Boolean <optional>

Use BigInt type to represent CQL bigint and counter data types. Defaults to true.
useBigIntAsVarint Boolean <optional>

Use BigInt type to represent CQL varint data type. Defaults to true.

Note, that using Integer as Varint (useBigIntAsVarint == false) is deprecated.
logLevel String <optional>

The minimum severity of log events emitted by the driver.

WARNING: While you can configure different log levels for different clients, each client will receive log messages from all clients at the specified severity.

Valid values are defined in the module:types~logLevels enum. We recommend using the enum values (e.g. types.logLevels.info) rather than raw strings.

When set to a value other than 'off', additional driver log messages (connection events, query routing, retries, etc.) will be emitted as 'log' events on the Client instance.

When not set, events at warning level and above are captured. Set to 'off' to disable logging.
profiles Array<ExecutionProfile> <optional>

The array of execution profiles.
promiseFactory function <optional>

Function to be used to create a Promise from a callback-style function.

Promise libraries often provide different methods to create a promise. For example, you can use Bluebird's Promise.fromCallback() method.

By default, the driver will use the Promise constructor.

[TODO: Add support for this field]

Source

client-options.js, line 23

QueryOptions

Query options

Type:
Properties:
Name Type Attributes Description
autoPage boolean <optional>

Determines if the driver must retrieve the following result pages automatically.

This setting is only considered by the Client#eachRow() method. For more information, check the paging results documentation.
captureStackTrace boolean <optional>

Determines if the stack trace before the query execution should be maintained.

Useful for debugging purposes, it should be set to false under production environment as it adds an unnecessary overhead to each execution.

Default: false. [TODO: Add support for this field]
consistency number <optional>

Consistency level.

Defaults to localOne for Apache Cassandra and ScyllaDB deployments.

[TODO: Test this field]
customPayload Object <optional>

Key-value payload to be passed to the server. On the Cassandra side, implementations of QueryHandler can use this data. [TODO: Add support for this field]
executionProfile string | ExecutionProfile <optional>

Name or instance of the profile to be used for this execution. If not set, it will the use "default" execution profile. [TODO: Add support for this field]
fetchSize number <optional>

Amount of rows to retrieve per page. Only valid if query is paged.
hints Array<any> | Array<Array<any>> <optional>

Type hints for parameters given in the query, ordered as for the parameters.

For batch queries, an array of such arrays, ordered as with the queries in the batch.
host Host <optional>

The host that should handle the query.

Use of this option is heavily discouraged and should only be used in the following cases:

  1. Querying node-local tables, such as tables in the system and system_views keyspaces.
  2. 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 LoadBalancingPolicy to be completely bypassed. However, if the load balancing policy dictates that the host is at a distance of ignored or there is no active connectivity to the host, the request will fail with a NoHostAvailableError.
idempotent boolean <optional>

Defines whether the query can be applied multiple times without changing the result beyond the initial application.

The query execution idempotence can be used at RetryPolicy level to determine if an statement can be retried in case of request error or write timeout.

Default: false.

[TODO: Add support for this field]
keyspace string <optional>

Specifies the keyspace for the query. It is used for the following:

  1. To indicate what keyspace the statement is applicable to (protocol V5+ only). This is useful when the query does not provide an explicit keyspace and you want to override the current Client#keyspace.
  2. For query routing when the query operates on a different keyspace than the current Client#keyspace.

[TODO: Add support for this field]
logged boolean <optional>

Determines if the batch should be written to the batchlog. Only valid for Client#batch(), it will be ignored by other methods. Default: true. [TODO: Add support for this field]
counter boolean <optional>

Determines if its a counter batch. Only valid for Client#batch(), it will be ignored by other methods. Default: false. [TODO: Add support for this field]
paged boolean <optional>

Determines if the query should be paged. Default: true.
pageState Buffer | string <optional>

Buffer or string token representing the paging state.

Useful for manual paging, if provided, the query will be executed starting from a given paging state. [TODO: Add support for this field]
prepare boolean <optional>

Determines if the query must be executed as a prepared statement.
readTimeout number <optional>

When defined, it overrides the default read timeout (socketOptions.readTimeout) in milliseconds for this execution per coordinator.

Suitable for statements for which the coordinator may allow a longer server-side timeout, for example aggregation queries.

A value of 0 disables client side read timeout for the execution. Default: undefined.

[TODO: Add support for this field]
retry RetryPolicy <optional>

Retry policy for the query.

This property can be used to specify a different retry policy to the one specified in the ClientOptions.policies. [TODO: Add support for this field]
routingIndexes Array<any> <optional>

Index of the parameters that are part of the partition key to determine the routing. [TODO: Add support for this field]
routingKey Buffer | Array<any> <optional>

Partition key(s) to determine which coordinator should be used for the query. [TODO: Add support for this field]
routingNames Array<any> <optional>

Array of the parameters names that are part of the partition key to determine the routing. Only valid for non-prepared requests, it's recommended that you use the prepare flag instead. [TODO: Add support for this field]
serialConsistency number <optional>

Serial consistency is the consistency level for the serial phase of conditional updates. This option will be ignored for anything else that a conditional update/insert. [TODO: Add support for this field]
timestamp number | Long <optional>

The default timestamp for the query in microseconds from the unix epoch (00:00:00, January 1st, 1970).

If provided, this will replace the server side assigned timestamp as default timestamp.

Use generateTimestamp() utility method to generate a valid timestamp based on a Date and microseconds parts.
traceQuery boolean <optional>

Enable query tracing for the execution. Use query tracing to diagnose performance problems related to query executions. Default: false.

To retrieve trace, you can call Metadata.getTrace() method.

Source

query-options.js, line 6