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
Ask AI
ScyllaDB Docs ScyllaDB Node.js Driver ScyllaDB Node.js-RS Driver

ScyllaDB Node.js-RS Driver¶

A client-side driver for ScyllaDB written in Node.js and Rust. This driver is an overlay over the ScyllaDB Rust Driver, with the interface based on the DataStax Node.js Driver. Although optimized for ScyllaDB, the driver is also compatible with Apache Cassandra®.

Caution

This driver is currently in the experimental state. We are working on features necessary for the driver to be considered production ready.

Getting Started¶

Installation¶

npm install scylladb-driver-alpha

Currently only Linux x86_64 architecture is supported, with planned support for other architectures in the future.

Examples¶

You can find example usages of the driver in the examples directory.

Features¶

The driver supports the following:

  • Simple, Prepared, and Batch statements

  • Asynchronous IO, parallel execution, request pipelining

  • Token-aware routing

  • Shard-aware and Tablet-aware routing (specific to ScyllaDB)

  • CQL binary protocol version 4

  • Works with any cluster size

  • Both promise and callback-based API

  • Row streaming and pipes

  • Built-in TypeScript support

  • Password authentication

Roadmap¶

Features planned for the driver to become production ready:

  • Configurable load balancing and retry policies

  • Faster performance, compared to DataStax Node.js driver

  • SSL support

  • Error handling, based on the Rust driver

  • Migration guide from the DataStax driver

For other planned features, see the Milestones.

Reference¶

  • API Reference

  • CQL binary protocol specification version 4

Was this page helpful?

NEXT
API Reference
  • Create an issue
  • Edit this page

On this page

  • ScyllaDB Node.js-RS Driver
    • Getting Started
      • Installation
      • Examples
    • Features
      • Roadmap
    • Reference
ScyllaDB Node.js Driver
  • main
    • main
  • API Reference
    • Modules
      • auth
        • AuthProvider
        • Authenticator
        • PlainTextAuthProvider
      • concurrent
      • datastax
      • errors
        • ArgumentError
        • AuthenticationError
        • BusyConnectionError
        • DriverInternalError
        • NoHostAvailableError
        • NotSupportedError
        • OperationTimedOutError
        • ResponseError
      • geometry
      • mapping
        • DefaultTableMappings
        • Mapper
        • ModelBatchItem
        • ModelMapper
        • Result
        • UnderscoreCqlToCamelCaseMappings
        • TableMappings
      • metadata
        • Aggregate
        • ClientState
        • DataCollection
        • Index
        • MaterializedView
        • Metadata
        • SchemaFunction
        • TableMetadata
      • metrics
        • DefaultMetrics
        • ClientMetrics
      • policies
        • addressResolution
          • AddressTranslator
          • EC2MultiRegionTranslator
          • MappingAddressTranslator
        • loadBalancing
          • AllowListPolicy
          • DCAwareRoundRobinPolicy
          • DefaultLoadBalancingPolicy
          • LegacyDefaultLoadBalancingPolicy
          • LoadBalancingConfig
          • LoadBalancingPolicy
          • RoundRobinPolicy
          • TokenAwarePolicy
        • reconnection
          • ConstantReconnectionPolicy
          • ExponentialReconnectionPolicy
          • ReconnectionPolicy
        • retry
          • FallthroughRetryPolicy
          • RetryPolicy
        • speculativeExecution
          • ConstantSpeculativeExecutionPolicy
          • NoSpeculativeExecutionPolicy
          • SpeculativeExecutionPolicy
        • timestampGeneration
          • MonotonicTimestampGenerator
          • TimestampGenerator
      • tracker
        • RequestLogger
        • RequestTracker
      • types
        • BigDecimal
        • Duration
        • InetAddress
        • Integer
        • LocalDate
        • Long
        • ResultSet
        • ResultStream
        • Row
        • TimeUuid
        • Tuple
        • Uuid
        • Vector
    • Classes
      • AddressResolver
      • ByteOrderedToken
      • Client
      • Encoder
      • ExecutionOptions
      • ExecutionProfile
      • FrameReader
      • HashSet
      • Host
      • HostMap
      • LineString
      • Murmur3Token
      • Point
      • Polygon
      • RandomToken
      • SslOptions
      • Token
      • TokenRange
    • 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 19 Mar 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.1
Ask AI