prorm API Reference
    Preparing search index...

    Class HBaseStore

    HBaseStore wraps an hbase REST-gateway client and exposes HBase's row/cell surface: put/get/deleteRow for single-row operations, scan for range reads over the sorted key space, and createTable for defining a table's column families. Column cells are addressed as 'family:qualifier'.

    Implements

    Index
    name: "hbase" = 'hbase'

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

    library: "hbase" = 'hbase'

    The client library being used

    • The hbase REST client is stateless (each call is an HTTP request), so there is no socket to tear down; disconnect() simply drops the reference and flips connected to false.

      Returns Promise<void>

    • Writes (puts) one or more cells into a single row. data maps 'family:qualifier' column keys to values, e.g. { 'cf:name': 'alice', 'cf:age': 30 }. Passed to the driver as parallel columns/values arrays via table(table).row(row).put(...).

      Parameters

      • table: string
      • row: string
      • data: HBaseRowData

      Returns Promise<unknown>

    • Reads a single row by key via table(table).row(row).get(...), returning the row's cells as the driver surfaces them (an array of { column, timestamp, $ } cell descriptors for the hbase REST client).

      Parameters

      • table: string
      • row: string

      Returns Promise<unknown>

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

      Parameters

      • table: string
      • row: string

      Returns Promise<unknown>

    • Range-scans a table via table(table).scan(options, ...), returning the matching rows. Since HBase keeps row keys sorted, startRow/endRow define an efficient contiguous range; columns restricts which families/ qualifiers are read. Returns the rows as the driver surfaces them.

      Parameters

      • table: string
      • opts: HBaseScanOptions = {}

      Returns Promise<unknown>

    • Creates a table with the given column families via table(table).create(...). families is the list of column family names (e.g. ['cf', 'meta']); each is sent to the driver as an HBase ColumnSchema entry. 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>