Sign in
Table
Data

Delete rows from a table

Delete rows from table id.

post/v1/table/{id}/delete

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:DeleteFromTableRequest: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[]

The namespace identifier

branchstring

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

predicatestring required

SQL predicate to filter rows for deletion. 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.

Example request

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

Response

Delete successful

transaction_idstring

Optional transaction identifier

versioninteger

The commit version associated with the operation

Example response

{
  "transaction_id": "transaction_id",
  "version": 0
}

Changes