ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Deployments
    • Cloud
    • Server
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
    • Supported Driver Versions
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Install
Search Ask AI
ScyllaDB Docs ScyllaDB Node.js Driver API Reference Modules types
For AI agents: a documentation index is available at https://nodejs-rs-driver.docs.scylladb.com/v0.7.1/llms.txt. A Markdown version of this page is at https://nodejs-rs-driver.docs.scylladb.com/v0.7.1/api/types/index.md.

types¶

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Classes¶

BigDecimal
Duration
InetAddress
Integer
LocalDate
LocalTime
ResultStream
Row
TimeUuid
Tuple
Uuid

Members¶

(inner) LocalTime

Gets the hour component of the time represented by the current instance, a number from 0 to 23.

Source

types/local-time.ts, line 51

(inner) LocalTime

Gets the minute component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 55

(inner) LocalTime

Gets the second component of the time represented by the current instance, a number from 0 to 59.

Source

types/local-time.ts, line 59

(inner) LocalTime

Gets the nanoseconds component of the time represented by the current instance, a number from 0 to 999999999.

Source

types/local-time.ts, line 63

(inner, constant) Long

Long constructor, wrapper of the internal library used: Long.js.

Source

types/index.ts, line 14

(inner) consistencies

Consistency levels

Source

types/index.ts, line 27

(inner, constant) consistencyToString

Mapping of consistency level codes to their string representation.

Source

types/index.ts, line 80

(inner) dataTypes

CQL data types

Source

types/index.ts, line 122

(inner, constant) dateCenter

2^31 days before unix epoch is -5877641-06-23. This is the first day that can be represented by this class.

Source

types/local-date.ts, line 9

(inner) distance

Represents the distance of Cassandra node as assigned by a LoadBalancingPolicy relatively to the driver instance.

Source

types/index.ts, line 269

(inner) logLevels

Log level values used for the logLevel client option and emitted in 'log' events.

Source

types/index.ts, line 281

(inner, constant) longAny

The long library is not augmentable through declare module, and its own typings naturally don't know about the statics and prototype methods the driver installs on it below, so they are attached through an untyped view of it. They were not part of the hand-written declarations either.

Source

types/index.ts, line 22

(inner) protocolVersion

Contains information for the different protocol versions supported by the driver.

Strict equality operators to compare versions are allowed, other comparison operators are discouraged. Instead, use a function that checks if a functionality is present on a certain version, for maintainability purposes.

Source

types/protocol-version.ts, line 21

(inner) responseErrorCodes

Server error codes returned by Cassandra

Source

types/index.ts, line 299

(inner, constant) unset

Unset representation.

Use this field if you want to set a parameter to unset. Valid for Cassandra 2.2 and above.

Source

types/index.ts, line 352

Methods¶

(inner) generateTimestamp(date, microseconds)

Generates a value representing the timestamp for the query in microseconds based on the date and the microseconds provided

Parameters:

Name Type Description
date

The date to generate the value, if not provided it will use the current date.

microseconds

A number from 0 to 999 used to build the microseconds part of the date.

Source

types/index.ts, line 547

(inner) splitTypeArgs(args)

Splits the comma separated arguments of a parameterized type name, ignoring the commas that belong to the arguments themselves.

Parameters:

Name Type Description
args

Everything between the outermost angle brackets.

Source

types/index.ts, line 100

Returns:

The arguments, trimmed.

Was this page helpful?

PREVIOUS
RequestTracker
NEXT
BigDecimal
  • Create an issue
  • Edit this page

On this page

  • types
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
    • Classes
    • Members
    • Methods
ScyllaDB Node.js Driver
Search Ask AI
  • v0.7.1
    • main
    • v0.7.1
    • v0.6.1
  • Getting Started
  • Statements
    • Executing CQL Statements - Best Practices
    • Unprepared Statements
    • Batch Statements
    • Parameterized queries
  • Fetching Large Result Sets
  • Schema Metadata
  • Topology
  • Replicas
  • Query Tracing
  • Logging
  • Policies
    • Load Balancing
    • Retry Policies
  • Authentication
  • Client Routes (Private Networking)
  • Shutdown
  • Migration Guide
  • API Reference
    • Modules
      • auth
        • AuthProvider
        • Authenticator
        • PlainTextAuthProvider
      • datastax
        • graph
        • search
      • errors
        • ArgumentError
        • AuthenticationError
        • BusyConnectionError
        • DriverInternalError
        • NoHostAvailableError
        • NotSupportedError
        • OperationTimedOutError
        • ResponseError
      • geometry
      • mapping
        • DefaultTableMappings
        • Mapper
        • ModelBatchItem
        • ModelMapper
        • Result
        • UnderscoreCqlToCamelCaseMappings
        • TableMappings
      • metrics
        • DefaultMetrics
        • ClientMetrics
      • policies
        • addressResolution
          • AddressTranslator
          • EC2MultiRegionTranslator
          • MappingAddressTranslator
        • loadBalancing
          • AllowListPolicy
          • DCAwareRoundRobinPolicy
          • DefaultLoadBalancingPolicy
          • LegacyDefaultLoadBalancingPolicy
          • LoadBalancingConfig
          • LoadBalancingPolicy
          • RoundRobinPolicy
          • TokenAwarePolicy
        • reconnection
          • ConstantReconnectionPolicy
          • ExponentialReconnectionPolicy
          • ReconnectionPolicy
        • retry
          • FallthroughRetryPolicy
          • RetryPolicy
        • timestampGeneration
          • MonotonicTimestampGenerator
          • TimestampGenerator
      • tracker
        • RequestLogger
        • RequestTracker
      • types
        • BigDecimal
        • Duration
        • InetAddress
        • Integer
        • LocalDate
        • ResultStream
        • Row
        • TimeUuid
        • Tuple
        • Uuid
    • Classes
      • Client
      • ColumnInfo
      • ConstantSpeculativeExecutionPolicy
      • DateRange
      • DateRangeBound
      • DseGssapiAuthProvider
      • DsePlainTextAuthProvider
      • Edge
      • Element
      • Encoder
      • EncoderMembers
      • ExecutionOptions
      • ExecutionProfile
      • FrameReader
      • FrameWriter
      • GraphResultSet
      • HashSet
      • LineString
      • NoSpeculativeExecutionPolicy
      • Path
      • Point
      • Polygon
      • PreparedInfo
      • Property
      • ResultColumnsCache
      • ResultSet
      • RustResult
      • RustSession
      • SpeculativeExecutionPolicy
      • SslOptions
      • Token
      • TokenRange
      • Vertex
      • VertexProperty
      • module-metadata-LocalStrategy
    • Interfaces
    • Events
    • Global Functions and Constants
Docs Tutorials University Contact Us About Us
© 2026 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 23 Oct 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.3