prorm API Reference
    Preparing search index...

    Interface BigtableStoreOptions

    Connection options for BigtableStore. projectId, instanceId, and tableId locate the resource; the latter two are configurable defaults — every row method also accepts an explicit table name to target a different table within the same instance.

    interface BigtableStoreOptions {
        projectId?: string;
        instanceId?: string;
        tableId?: string;
        clientOptions?: Record<string, unknown>;
        client?: BigtableClientLike;
    }
    Index
    projectId? instanceId? tableId? clientOptions? client?
    projectId?: string

    GCP project id that owns the Bigtable instance.

    instanceId?: string

    Bigtable instance id, used as the default for all table operations.

    tableId?: string

    Default table id, used when a method's table argument is omitted.

    clientOptions?: Record<string, unknown>

    Escape hatch for any other Bigtable constructor option (keyFilename, credentials, apiEndpoint for the emulator, ...). Merged into the options passed to new Bigtable(...).

    client?: BigtableClientLike

    A pre-built Bigtable client (or a compatible mock). When provided, connect() uses it directly and skips require('@google-cloud/bigtable') entirely — this is how tests inject a mock without the real driver installed.

    Settings
    Member Visibility

    On This Page
    Properties