Table
Metadata

Check if a table exists

Changed on

Check if table id exists.

This operation should behave exactly like DescribeTable, except it does not contain a response body.

REST NAMESPACE ONLY REST namespace conveys the result through the HTTP status code with no response body. The REST response maps to the TableExistsResponse model as follows:

  • a 200 response means the table exists; a 404 response means it does not
  • response headers map to context via the header. prefix (see the Context schema)

For DirectoryNamespace implementation, a table exists if either:

  • The table has Lance data versions (regular table created with CreateTable)
  • A .lance-reserved file exists in the table directory (declared table created with DeclareTable)
post/v1/table/{id}/exists

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

Version of the table to check existence. If not specified, server should resolve it to the latest version.

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "version": 0
}

Response

Success, no content

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 new optional request property