couchbase
    Preparing search index...

    Interface ConnectOptions

    Specifies the options which can be specified when connecting to a cluster.

    interface ConnectOptions {
        appTelemetryConfig?: AppTelemetryConfig;
        authenticator?: Authenticator;
        configProfile?: string;
        dnsConfig?: DnsConfig;
        metricsConfig?: MetricsConfig;
        orphanReporterConfig?: OrphanReporterConfig;
        password?: string;
        preferredServerGroup?: string;
        security?: SecurityConfig;
        timeouts?: TimeoutConfig;
        tracingConfig?: TracingConfig;
        transactions?: TransactionsConfig;
        transcoder?: Transcoder;
        username?: string;
    }
    Index

    Properties

    appTelemetryConfig? authenticator? configProfile? dnsConfig? metricsConfig? orphanReporterConfig? password? preferredServerGroup? security? timeouts? tracingConfig? transactions? transcoder? username?

    Properties

    appTelemetryConfig?: AppTelemetryConfig

    Specifies the Application Telemetry config for connections of this cluster.

    authenticator?: Authenticator

    Specifies a specific authenticator to use when connecting to the cluster.

    configProfile?: string

    Applies the specified ConfigProfile options to the cluster.

    Volatile: This API is subject to change at any time.

    dnsConfig?: DnsConfig

    Specifies the DNS config for connections of this cluster.

    Volatile: This API is subject to change at any time.

    metricsConfig?: MetricsConfig

    Specifies the metrics config for connections of this cluster.

    orphanReporterConfig?: OrphanReporterConfig

    Specifies the orphan report logging config for connections of this cluster.

    password?: string

    Specifies a password to be used in concert with username for authentication.

    ConnectOptions.username

    preferredServerGroup?: string

    Specifies the preferred server group to use for replica operations that specify a non-default read preference.

    security?: SecurityConfig

    Specifies the security config for connections of this cluster.

    timeouts?: TimeoutConfig

    Specifies the default timeouts for various operations performed by the SDK.

    tracingConfig?: TracingConfig

    Specifies the tracing (threshold logging) config for connections of this cluster.

    transactions?: TransactionsConfig

    Specifies the options for transactions.

    transcoder?: Transcoder

    Specifies the default transcoder to use when encoding or decoding document values.

    username?: string

    Specifies a username to use for an implicitly created IPasswordAuthenticator used for authentication with the cluster.

    Settings

    Member Visibility

    On This Page

    Properties