prorm API Reference
    Preparing search index...

    Interface CouchbaseStoreOptions

    Connection options for CouchbaseStore.

    connectionString is the standard couchbase:// / couchbases:// endpoint; username/password authenticate against the cluster. The default bucket/scope/collection select which collection the key/value CRUD methods operate on when no explicit target is passed. When a pre-built cluster is supplied (e.g. in tests), connect() uses it directly and skips loading the couchbase driver.

    interface CouchbaseStoreOptions {
        connectionString?: string;
        username?: string;
        password?: string;
        bucket?: string;
        scope?: string;
        collection?: string;
        cluster?: any;
    }
    Index
    connectionString? username? password? bucket? scope? collection? cluster?
    connectionString?: string

    Couchbase connection string, e.g. couchbase://localhost.

    username?: string

    Username for cluster authentication.

    password?: string

    Password for cluster authentication.

    bucket?: string

    Default bucket for key/value operations (default: default).

    scope?: string

    Default scope within the bucket (default: _default).

    collection?: string

    Default collection within the scope (default: _default).

    cluster?: any

    A pre-built cluster to use instead of connecting via the driver.

    Settings
    Member Visibility

    On This Page
    Properties