v52

latestOpenAPI 3.1.1Apache 2.0raw.githubusercontent.com2026-08-0354155395.9 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

Path parameters

idstring 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

delimiterstring

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

Request body

{"stackTrail":"components:schemas:AlterTableBackfillColumnsRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

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

Example request

{
  "max_checkpoint_size": 5,
  "cluster": "cluster",
  "min_checkpoint_size": 1,
  "read_version": 2,
  "manifest": "manifest",
  "column": "column",
  "branch": "branch",
  "concurrency": 0,
  "num_frags": 9,
  "checkpoint_size": 3,
  "commit_granularity": 2,
  "task_size": 7,
  "batch_checkpoint_flush_interval_seconds": 5.637376656633329,
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "where": "where",
  "id": [
    "id",
    "id"
  ],
  "intra_applier_concurrency": 6
}

Response

Backfill job accepted

{"stackTrail":"components:schemas:AlterTableBackfillColumnsResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

job_idstring required

The job ID for tracking the backfill job

Example response

{
  "job_id": "job_id",
  "context": {
    "key": "context"
  }
}