Update rows in a table

Update existing rows in a table using SQL expressions. Each update consists of a column name 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.

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 nullable

An opaque token that allows pagination for list APIs (e.g. ListNamespaces). For an initial client request for a list API, if the server cannot return all items in one response, or if there are more items than the pageSize specified in the client request, the server must return a nextPageToken in the response indicating there are more results available. After the initial request, the value of nextPageToken from each response must be used by the client as the pageToken parameter value for the next request. Clients must interpret either null, missing value or empty string value of nextPageToken from a server response as the end of the listing results.

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

Request body

namestring required

The table name

namespacestring[] required

The namespace identifier

predicatestring nullable

Optional SQL predicate to filter rows for update

Example request

{
  "predicate": "predicate",
  "name": "name",
  "namespace": [
    "namespace",
    "namespace"
  ],
  "updates": [
    [
      "updates",
      "updates"
    ],
    [
      "updates",
      "updates"
    ]
  ]
}

Response

Update successful

updated_rowsinteger required

Number of rows updated

versioninteger required

The commit version associated with the operation

Example response

{
  "updated_rows": 0,
  "version": 0
}