Sign in
Table
Data

Update rows in a table

Update existing rows in table id.

post/v1/table/{id}/update

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:UpdateTableRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context for a request as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nREST NAMESPACE ONLY\nContext entries are passed via HTTP headers using the naming convention\n`x-lance-ctx-<key>: <value>`. For example, a context entry\n`{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.\n"}
idstring[]
branchstring

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

predicatestring nullable

Optional SQL predicate to filter rows for update

{"stackTrail":"components:schemas:UpdateTableRequest:properties:properties","oasType":"schema","type":"unknown","description":"Properties stored on the table, if supported by the implementation.\n"}

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

transaction_idstring

Optional transaction identifier

updated_rowsinteger required

Number of rows updated

versioninteger required

The commit version associated with the operation

{"stackTrail":"components:schemas:UpdateTableResponse:properties:properties","oasType":"schema","type":"unknown","description":"If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.\n"}

Example response

{
  "transaction_id": "transaction_id",
  "updated_rows": 0,
  "version": 0,
  "properties": {
    "key": "properties"
  }
}

Changes