Skip to content

DescribeTableRequest

Properties

Name Type Description Notes
identity Identity [optional]
context Map<String, String> 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`. [optional]
id List<String> [optional]
version Long Version of the table to describe. If not specified, server should resolve it to the latest version. [optional]
withTableUri Boolean Whether to include the table URI in the response. Default is false. [optional]
loadDetailedMetadata Boolean 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. [optional]
vendCredentials Boolean 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. [optional]