Update rows in a table

Changed on Jul 1, 2026

Update existing rows in table id.

post/v1/table/{id}/update

Request

Base URL
http://localhost:2333
Auth
- OAuth 2
  Client credentials
  Token URL: /oauth/token
- or HTTP bearer
- or API key in header x-api-key

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

contextunknown

idstring[]

branchstring

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

predicatestring nullable

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.

propertiesunknown

Example request

{
  "predicate": "predicate",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "updates": [
    [
      "updates",
      "updates"
    ],
    [
      "updates",
      "updates"
    ]
  ],
  "branch": "branch",
  "properties": {
    "key": "properties"
  }
}

Response

Update successful

contextunknown

transaction_idstring

Optional transaction identifier

updated_rowsinteger required

Number of rows updated

versioninteger required

The commit version associated with the operation