DescribeTable
Description
description: |
Describe the detailed information for table `id`.
Request Schema
DescribeTableRequest:
type: object
properties:
id:
type: array
items:
type: string
version:
description: |
Version of the table to describe.
If not specified, server should resolve it to the latest version.
type: integer
format: int64
minimum: 0
Response Schema
DescribeTableResponse:
type: object
required:
- schema
- version
properties:
version:
type: integer
format: int64
minimum: 0
location:
type: string
schema:
$ref: '#/components/schemas/JsonArrowSchema'
properties:
type: object
additionalProperties:
type: string
storage_options:
type: object
description: |
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.
additionalProperties:
type: string
Json Arrow Schema
JsonArrowSchema:
type: object
description: |
JSON representation of a Apache Arrow schema.
required:
- fields
properties:
fields:
type: array
items:
$ref: '#/components/schemas/JsonArrowField'
metadata:
type: object
additionalProperties:
type: string
propertyNames:
type: string
Json Arrow Schema
JsonArrowField:
type: object
description: |
JSON representation of an Apache Arrow field.
required:
- name
- type
- nullable
properties:
metadata:
type: object
additionalProperties:
type: string
propertyNames:
type: string
name:
type: string
nullable:
type: boolean
type:
$ref: '#/components/schemas/JsonDataType'