Update rows in a table

Update existing rows in table id.

POST /v1/table/{id}/update

Error

A valid request URL is required to generate request examples

200

{
  "updated_rows": 1,
  "version": 1,
  "transaction_id": "<string>",
  "properties": {}
}

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

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

Path Parameters

id · 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

Update request

Each update consists of a field path and an SQL expression that will be evaluated against the current row's value. Optionally, a predicate can be provided to filter which rows to update.

updates · string[][] · required

List of field updates as [field_path, expression] pairs. Field paths and expression references must use Lance field path syntax: nested fields use dot-separated segments, literal dots require backtick-quoted segments, and backticks inside quoted segments are doubled.

Required array length: 2 elements

identity · object

Identity information of a request.

Show child attributes

context · object

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

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

Show child attributes

id · string[]

branch · string

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

predicate · string | null

Optional SQL predicate to filter rows for update. Field references must use Lance field path syntax: nested fields use dot-separated segments, literal dots require backtick-quoted segments, and backticks inside quoted segments are doubled.

properties · object

Properties stored on the table, if supported by the implementation.

Show child attributes

Response

200

application/json

Update successful

updated_rows · integer<int64> · required

Number of rows updated

Required range: x >= 0

version · integer<int64> · required

The commit version associated with the operation

Required range: x >= 0

transaction_id · string

Optional transaction identifier

properties · object

If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.

Show child attributes