Skip to main content

Tables

A table is a dataset defined by a Hamelin query that materializes its output to storage under a catalog name you choose. The name may be top-level or schema-qualified. The resource id is prefixed TBL_.

A table reads from a source and lands typed columns as a persisted dataset that the rest of the platform can query. Its output feeds views, unions, mappers, and detections downstream.

Variants​

A table comes in three variants, fixed at creation and determined by the query.

  • An ingest table parses raw connector events into structured fields. Its query reads only connectors.
  • A continuous table derives incrementally from other datasets, the same machinery a deployed detection uses to materialize its signals. Its query reads no connectors. Unlike a materialized view, a continuous table is not fully re-derived when its definition changes. See incremental queries for why.
  • A static table holds rows you upload directly, from a CSV or parsed lines.

Inputs​

FieldTypeRequiredDescription
namestringRequiredDataset name in schema.name format, e.g. events.okta, or a single identifier.
querystringRequiredThe Hamelin query that produces the table's rows. Output must contain no variant types.
tableTypeenumRequiredingest, continuous, or static. ingest parses connector events, and its query references only connectors. continuous derives incrementally from non-connector datasets. static holds uploaded rows. Resolved from the query. Default ingest.
deploybooleanRequiredWhether the table materializes. true runs the query and writes the dataset. false leaves it as saved content.
sourceFormatenumOptionalFormat of uploaded data for a static table: parsed_lines or csv. csv forces tableType to static. Default parsed_lines.
retentionDaysintegerOptionalDays to retain materialized rows. Null keeps the Space default.
keyColumnsarray<string>OptionalColumns forming the row key for a static table. At least one is required for a static table. Rejected for ingest and continuous. For CSV, keys are selected during the first upload.
partitioningColumnstringOptionalColumn the materialized dataset is partitioned by. Null for none.
sortedByColumnstringOptionalColumn the materialized dataset is sorted by. Null for none.
maxLatencyenumOptionalCeiling on how stale a continuous table's rows may be: MAX_1H (one hour) or MAX_1D (one day). Required for continuous tables. Null for other types.
startsAttimestampOptionalFor a continuous table, rows are only materialized for events at or after this time. Null for other types.
createCasebooleanOptionalWhether rows from this table open a case. Default false.
archivedbooleanOptionalWhether the table is archived. Archived tables do not materialize. Default false.

Outputs​

FieldTypeDescription
deploymentStatusenumMaterialization state: UNDEPLOYED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, DEPLOYED, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, FAILED, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
sortedByColumnsarray<string>Sort columns for a static table, mirrored from keyColumns. Empty for other types.
lastMaterializedAttimestampWhen the table last materialized. Null if it never has.
fromDatasetsarray<object>The source datasets the query reads, each with name, resourceName, resourceId, and spaceId.
connectorIdsarray<string>Connectors the ingest query references, in query order.
connectorIdstringPrimary connector when several exist. Retained for backward compatibility.
parserId / parserNamestringThe parser that owns this table, when derived from one.
integrationIdstringThe integration this table belongs to, when derived from one.
detectionIdstringThe detection that derives this table, when it is a detection's signal table.
lookupId / lookupNamestringThe lookup that owns this table, when derived from one.
schemaIdstringSchema resource ID this table's output conforms to. Null when unconstrained.
readOnlybooleantrue when the table cannot be edited in place, such as one owned by a detection, parser, or lookup.
isSystemCreatedbooleantrue when the platform created the table rather than a user.
statusDetailsobjectData-plane status detail for the materialized dataset, when present.

Plus the common resource fields.