Create schema

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

Create schema

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

application/json

Body

name stringrequired

The name of the schema

comment stringnullable

A comment describing the schema

properties

object

nullable

A map of properties for the schema

property name* string

Responses

200

Returns include the schema object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

schema

object

A schema

name stringrequired

The name of the schema

comment stringnullable

A comment describing the schema

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 properties for the schema

property name* string

Example (from schema)

{
  "code": 0,
  "schema": {
    "name": "string",
    "comment": "string",
    "audit": {
      "creator": "string",
      "createTime": "2024-10-11T06:45:50.603Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-10-11T06:45:50.603Z"
    },
    "properties": {}
  }
}

SchemaResponse

{
  "code": 0,
  "schema": {
    "name": "my_hive_schema",
    "comment": "This is my Hive schema",
    "properties": {
      "key1": "value1",
      "key2": "value2",
      "location": "hdfs://0.0.0.0:9000/user/hive/warehouse"
    },
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-08T08:37:43.531Z"
    }
  }
}

409

Conflict - The target schema 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"
  ]
}

SchemaAlreadyExistsErrorResponse

{
  "code": 1004,
  "type": "SchemaAlreadyExistsException",
  "message": "Failed to operate schema(s) [my_hive_schema] operation [CREATE] under catalog [my_hive_catalog], reason [SchemaAlreadyExistsException]",
  "stack": [
    "org.apache.gravitino.exceptions.SchemaAlreadyExistsException: Hive schema (database) 'my_hive_schema' already exists in Hive Metastore",
    "..."
  ]
}

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