Sign in
Table
Metadata

Modify existing columns

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

post/v1/table/{id}/alter_columns

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

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",
        "udf": "udf",
        "udf_name": "udf_name",
        "input_columns": [
          "input_columns",
          "input_columns"
        ],
        "udf_version": "udf_version"
      }
    },
    {
      "path": "path",
      "nullable": true,
      "rename": "rename",
      "data_type": "{}",
      "virtual_column": {
        "image": "image",
        "udf": "udf",
        "udf_name": "udf_name",
        "input_columns": [
          "input_columns",
          "input_columns"
        ],
        "udf_version": "udf_version"
      }
    }
  ],
  "id": [
    "id",
    "id"
  ]
}

Response

Alter columns operation result

transaction_idstring

Optional transaction identifier

versioninteger required

Version of the table after altering columns

Example response

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

Changes