LAlance-format
Table
Data

Delete rows from a table

Changed on

Delete rows from table id.

post/v1/table/{id}/delete

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

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

contextunknown
transaction_idstring

Optional transaction identifier

versioninteger

The commit version associated with the operation

Example response

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

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9932582b6bd7Revision changes
    • info

      added the new optional request property