Skip to main content
POST
/
v1
/
table
/
{id}
/
alter_columns
Error
A valid request URL is required to generate request examples
{
  "version": 1,
  "transaction_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
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

​
delimiter
string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json
​
alterations
object[]
required

List of column alterations to perform

​
identity
object

Identity information of a request.

​
context
object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

​
id
string[]

Response

Alter columns operation result

​
version
integer<int64>
required

Version of the table after altering columns

Required range: x >= 0
​
transaction_id
string

Optional transaction identifier