Create an Enrichment

Add a derived value, such as an is_left flag, to every row of frames without copying the Table or changing its schema. You define the Enrichment once as an expression over one row; creation stores only that definition, and a refresh computes the values.

Before you startCopy Anchor Link

• A Table in the Project, for example frames with a camera column.
• Permission to create Resources in the Project.
• A client for Python or Rust.
• A Worker for the refresh Tasks.

Create the EnrichmentCopy Anchor Link

Create the Enrichment in a commit on the branch that holds the Table. The Enrichment is named under the Table, so is_left below becomes frames/is_left.

main = client.project("demo").branch("main")
frames = main.table("frames")
commit = main.commit()
commit.create_enrichment(frames, "is_left", eq(column("camera"), literal("left")))
commit.publish()

Creation checks the expression against the Table's schema and records the type of its value. It evaluates no rows: every row reads NULL until the first refresh.

Refresh the EnrichmentCopy Anchor Link

A refresh computes the values against the Table version at the commit it starts from. It runs as Tasks on Workers and publishes all the values in one commit, so readers see either the old values or the new ones. The first refresh computes every row; later ones compute only the rows whose inputs changed.

main = client.project("demo").branch("main")
task = main.enrichment("frames/is_left").refresh()
if task is None:
    print("a refresh of this Enrichment is already waiting")
else:
    print(f"published {len(task.wait().versions)} versions")

Refresh after writes to the Table, and after Table maintenance: maintenance moves rows, and the refresh copies their values into place without evaluating the expression again.

Verify the resultCopy Anchor Link

The refresh's result lists the Enrichment version it published. To check which Table version that version covers, see Inspect an Enrichment.

TroubleshootingCopy Anchor Link

AvailabilityCopy Anchor Link

Create and refresh Enrichments from Python and Rust. Reading the values beside a scan of frames is planned.