Skip to main content
Version: 0.4.0

Get table

GET 

/metalakes/:metalake/catalogs/:catalog/schemas/:schema/tables/:table

Returns the specified table object

Request

Path Parameters

    metalake stringrequired

    The name of the metalake

    catalog stringrequired

    The name of the catalog

    schema stringrequired

    The name of the schema

    table stringrequired

    The name of the table

Responses

Returns include the table object

Schema

    code int32

    Possible values: [0]

    Status code of the response

    table

    object

    A table object

    name stringrequired

    The name of the table

    columns

    object[]

    required

    A list of columns

  • Array [

  • name stringrequired

    The name of the column

    type

    object

    required

    oneOf

    string

    comment stringnullable

    The comment of the column

    nullable booleannullable

    Default value: true

    Whether the column is nullable

    defaultValue

    object

    oneOf

    type string

    Possible values: [literal]

    dataType

    object

    required

    oneOf

    string

    value stringrequired

    The string format of the literal value

    autoIncrement booleannullable

    Default value: false

    Whether the column is auto increment

  • ]

  • comment stringnullable

    The comment of the table

    audit

    object

    required

    Audit information for a Gravitino resource.

    creator string

    The user who created the resource

    createTime date-time

    The time the resource was created

    lastModifier string

    The user who last modified the resource

    lastModifiedTime date-time

    The time the resource was last modified

    properties

    object

    nullable

    A map of table properties

    property name* string

    distribution

    object

    nullable

    Describes how data is distributed across partitions

    strategy stringnullable

    Possible values: [hash, range, even]

    Default value: hash

    The distribution strategy

    number int32required

    The number of buckets/distribution

    funcArgs

    object[]

    nullable

    required

    The arguments of the distribution function

  • Array [

  • oneOf

    type string

    Possible values: [literal]

    dataType

    object

    required

    oneOf

    string

    value stringrequired

    The string format of the literal value

  • ]

  • sortOrders

    object[]

    nullable

    Describes the sort order of the table data

  • Array [

  • sortTerm

    object

    required

    oneOf

    type string

    Possible values: [literal]

    dataType

    object

    required

    oneOf

    string

    value stringrequired

    The string format of the literal value

    direction stringnullable

    Possible values: [asc, desc]

    Default value: asc

    The direction of the sort order

    nullOrdering string

    Possible values: [nulls_first, nulls_last]

    | The sort order of null values. The default value is "nulls_first" if the direction is "asc", otherwise "nulls_last".

  • ]

  • partitioning

    object[]

    nullable

    partitioning of the table data

  • Array [

  • oneOf

    strategy stringrequired

    Possible values: [identity]

    fieldName string[]required

    The name of the field, may be with multiple levels

  • ]

  • indexes

    object[]

    nullable

    Indexes of the table

  • Array [

  • indexType stringrequired

    Possible values: [primary_key, unique_key]

    name stringnullable

    The name of the index

    fieldNames array[]required

    The names of the fields, each field may be with multiple levels

  • ]

Loading...