Skip to content

tables/<name>.yaml ​

One file for each table. The name of the file is the name of the table. See tables for the modes, the types and the encodings.

A table file.

keytypedefaultdescription
columnsmap of ColumnSpecrequiredThe columns, in order.
event_timestringA temporal column that orders rows in time; drives retention and time pruning.
modeTableModeappend
namestringrequiredThe table's name. Must match the file name (tables/<name>.yaml).
primary_keylist of stringThe key of an upsert table.
renamed_fromstringThe table's previous name, to make a rename keep its data.
retentionDurationHow long rows are kept, measured on event_time.

ColumnSpec ​

One column.

keytypedefaultdescription
encodingEncodingOverrides the default encoding for the column's type.
filledFilledFilled in by the server on every write, never sent: credential (a string column: the name of the credential that wrote the row) or received (a timestamp column: when the server received it).
nullablebooleanWhether the column may hold NULL. Columns are required by default.
renamed_fromstringThe column's previous name, to make a rename keep its data. Removed again once the rename is applied.
typeColumnTyperequired

TableMode ​

How rows arrive in a table (plan D6).

valuedescription
appendRows are only ever added. The cheapest mode, and the default: facts.
upsertRows are keyed by primary_key; a row with an existing key replaces the old one. Dimensions.

Duration ​

A duration with a unit: ms, s, m, h or d (e.g. 200ms, 730d).

Type: string.

Encoding ​

How a column is stored.

valuedescription
dictDictionary-encoded: every distinct value gets a small integer code. Cheap to filter and group by. The default for string, bool and date.
plainStored as values. The default for numbers and timestamps, and the right choice for high-cardinality ids nobody filters by.

Filled ​

What the server fills a column with (plan §9.2).

valuedescription
credentialThe name of the ingest credential the row was written with.
receivedWhen the server received the row.

ColumnType ​

A column type: bool, int32, int64, float64, decimal(p,s), string, date, timestamp or timestamptz.

Type: string.

reference generated from the schemas, the endpoint table and the MCP tools: just docs