LAlance-format
Table
Metadata

Remove columns from table

Changed on

Remove specified columns from table id.

post/v1/table/{id}/drop_columns

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.

columnsstring[] required

Lance field paths to drop. Nested fields use dot-separated segments; use backtick-quoted segments for literal dots and double backticks inside quoted segments. Use canonical full paths for display and errors; leaf names alone only identify top-level fields; invalid or unresolved paths should return InvalidInput or TableColumnNotFound.

Example request

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

Response

Drop columns operation result

contextunknown
transaction_idstring

Optional transaction identifier

versioninteger required

Version of the table after dropping columns

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

  • a3308034a3cdRevision changes
    • breaking

      the / request property's minLength was increased from 0 to 1