prorm API Reference
    Preparing search index...

    Class BigtableStore

    BigtableStore wraps a @google-cloud/bigtable client and exposes Bigtable's row surface: insertRow/getRow/deleteRow for single-row operations, readRows for range/filter scans, and createTable for defining a table's column families. Instance and table ids are resolved once and the resulting handles cached per table id.

    Implements

    Index
    name: "bigtable" = 'bigtable'

    The name of the store (e.g. 'mongodb', 'redis', 'dynamodb')

    library: "@google-cloud/bigtable" = '@google-cloud/bigtable'

    The client library being used

    • The Bigtable client manages its own gRPC channel pool and does not expose a public close on the surface this store depends on, so disconnect() drops the cached handles and flips connected to false.

      Returns Promise<void>

    • Inserts (writes) a single row via table.insert(...). data maps column families to { qualifier: value } maps, e.g. { cf: { name: 'alice', age: 30 } }. Passed to the driver as a single { key, data } insert entry.

      Parameters

      • table: string
      • key: string
      • data: BigtableRowData

      Returns Promise<unknown>

    • Reads a single row by key via table.row(key).get(), returning the row data.

      Parameters

      • table: string
      • key: string

      Returns Promise<unknown>

    • Deletes an entire row (all its cells) via table.row(key).delete().

      Parameters

      • table: string
      • key: string

      Returns Promise<unknown>

    • Reads multiple rows via table.getRows(options). options (ranges, keys, prefix, limit, filter) is forwarded straight to the client. Since Bigtable keeps row keys sorted, a ranges/prefix scan reads an efficient contiguous slice of the key space. Returns the rows as the driver surfaces them.

      Parameters

      • table: string
      • opts: BigtableReadOptions = {}

      Returns Promise<unknown>

    • Creates a table with the given column families via table.create(...). families is the list of column family names (e.g. ['cf', 'meta']), passed to the client as its families create option. A table must declare its families up front — unlike qualifiers, families cannot be added implicitly at write time.

      Parameters

      • table: string
      • families: string[]

      Returns Promise<unknown>