Global Functions and Constants¶

The buffer size of a new FrameWriter.

Largest value count that the [short] count of a frame can hold.

A FrameWriter keeps its buffer between frames up to this size. After a larger frame, it starts again with a small buffer.

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

Highest value of the ring, and its inclusive end.

The token the ring starts at, exclusively, and ends at, inclusively: the range ]minToken, minToken] covers the whole ring.

Lowest value of the ring: not a valid token, but the exclusive start of the ring.

Number of values the ring spans, used to wrap around its end.

Core connections per host for protocol versions 1 and 2

Core connections per host for protocol version 3 and above

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

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

Default maxRequestsPerConnection value for protocol v1 and v2

Default maxRequestsPerConnection value for protocol v3+

Splits the range ]start, end] into numberOfSplits parts of equal "size" (referring to the number of tokens, not the actual amount of data), returning the tokens the parts are split at.

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.

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

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

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

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.

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

Convert rust ComplexType into type representation used in the driver encoder

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";

Creates a copy of a buffer

Extends the target by the most inner props of sources

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

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

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

Extends and validates the user options

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.

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

Creates a Promise from a callback based function.

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

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

Simple way of getting results from rust driver. Calls the driver, decoding the whole page at once.

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

Returns the first not undefined param

Returns the first not undefined param

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

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

Convert the iterator values into an array

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

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

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

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

Page state can come from two sources:

• pageState variable: when we execute the following page of the query
• execOptions: when the user start a new query from requested state

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

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.

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.

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.

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

Rejects legacy timeout settings that would otherwise be silently ignored. Only socketOptions.readTimeout may retain its built-in 12000 ms default; query and execution-profile settings have no such default.

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

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

Returns the string representation of a given socket address.

Returns a string with a value repeated n times

Internal utility for marking not supported endpoints.

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

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

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

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

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

Validates the provided parameter is of type function.

Validates a request timeout before it crosses the N-API boundary as an i32. undefined means that the caller should use the next value in the option precedence chain.