Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Node.js Driver. Switch to the latest stable version.
Global Functions and Constants¶
Members¶
(constant) Integer
Source
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
(constant) coreConnectionsPerHostV2
Core connections per host for protocol versions 1 and 2
(constant) coreConnectionsPerHostV3
Core connections per host for protocol version 3 and above
(constant) emptyArray
Source
(constant) emptyObject
Source
(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
(constant) maxInt :number
Max int that can be accurately represented with 64-bit Number (2^53)
Type:
- number
Source
(constant) maxRequestsPerConnectionV2
Default maxRequestsPerConnection value for protocol v1 and v2
(constant) maxRequestsPerConnectionV3
Default maxRequestsPerConnection value for protocol v3+
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
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
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
arrayIterator(arr) → {Iterator}
Uses the iterator protocol to go through the items of the Array
Parameters:
| Name | Type | Description |
|---|---|---|
arr |
Array<any> |
Source
Returns:
- Type
- Iterator
asDouble()
Deprecated
Not supported by the driver. Usage will throw an error.
asFloat()
Deprecated
Not supported by the driver. Usage will throw an error.
asInt()
Deprecated
Not supported by the driver. Usage will throw an error.
asTimestamp()
Deprecated
Not supported by the driver. Usage will throw an error.
asUdt()
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
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
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
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
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' |
Returns:
- Type
- rust.TlsVersion
copyBuffer()
Creates a copy of a buffer
Source
deepExtend(target) → {Object}
Extends the target by the most inner props of sources
Parameters:
| Name | Type | Description |
|---|---|---|
target |
Object |
Source
Returns:
- Type
- Object
defaultOptions() → {ClientOptions}
Returns:
- Type
- ClientOptions
defaultPromiseFactory(handler) → {Promise}
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function |
Source
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
Returns:
- Type
- Promise<void>
each(arr, fn, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<any> | ||
fn |
function | ||
callback |
function |
<optional> |
Source
eachSeries(arr, fn, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<any> | ||
fn |
function | ||
callback |
function |
<optional> |
Source
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 |
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
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
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 |
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
fixStack()
Appends the original stack trace to the error after a tick of the event loop
Source
forEachOf(arr, fn, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<any> | ||
fn |
function | ||
callback |
function |
<optional> |
Source
fromCallback(fn) → {Promise}
Creates a Promise from a callback based function.
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
function |
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 |
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 |
Returns:
- Type
- function
getColumnsMetadata(result) → {Array<{name, type}>}
Parameters:
| Name | Type | Description |
|---|---|---|
result |
rust.QueryResultWrapper |
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 |
Returns:
Returns array of rows if the result is is of the RowsResult kind, and undefined otherwise
- Type
- Array<_Row> | undefined
ifUndefined()
Returns the first not undefined param
Source
ifUndefined3()
Returns the first not undefined param
Source
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
isNamedParameters()
Returns true when params is a named (object) parameter set rather than an array.
Source
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
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
map(arr, fn, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<any> | ||
fn |
function | ||
callback |
function |
<optional> |
Source
mapSeries(arr, fn, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<any> | ||
fn |
function | ||
callback |
function |
<optional> |
Source
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 |
executionOptions |
ExecutionOptions | null | The information related to the execution of the request. |
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 |
Returns:
- Type
- string
normalizePagingState()
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.
Source
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 |
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
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> |
Returns:
- Type
- Promise | undefined
parallel(arr, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
arr |
Array<function()> | ||
callback |
function |
<optional> |
Source
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
Returns:
- Type
- Promise | undefined
(package) queryOptionsIntoWrapper(options) → {rust.QueryOptionsWrapper}
Parses js query options into rust query options wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
options |
_execOptions.ExecutionOptions |
Returns:
- Type
- rust.QueryOptionsWrapper
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
setMetadataDependent(client)
Sets the default options that depend on the protocol version and other metadata.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
Client |
stringRepeat(val, times) → {String}
Returns a string with a value repeated n times
Parameters:
| Name | Type | Description |
|---|---|---|
val |
String | |
times |
Number |
Source
Returns:
- Type
- String
throwNotSupported(name)
Internal utility for marking not supported endpoints.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
Source
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 |
Returns:
- Type
- Promise
times(count, iteratorFunc, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
count |
Number | ||
iteratorFunc |
function | ||
callback |
function |
<optional> |
Source
timesLimit(count, limit, iteratorFunc, callbackopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
count |
Number | ||
limit |
Number | ||
iteratorFunc |
function | ||
callback |
function |
<optional> |
Source
timesSeries(count, iteratorFunction, callback)
Parameters:
| Name | Type | Description |
|---|---|---|
count |
Number | |
iteratorFunction |
function | |
callback |
function |
Source
toBackground(promise) → {undefined}
Deals with unexpected rejections in order to avoid the unhandled promise rejection warning or failure.
Parameters:
| Name | Type | Description |
|---|---|---|
promise |
Promise |
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> |
Returns:
- Type
- undefined
toLowerCaseProperties()
Returns a new object with the property names set to lowercase.
Source
totalLength()
Gets the sum of the length of the items of an array
Source
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
Returns:
- Type
- function
whilst(condition, fn, callback)
Parameters:
| Name | Type | Description |
|---|---|---|
condition |
function | |
fn |
function | |
callback |
function |
Source
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:
- Object
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 Properties
|
||||||||||||||||||||||||||||||||
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] |
||||||||||||||||||||||||||||||||
isMetadataSyncEnabled |
Boolean |
<optional> |
Determines whether client-side schema metadata retrieval and update is enabled. Setting this value to Default: |
||||||||||||||||||||||||||||||||
prepareOnAllHosts |
Boolean |
<optional> |
Determines if the driver should prepare queries on all hosts in the cluster.
Default: |
||||||||||||||||||||||||||||||||
rePrepareOnUp |
Boolean |
<optional> |
Determines if the driver should re-prepare all cached prepared queries on a
host when it marks it back up.
Default: |
||||||||||||||||||||||||||||||||
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: |
||||||||||||||||||||||||||||||||
policies |
Object |
<optional> |
Properties
|
||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||
protocolOptions |
Object |
<optional> |
[TODO: Add support for this field] Properties
|
||||||||||||||||||||||||||||||||
socketOptions |
Object |
<optional> |
[TODO: Add support for this field] Properties
|
||||||||||||||||||||||||||||||||
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 It uses the same default values as Node.js |
||||||||||||||||||||||||||||||||
encoding |
Object |
<optional> |
Encoding options. [TODO: Add support for this field] Properties
|
||||||||||||||||||||||||||||||||
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. When set to a value other than When not set, events at |
||||||||||||||||||||||||||||||||
profiles |
Array<ExecutionProfile> |
<optional> |
The array of execution profiles. |
||||||||||||||||||||||||||||||||
promiseFactory |
function |
<optional> |
Function to be used to create a Promise libraries often provide different methods to create a promise. For example, you can use Bluebird's
By default, the driver will use the Promise constructor. [TODO: Add support for this field] |
QueryOptions
Query options
Type:
- Object
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 Default: false. [TODO: Add support for this field] |
consistency |
number |
<optional> |
Defaults to [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:
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: [TODO: Add support for this field] |
keyspace |
string |
<optional> |
Specifies the keyspace for the query. It is used for the following:
[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
( Suitable for statements for which the coordinator may allow a longer server-side timeout, for example aggregation queries. A value of [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