interface BigtableEntityMapping
Since 0.2.0

How one entity name maps onto a physical Bigtable table.

Properties

readonly
optional
table: string

The table id. Defaults to the entity name itself.

readonly
optional
rowKey: BigtableRowKeyMapping

How the row key is composed. Defaults to { fields: ['id'] }.

readonly
optional
columnFamily: string

The column family unmapped fields are written to. Defaults to 'cf'.

readonly
optional
columns: Readonly<Record<string, string>>

Per-field column addresses. A value of 'family' keeps the field name as the qualifier; 'family:qualifier' names both.

How values round-trip through a cell. Defaults to 'tagged'.

Usage

import { type BigtableEntityMapping } from "database-plugin/src/index.ts";