Skip to content

DescribeTableResponse

Properties

Name Type Description Notes
table String Table name. Only populated when `load_detailed_metadata` is true. [optional]
namespace List<String> The namespace identifier as a list of parts. Only populated when `load_detailed_metadata` is true. [optional]
version Long Table version number. Only populated when `load_detailed_metadata` is true. [optional]
location String Table storage location (e.g., S3/GCS path). [optional]
tableUri String Table URI. Unlike location, this field must be a complete and valid URI. Only returned when `with_table_uri` is true. [optional]
schema JsonArrowSchema Table schema in JSON Arrow format. Only populated when `load_detailed_metadata` is true. [optional]
storageOptions Map<String, String> 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]
stats TableBasicStats Table statistics. Only populated when `load_detailed_metadata` is true. [optional]
metadata Map<String, String> 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. [optional]
properties Map<String, String> 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. [optional]
managedVersioning Boolean 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. [optional]
isOnlyDeclared Boolean 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. Operations like describe_table with load_detailed_metadata=true may fail for such tables. When false or not set, the table has storage components (data and metadata files). [optional]