Interface CassandraClientArgs

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 CassandraClientArgs {
    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;
    keyspace?: 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

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

Properties

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

Optionalkeyspace

keyspace?: string

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