Skip to main content
PATCH
/
api
/
metastore
/
catalogs
/
{catalog_name}
/
schemas
/
{schema_name}
/
tables
/
{table_name}
Alter tables
curl --request PATCH \
  --url https://api.example.com/api/metastore/catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operations": [
    {
      "column_to_delete": "<string>",
      "column_to_add": "<string>",
      "column_type": "<string>",
      "nullable": true,
      "comment": "<string>",
      "old_column_name": "<string>",
      "new_column_name": "<string>",
      "column_name": "<string>",
      "new_column_type": "<string>",
      "new_table_name": "<string>"
    }
  ]
}
'
{
  "status": "<string>",
  "message": "<string>",
  "altered_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
catalog_name
string
required

Catalog name.

​
schema_name
string
required

Schema name.

​
table_name
string
required

Table name.

Body

application/json
​
operations
AlterTableOperation · object[]
required

Ordered list of alter operations to apply

Response

Table altered successfully.

​
status
string
required

The status of the job after completion. (COMPLETED / FAILED)

​
message
string
required

Message describing the completion,partial completion, or failure of the execution.

​
altered_at
string<date-time>
required

Timestamp when the job was created.