Create table

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

Create table

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

application/json

Body

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

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

comment stringnullable

The comment of the column

nullable booleannullable

Default value: true

Whether the column is nullable

]

comment stringnullable

The comment of the table

properties

object

nullable

A map of table properties

property name* string

sortOrders

object[]

nullable

Describes the sort order of the table data

Array [

sortTerm

object

required

oneOf

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

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".

]

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

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

]

partitioning

object[]

nullable

partitioning of the table data

Array [

oneOf

IdentityPartitioning

strategy stringrequired

Possible values: [identity]

fieldName string[]required

The name of the field, may be with multiple levels

YearPartitioning

strategy stringrequired

Possible values: [year]

fieldName string[]required

The name of the field, may be with multiple levels

MonthPartitioning

strategy stringrequired

Possible values: [month]

fieldName string[]required

The name of the field, may be with multiple levels

DayPartitioning

strategy stringrequired

Possible values: [day]

fieldName string[]required

The name of the field, may be with multiple levels

HourPartitioning

strategy stringrequired

Possible values: [hour]

fieldName string[]required

The name of the field, may be with multiple levels

BucketPartitioning

strategy stringrequired

Possible values: [bucket]

numBuckets integerrequired

The number of buckets

fieldNames array[]required

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

TruncatePartitioning

strategy stringrequired

Possible values: [truncate]

width integerrequired

The width of the truncate

fieldName string[]required

The name of the field, may be with multiple levels

ListPartitioning

strategy stringrequired

Possible values: [list]

fieldNames array[]required

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

RangePartitioning

strategy stringrequired

Possible values: [range]

fieldName string[]required

The name of the field, may be with multiple levels

FunctionPartitioning

strategy stringrequired

Possible values: [function]

funcName stringrequired

The name of the partitioning function

funcArgs

object[]

required

The arguments of the partitioning function

Array [

oneOf

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

]

]

Responses

200

Returns include the table object

application/vnd.gravitino.v1+json

Schema

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

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

comment stringnullable

The comment of the column

nullable booleannullable

Default value: true

Whether the column is nullable

]

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

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

]

sortOrders

object[]

nullable

Describes the sort order of the table data

Array [

sortTerm

object

required

oneOf

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

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

IdentityPartitioning

strategy stringrequired

Possible values: [identity]

fieldName string[]required

The name of the field, may be with multiple levels

YearPartitioning

strategy stringrequired

Possible values: [year]

fieldName string[]required

The name of the field, may be with multiple levels

MonthPartitioning

strategy stringrequired

Possible values: [month]

fieldName string[]required

The name of the field, may be with multiple levels

DayPartitioning

strategy stringrequired

Possible values: [day]

fieldName string[]required

The name of the field, may be with multiple levels

HourPartitioning

strategy stringrequired

Possible values: [hour]

fieldName string[]required

The name of the field, may be with multiple levels

BucketPartitioning

strategy stringrequired

Possible values: [bucket]

numBuckets integerrequired

The number of buckets

fieldNames array[]required

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

TruncatePartitioning

strategy stringrequired

Possible values: [truncate]

width integerrequired

The width of the truncate

fieldName string[]required

The name of the field, may be with multiple levels

ListPartitioning

strategy stringrequired

Possible values: [list]

fieldNames array[]required

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

RangePartitioning

strategy stringrequired

Possible values: [range]

fieldName string[]required

The name of the field, may be with multiple levels

FunctionPartitioning

strategy stringrequired

Possible values: [function]

funcName stringrequired

The name of the partitioning function

funcArgs

object[]

required

The arguments of the partitioning function

Array [

oneOf

Literal

type string

Possible values: [literal]

dataType

object

required

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs undefined[]required

The arguments of the function

]

]

Example (from schema)

{
  "code": 0,
  "table": {
    "name": "string",
    "columns": [
      {
        "name": "string",
        "type": [
          "boolean",
          "byte",
          "short",
          "integer",
          "long",
          "float",
          "double",
          "decimal(10,2)",
          "date",
          "time",
          "timestamp",
          "timestamp_tz",
          "string",
          "char(10)",
          "varchar(10)",
          "interval_day",
          "interval_year",
          "uuid",
          "fixed(16)",
          "binary"
        ],
        "comment": "string",
        "nullable": true
      }
    ],
    "comment": "string",
    "audit": {
      "creator": "string",
      "createTime": "2023-12-13T12:11:10.320Z",
      "lastModifier": "string",
      "lastModifiedTime": "2023-12-13T12:11:10.320Z"
    },
    "properties": {},
    "distribution": {
      "strategy": "hash",
      "number": 0,
      "funcArgs": [
        {},
        {},
        {}
      ]
    },
    "sortOrders": [
      {
        "sortTerm": {},
        "direction": "asc",
        "nullOrdering": "nulls_first"
      }
    ],
    "partitioning": [
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {}
    ]
  }
}

TableResponse

{
  "code": 0,
  "table": {
    "name": "my_hive_table",
    "comment": "This is my Hive table",
    "columns": [
      {
        "name": "id",
        "type": "integer",
        "comment": "id column comment",
        "nullable": true
      },
      {
        "name": "name",
        "type": "string",
        "comment": "name column comment",
        "nullable": true
      },
      {
        "name": "age",
        "type": "integer",
        "comment": "age column comment",
        "nullable": true
      },
      {
        "name": "dt",
        "type": "date",
        "comment": "dt column comment",
        "nullable": true
      }
    ],
    "properties": {
      "input-format": "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat",
      "transient_lastDdlTime": "1702033666",
      "output-format": "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat",
      "location": "hdfs://0.0.0.0:9000/user/hive/warehouse/my_hive_table",
      "table-type": "MANAGED_TABLE",
      "serde-lib": "org.apache.hadoop.hive.ql.io.orc.OrcSerde",
      "serde-name": "my_hive_table"
    },
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-08T11:07:46.938Z"
    },
    "distribution": {
      "strategy": "hash",
      "number": 32,
      "funcArgs": [
        {
          "type": "field",
          "fieldName": [
            "id"
          ]
        }
      ]
    },
    "sortOrders": [
      {
        "sortTerm": {
          "type": "field",
          "fieldName": [
            "age"
          ]
        },
        "direction": "asc",
        "nullOrdering": "nulls_first"
      }
    ],
    "partitioning": [
      {
        "strategy": "identity",
        "fieldName": [
          "dt"
        ]
      }
    ]
  }
}

409

Conflict - The target table already exists

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

TableAlreadyExistsErrorResponse

{
  "code": 1004,
  "type": "TableAlreadyExistsException",
  "message": "Failed to operate table(s) [my_hive_table] operation [CREATE] under schema [my_hive_schema], reason [TableAlreadyExistsException]",
  "stack": [
    "com.datastrato.gravitino.exceptions.TableAlreadyExistsException: Table already exists: my_hive_table",
    "..."
  ]
}

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...