LAlance-format
Table
Metadata

Update per-field metadata

Changed on

Update the Arrow field (column) metadata for table id.

Each entry targets a field by path and merges the provided key-value pairs into that field's existing metadata, or replaces it when replace is true. A null metadata value deletes that key.

post/v1/table/{id}/update_field_metadata

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

Table identifier path (namespace + table name)

branchstring

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

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "updates": [
    {
      "path": "path",
      "metadata": {
        "key": "metadata"
      },
      "replace": true
    },
    {
      "path": "path",
      "metadata": {
        "key": "metadata"
      },
      "replace": true
    }
  ],
  "branch": "branch"
}

Response

Field metadata update result

contextunknown
versioninteger required

The commit version associated with the operation

fieldsunknown

Example response

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

Changes

  • 591cd95574b0Revision changes
    • info

      added the new optional request property

    • 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