Interface CassandraKVOptions

Configuration options for initializing a CassandraKVStore. These options extend generic Cassandra client arguments with specific settings for key-value store operations.

CassandraKVOptions

interface CassandraKVOptions {
    keyspace: string;
    table: string;
    applicationName?: string;
    applicationVersion?: string;
    authProvider?: AuthProvider;
    cloud?: {
        secureConnectBundle: string | URL;
    };
    contactPoints?: string[];
    credentials?: {
        password: string;
        username: string;
    };
    encoding?: {
        copyBuffer?: boolean;
        map?: Function;
        set?: Function;
        useBigIntAsLong?: boolean;
        useBigIntAsVarint?: boolean;
        useUndefinedAsUnset?: boolean;
    };
    graphOptions?: GraphOptions;
    id?: Uuid;
    isMetadataSyncEnabled?: boolean;
    keyDelimiter?: string;
    localDataCenter?: string;
    maxPrepared?: number;
    metrics?: ClientMetrics;
    monitorReporting?: {
        enabled?: boolean;
    };
    policies?: {
        addressResolution?: AddressTranslator;
        loadBalancing?: LoadBalancingPolicy;
        reconnection?: ReconnectionPolicy;
        retry?: RetryPolicy;
        speculativeExecution?: SpeculativeExecutionPolicy;
        timestampGeneration?: TimestampGenerator;
    };
    pooling?: {
        coreConnectionsPerHost?: {
            [key: number]: number;
        };
        heartBeatInterval?: number;
        maxRequestsPerConnection?: number;
        warmup?: boolean;
    };
    prepareOnAllHosts?: boolean;
    profiles?: ExecutionProfile[];
    promiseFactory?: ((handler: ((callback: ((err: Error, result?: any) => void)) => void)) => Promise<any>);
    protocolOptions?: {
        maxSchemaAgreementWaitSeconds?: number;
        maxVersion?: number;
        noCompact?: boolean;
        port?: number;
    };
    queryOptions?: QueryOptions;
    rePrepareOnUp?: boolean;
    refreshSchemaDelay?: number;
    requestTracker?: RequestTracker;
    serviceProviderArgs?: CassandraServiceProviderArgs;
    socketOptions?: {
        coalescingThreshold?: number;
        connectTimeout?: number;
        defunctReadTimeoutThreshold?: number;
        keepAlive?: boolean;
        keepAliveDelay?: number;
        readTimeout?: number;
        tcpNoDelay?: boolean;
    };
    sslOptions?: ConnectionOptions;
}

Hierarchy (view full)

Properties

keyspace table applicationName? applicationVersion? authProvider? cloud? contactPoints? credentials? encoding? graphOptions? id? isMetadataSyncEnabled? keyDelimiter? localDataCenter? maxPrepared? metrics? monitorReporting? policies? pooling? prepareOnAllHosts? profiles? promiseFactory? protocolOptions? queryOptions? rePrepareOnUp? refreshSchemaDelay? requestTracker? serviceProviderArgs? socketOptions? sslOptions?

Properties

keyspace

keyspace: string

The name of the Cassandra keyspace to be used by the key-value store. The keyspace must exist.

table

table: string

The name of the table within the specified keyspace dedicated to storing key-value pairs. The table will be created if it does not exist.

OptionalapplicationName

applicationName?: string

OptionalapplicationVersion

applicationVersion?: string

OptionalauthProvider

authProvider?: AuthProvider

Optionalcloud

cloud?: {
    secureConnectBundle: string | URL;
}

OptionalcontactPoints

contactPoints?: string[]

Optionalcredentials

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

Optionalencoding

encoding?: {
    copyBuffer?: boolean;
    map?: Function;
    set?: Function;
    useBigIntAsLong?: boolean;
    useBigIntAsVarint?: boolean;
    useUndefinedAsUnset?: boolean;
}

OptionalgraphOptions

graphOptions?: GraphOptions

Optionalid

id?: Uuid

OptionalisMetadataSyncEnabled

isMetadataSyncEnabled?: boolean

OptionalkeyDelimiter

keyDelimiter?: string

An optional delimiter used to structure complex keys. Defaults to '/'. This delimiter is used for parsing complex keys (e.g., hierarchical keys) when performing operations that involve key prefixes or segmentation.

OptionallocalDataCenter

localDataCenter?: string

OptionalmaxPrepared

maxPrepared?: number

Optionalmetrics

metrics?: ClientMetrics

OptionalmonitorReporting

monitorReporting?: {
    enabled?: boolean;
}

Optionalpolicies

policies?: {
    addressResolution?: AddressTranslator;
    loadBalancing?: LoadBalancingPolicy;
    reconnection?: ReconnectionPolicy;
    retry?: RetryPolicy;
    speculativeExecution?: SpeculativeExecutionPolicy;
    timestampGeneration?: TimestampGenerator;
}

Optionalpooling

pooling?: {
    coreConnectionsPerHost?: {
        [key: number]: number;
    };
    heartBeatInterval?: number;
    maxRequestsPerConnection?: number;
    warmup?: boolean;
}

OptionalprepareOnAllHosts

prepareOnAllHosts?: boolean

Optionalprofiles

profiles?: ExecutionProfile[]

OptionalpromiseFactory

promiseFactory?: ((handler: ((callback: ((err: Error, result?: any) => void)) => void)) => Promise<any>)

OptionalprotocolOptions

protocolOptions?: {
    maxSchemaAgreementWaitSeconds?: number;
    maxVersion?: number;
    noCompact?: boolean;
    port?: number;
}

OptionalqueryOptions

queryOptions?: QueryOptions

OptionalrePrepareOnUp

rePrepareOnUp?: boolean

OptionalrefreshSchemaDelay

refreshSchemaDelay?: number

OptionalrequestTracker

requestTracker?: RequestTracker

OptionalserviceProviderArgs

serviceProviderArgs?: CassandraServiceProviderArgs

OptionalsocketOptions

socketOptions?: {
    coalescingThreshold?: number;
    connectTimeout?: number;
    defunctReadTimeoutThreshold?: number;
    keepAlive?: boolean;
    keepAliveDelay?: number;
    readTimeout?: number;
    tcpNoDelay?: boolean;
}

OptionalsslOptions

sslOptions?: ConnectionOptions

Settings

Member Visibility

On This Page

Properties