Describe information of a table
Describe the detailed information for table id.
REST NAMESPACE ONLY REST namespace passes with_table_uri, load_detailed_metadata, and check_declared as query parameters instead of in the request body.
Request body
Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.
On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.
REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:
- On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
- On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.
Version of the table to describe. If not specified, server should resolve it to the latest version.
Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with version or branch.
Branch to target. When not specified, the main branch is used.
Whether to include the table URI in the response. Default is false.
Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as version, schema, and stats which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.
Whether to check if the table exists only as a namespace declaration without storage data. Default is false. When true, the response should populate is_only_declared. When false, the implementation should return null for is_only_declared unless another option such as load_detailed_metadata requires checking declared-only table state.
Whether to include vended credentials in the response storage_options. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials.
Response
Table properties result when loading a table
Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.
On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.
REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:
- On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
- On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.
Table name. Only populated when load_detailed_metadata is true.
The namespace identifier as a list of parts. Only populated when load_detailed_metadata is true.
Table version number. Only populated when load_detailed_metadata is true.
Table storage location (e.g., S3/GCS path).
Table URI. Unlike location, this field must be a complete and valid URI. Only returned when with_table_uri is true.
Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access. When vend_credentials is true, this field may include vended credentials. If the vended credentials are temporary, the expires_at_millis key should be included to indicate the millisecond timestamp when the credentials expire.
Optional table metadata as key-value pairs. This records the information of the table and requires loading the table. It is only populated when load_detailed_metadata is true.
Properties stored on the table, if supported by the server. This records the information managed by the namespace. If the server does not support table properties, it should return null for this field. If table properties are supported, but none are set, it should return an empty object.
When true, the caller should use namespace table version operations (CreateTableVersion, BatchCreateTableVersions, DescribeTableVersion, ListTableVersions, BatchDeleteTableVersions) to manage table versions instead of relying on Lance's native version management.
When true, indicates that the table has been declared in the namespace but not yet created on storage. This means the table exists in the namespace but has no data files on the underlying storage. When false, the table has storage components (data and metadata files). When null, the implementation did not check whether the table is only declared. Clients should treat an omitted value as null. Implementations should populate this field when check_declared is true or another option such as load_detailed_metadata requires checking declared-only table state. Operations like describe_table with load_detailed_metadata=true may fail for declared-only tables.