LAlance-format
Table
Metadata

Modify existing columns

Changed on

Modify existing columns in table id, such as renaming or changing data types.

post/v1/table/{id}/alter_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[]

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"
  },
  "alterations": [
    {
      "path": "path",
      "nullable": true,
      "rename": "rename",
      "data_type": "{}",
      "virtual_column": {
        "image": "image",
        "field_metadata": {
          "key": "field_metadata"
        },
        "manifest_checksum": "manifest_checksum",
        "udf": "udf",
        "udf_name": "udf_name",
        "manifest": "manifest",
        "input_columns": [
          "input_columns",
          "input_columns"
        ],
        "udf_backend": "udf_backend",
        "auto_backfill": true,
        "udf_version": "udf_version"
      }
    },
    {
      "path": "path",
      "nullable": true,
      "rename": "rename",
      "data_type": "{}",
      "virtual_column": {
        "image": "image",
        "field_metadata": {
          "key": "field_metadata"
        },
        "manifest_checksum": "manifest_checksum",
        "udf": "udf",
        "udf_name": "udf_name",
        "manifest": "manifest",
        "input_columns": [
          "input_columns",
          "input_columns"
        ],
        "udf_backend": "udf_backend",
        "auto_backfill": true,
        "udf_version": "udf_version"
      }
    }
  ],
  "id": [
    "id",
    "id"
  ],
  "branch": "branch"
}

Response

Alter columns operation result

contextunknown
versioninteger required

The commit version associated with the operation

Example response

{
  "context": {
    "key": "context"
  },
  "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

    • breaking

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