v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 KB

Table

Data

Trigger an async column backfill job

Trigger an asynchronous backfill job for a computed column on table id. The column must be a virtual (UDF-backed) column. Returns a job ID for tracking.

post/v1/table/{id}/backfill_column

Request body

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

idstring[]

Table identifier path (namespace + table name)

branchstring

Branch to target. When not specified, the main branch is used.

columnstring required

Lance field path to backfill. Nested fields use dot-separated segments; use backtick-quoted segments for literal dots and double backticks inside quoted segments. Use canonical full paths for display and errors; leaf names alone only identify top-level fields; invalid or unresolved paths should return InvalidInput or TableColumnNotFound.

wherestring nullable

Optional WHERE clause filter

concurrencyinteger nullable

Optional concurrency override

intra_applier_concurrencyinteger nullable

Optional intra-applier concurrency override

min_checkpoint_sizeinteger nullable

Optional minimum checkpoint size

max_checkpoint_sizeinteger nullable

Optional maximum checkpoint size

batch_checkpoint_flush_interval_secondsnumber nullable

Optional batch checkpoint flush interval in seconds

read_versioninteger nullable

Optional table version to read from

task_sizeinteger nullable

Optional task size

num_fragsinteger nullable

Optional number of fragments

checkpoint_sizeinteger nullable

Optional checkpoint size

commit_granularityinteger nullable

Optional commit granularity

clusterstring nullable

Optional cluster name

manifeststring nullable

Optional manifest name

Response

Backfill job accepted

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

job_idstring required

The job ID for tracking the backfill job