LAlance-format
Table
Metadata

Rename a table

Changed on

Rename table id to a new name.

post/v1/table/{id}/rename

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

The table identifier

new_table_namestring required

New name for the table

new_namespace_idstring[]

New namespace identifier to move the table to (optional, if not specified the table stays in the same namespace)

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "new_table_name": "new_table_name",
  "id": [
    "id",
    "id"
  ],
  "new_namespace_id": [
    "new_namespace_id",
    "new_namespace_id"
  ]
}

Response

Table rename operation result

contextunknown
transaction_idstring

Optional transaction identifier

Example response

{
  "transaction_id": "transaction_id",
  "context": {
    "key": "context"
  }
}

Changes

  • 591cd95574b0Revision changes
    • 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

    • info

      added the optional property to the response with the status

  • 83f8516f0507Revision changes
    • info

      added the new optional request property