Trigger an async column backfill job

curl --request POST \
  --url http://localhost:2333/v1/table/{id}/backfill_column \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "column": "<string>",
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "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>"
}
'

import requests

url = "http://localhost:2333/v1/table/{id}/backfill_column"

payload = {
    "column": "<string>",
    "identity": {
        "api_key": "<string>",
        "auth_token": "<string>"
    },
    "context": {},
    "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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    column: '<string>',
    identity: {api_key: '<string>', auth_token: '<string>'},
    context: {},
    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>'
  })
};

fetch('http://localhost:2333/v1/table/{id}/backfill_column', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2333",
  CURLOPT_URL => "http://localhost:2333/v1/table/{id}/backfill_column",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'column' => '<string>',
    'identity' => [
        'api_key' => '<string>',
        'auth_token' => '<string>'
    ],
    'context' => [
        
    ],
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2333/v1/table/{id}/backfill_column"

	payload := strings.NewReader("{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2333/v1/table/{id}/backfill_column")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2333/v1/table/{id}/backfill_column")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "<string>",
  "context": {}
}

{
  "type": "/errors/bad-request",
  "title": "Malformed request",
  "status": 400,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/unauthorized-request",
  "title": "No valid authentication credentials for the operation",
  "status": 401,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/forbidden-request",
  "title": "Not authorized to make this request",
  "status": 403,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/not-found-error",
  "title": "Not found Error",
  "status": 404,
  "detail": "",
  "instance": "/v1/namespaces/{ns}"
}

{
  "type": "/errors/service-unavailable",
  "title": "Slow down",
  "status": 503,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "",
  "instance": "/v1/namespaces"
}

POST

table

{id}

backfill_column

Trigger an async column backfill job

curl --request POST \
  --url http://localhost:2333/v1/table/{id}/backfill_column \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "column": "<string>",
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "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>"
}
'

import requests

url = "http://localhost:2333/v1/table/{id}/backfill_column"

payload = {
    "column": "<string>",
    "identity": {
        "api_key": "<string>",
        "auth_token": "<string>"
    },
    "context": {},
    "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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    column: '<string>',
    identity: {api_key: '<string>', auth_token: '<string>'},
    context: {},
    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>'
  })
};

fetch('http://localhost:2333/v1/table/{id}/backfill_column', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2333",
  CURLOPT_URL => "http://localhost:2333/v1/table/{id}/backfill_column",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'column' => '<string>',
    'identity' => [
        'api_key' => '<string>',
        'auth_token' => '<string>'
    ],
    'context' => [
        
    ],
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2333/v1/table/{id}/backfill_column"

	payload := strings.NewReader("{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2333/v1/table/{id}/backfill_column")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2333/v1/table/{id}/backfill_column")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"column\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"where\": \"<string>\",\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"min_checkpoint_size\": 123,\n  \"max_checkpoint_size\": 123,\n  \"batch_checkpoint_flush_interval_seconds\": 123,\n  \"read_version\": 123,\n  \"task_size\": 123,\n  \"num_frags\": 123,\n  \"checkpoint_size\": 123,\n  \"commit_granularity\": 123,\n  \"cluster\": \"<string>\",\n  \"manifest\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "<string>",
  "context": {}
}

{
  "type": "/errors/bad-request",
  "title": "Malformed request",
  "status": 400,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/unauthorized-request",
  "title": "No valid authentication credentials for the operation",
  "status": 401,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/forbidden-request",
  "title": "Not authorized to make this request",
  "status": 403,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/not-found-error",
  "title": "Not found Error",
  "status": 404,
  "detail": "",
  "instance": "/v1/namespaces/{ns}"
}

{
  "type": "/errors/service-unavailable",
  "title": "Slow down",
  "status": 503,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "",
  "instance": "/v1/namespaces"
}

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

context

object

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"}.

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

context

object

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"}.

Show child attributes