prorm API Reference
    Preparing search index...

    Interface KeyspacesStoreOptions

    Connection options for KeyspacesStore. These map onto the cassandra-driver Client constructor options. For a real Keyspaces endpoint, TLS sslOptions and a SigV4/credentials authProvider are supplied through clientOptions.

    interface KeyspacesStoreOptions {
        contactPoints?: string[];
        localDataCenter?: string;
        keyspace?: string;
        credentials?: { username: string; password: string };
        clientOptions?: Record<string, unknown>;
        client?: KeyspacesClientLike;
    }
    Index
    contactPoints? localDataCenter? keyspace? credentials? clientOptions? client?
    contactPoints?: string[]

    Keyspaces service endpoint(s), e.g. ['cassandra.us-east-1.amazonaws.com:9142'] (note the TLS port 9142).

    localDataCenter?: string

    Local data center — typically the AWS region, e.g. 'us-east-1'.

    keyspace?: string

    Default keyspace to bind the session to.

    credentials?: { username: string; password: string }

    Service-specific username/password credentials (or use a SigV4 authProvider via clientOptions).

    clientOptions?: Record<string, unknown>

    Escape hatch for any other cassandra-driver Client option. For Keyspaces this is where TLS (sslOptions) and the SigV4 authProvider live. Merged into the options passed to the Client constructor.

    client?: KeyspacesClientLike

    A pre-built driver Client (or a compatible mock). When provided, connect() uses it directly and skips require('cassandra-driver') entirely — this is how tests inject a mock without the real driver installed.

    Settings
    Member Visibility

    On This Page
    Properties