Interface CassandraLibArgs

Extends the DataStax driver's client options with additional configurations for service providers, enabling the customization of Cassandra client instances based on specific service requirements. This interface integrates native driver configurations with custom extensions, facilitating the connection to Cassandra databases, including managed services like Astra DB.

  • serviceProviderArgs: Optional. Contains the connection arguments for specific Cassandra service providers, such as Astra DB. This allows for detailed and service-specific client configurations, enhancing connectivity and functionality across different Cassandra environments.

Incorporating this interface into client creation processes ensures a comprehensive setup, encompassing both standard and extended options for robust and versatile Cassandra database interactions.

interface CassandraLibArgs {
    applicationName?: string;
    applicationVersion?: string;
    authProvider?: AuthProvider;
    batchSize?: number;
    cloud?: {
        secureConnectBundle: string | URL;
    };
    contactPoints?: string[];
    credentials?: {
        password: string;
        username: string;
    };
    dimensions: number;
    encoding?: {
        copyBuffer?: boolean;
        map?: Function;
        set?: Function;
        useBigIntAsLong?: boolean;
        useBigIntAsVarint?: boolean;
        useUndefinedAsUnset?: boolean;
    };
    graphOptions?: GraphOptions;
    id?: Uuid;
    indices?: Index[];
    isMetadataSyncEnabled?: boolean;
    keyspace: string;
    localDataCenter?: string;
    maxConcurrency?: number;
    maxPrepared?: number;
    maxRetries?: number;
    metadataColumns?: Column[];
    metrics?: ClientMetrics;
    monitorReporting?: {
        enabled?: boolean;
    };
    nonKeyColumns?: Column | Column[];
    onFailedAttempt?: FailedAttemptHandler;
    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;
    primaryKey: Column | Column[];
    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;
    table: string;
    vectorType?: SupportedVectorTypes;
    withClause?: string;
}

Hierarchy (view full)

Properties

applicationName? applicationVersion? authProvider? batchSize? cloud? contactPoints? credentials? dimensions encoding? graphOptions? id? indices? isMetadataSyncEnabled? keyspace localDataCenter? maxConcurrency? maxPrepared? maxRetries? metadataColumns? metrics? monitorReporting? nonKeyColumns? onFailedAttempt? policies? pooling? prepareOnAllHosts? primaryKey profiles? promiseFactory? protocolOptions? queryOptions? rePrepareOnUp? refreshSchemaDelay? requestTracker? serviceProviderArgs? socketOptions? sslOptions? table vectorType? withClause?

Properties

OptionalapplicationName

applicationName?: string

OptionalapplicationVersion

applicationVersion?: string

OptionalauthProvider

authProvider?: AuthProvider

OptionalbatchSize

batchSize?: number

Optionalcloud

cloud?: {
    secureConnectBundle: string | URL;
}

OptionalcontactPoints

contactPoints?: string[]

Optionalcredentials

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

dimensions

dimensions: number

Optionalencoding

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

OptionalgraphOptions

graphOptions?: GraphOptions

Optionalid

id?: Uuid

Optionalindices

indices?: Index[]

OptionalisMetadataSyncEnabled

isMetadataSyncEnabled?: boolean

keyspace

keyspace: string

OptionallocalDataCenter

localDataCenter?: string

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxPrepared

maxPrepared?: number

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

OptionalmetadataColumns

metadataColumns?: Column[]

Optionalmetrics

metrics?: ClientMetrics

OptionalmonitorReporting

monitorReporting?: {
    enabled?: boolean;
}

OptionalnonKeyColumns

nonKeyColumns?: Column | Column[]

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

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

primaryKey

primaryKey: Column | Column[]

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

table

table: string

OptionalvectorType

vectorType?: SupportedVectorTypes

OptionalwithClause

withClause?: string

Settings

Member Visibility

On This Page

Properties