Trigger an async column backfill job

curl --request POST \ --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/backfill_column \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "column": "<string>", "identity": { "api_key": "<string>", "auth_token": "<string>" }, "id": [ "<string>" ], "branch": "<string>", "where": "<string>", "concurrency": 123, "intra_applier_concurrency": 123, "min_checkpoint_size": 123, "max_checkpoint_size": 123, "batch_checkpoint_flush_interval_seconds": 123, "read_version": 123, "task_size": 123, "num_frags": 123, "checkpoint_size": 123, "commit_granularity": 123, "cluster": "<string>", "manifest": "<string>" } '

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query Parameters

delimiter

string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json

column

string

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.

Minimum string length: 1

identity

object

Identity information of a request.

Show child attributes

string[]

Table identifier path (namespace + table name)

branch

string

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

where

string | null

Optional WHERE clause filter

concurrency

integer | null

Optional concurrency override

intra_applier_concurrency

integer | null

Optional intra-applier concurrency override

min_checkpoint_size

integer | null

Optional minimum checkpoint size

max_checkpoint_size

integer | null

Optional maximum checkpoint size

batch_checkpoint_flush_interval_seconds

number | null

Optional batch checkpoint flush interval in seconds

read_version

integer | null

Optional table version to read from

task_size

integer | null

Optional task size

num_frags

integer | null

Optional number of fragments

checkpoint_size

integer | null

Optional checkpoint size

commit_granularity

integer | null

Optional commit granularity

cluster

string | null

Optional cluster name

manifest

string | null

Optional manifest name

Response

Backfill job accepted

job_id

string

required

The job ID for tracking the backfill job