Create a view in the given namespace

POST 
/v1/:prefix/namespaces/:namespace/views

Create a view in the given namespace.

Request

Path Parameters

prefix stringrequired

The catalog name in Gravitino, as returned in defaults.prefix by GET /v1/config

namespace stringrequired

A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override namespace-separator, which defaults to the unit separator 0x1F byte (url encoded %1F). To be compatible with older clients, servers must use both the advertised separator and 0x1F as valid separators when decoding namespaces. The namespace-separator should be provided in a url encoded form.

Examples:

singlepart_namespace

Example: accounting

multipart_namespace

Example: accounting%1Ftax

application/json

Body

required

name stringrequired
location string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType

string

ListType

type stringrequired

element-id integerrequired

element required

element-required booleanrequired

MapType

type stringrequired

key-id integerrequired

key required

value-id integerrequired

value required

value-required booleanrequired

required booleanrequired

doc string

initial-default

object

oneOf

BooleanTypeValue

boolean

IntegerTypeValue

integer

LongTypeValue

integer

FloatTypeValue

number

DoubleTypeValue

number

DecimalTypeValue

Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'

string

StringTypeValue

string

UUIDTypeValue

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

DateTypeValue

Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format

string

TimeTypeValue

Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTypeValue

Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTzTypeValue

TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)

string

TimestampNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision

string

TimestampTzNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)

string

FixedTypeValue

Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length

string

BinaryTypeValue

Binary type values are stored and serialized as an uppercase hexadecimal string

string

write-default

object

oneOf

BooleanTypeValue

boolean

IntegerTypeValue

integer

LongTypeValue

integer

FloatTypeValue

number

DoubleTypeValue

number

DecimalTypeValue

Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'

string

StringTypeValue

string

UUIDTypeValue

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

DateTypeValue

Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format

string

TimeTypeValue

Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTypeValue

Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTzTypeValue

TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)

string

TimestampNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision

string

TimestampTzNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)

string

FixedTypeValue

Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length

string

BinaryTypeValue

Binary type values are stored and serialized as an uppercase hexadecimal string

string

]

identifier-field-ids integer[]

view-version

object

required

The view version to create, will replace the schema-id sent within the view-version with the id assigned to the provided schema

version-id integerrequired

timestamp-ms int64required

schema-id integerrequired

Schema ID to set as current, or -1 to set last added schema

summary

object

required

property name* string

representations

object[]

required

Array [

oneOf

SQLViewRepresentation

type stringrequired

sql stringrequired

dialect stringrequired

]

default-catalog string

default-namespace string[]required

Reference to one or more levels of a namespace

properties

object

required

property name* string

Responses

200

View metadata result when loading a view

application/json

Schema

Schema

metadata-location stringrequired

metadata

object

required

view-uuid stringrequired

format-version integerrequired

Possible values: >= 1 and <= 1

location stringrequired

current-version-id integerrequired

versions

object[]

required

Array [

version-id integerrequired

timestamp-ms int64required

schema-id integerrequired

Schema ID to set as current, or -1 to set last added schema

summary

object

required

property name* string

representations

object[]

required

Array [

oneOf

SQLViewRepresentation

type stringrequired

sql stringrequired

dialect stringrequired

]

default-catalog string

default-namespace string[]required

Reference to one or more levels of a namespace

]

version-log

object[]

required

Array [

version-id integerrequired

timestamp-ms int64required

]

schemas object[]required

properties

object

property name* string

config

object

property name* string

Example (from schema)

{
  "metadata-location": "string",
  "metadata": {
    "view-uuid": "string",
    "format-version": 0,
    "location": "string",
    "current-version-id": 0,
    "versions": [
      {
        "version-id": 0,
        "timestamp-ms": 0,
        "schema-id": 0,
        "summary": {},
        "representations": [
          {}
        ],
        "default-catalog": "string",
        "default-namespace": [
          "accounting",
          "tax"
        ]
      }
    ],
    "version-log": [
      {
        "version-id": 0,
        "timestamp-ms": 0
      }
    ],
    "schemas": [
      {
        "type": "string",
        "fields": [
          {
            "id": 0,
            "name": "string",
            "type": [
              "long",
              "string",
              "fixed[16]",
              "decimal(10,2)"
            ],
            "required": true,
            "doc": "string",
            "initial-default": true,
            "write-default": true
          }
        ],
        "schema-id": 0,
        "identifier-field-ids": [
          0
        ]
      }
    ],
    "properties": {}
  },
  "config": {}
}

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Malformed request",
    "type": "BadRequestException",
    "code": 400
  }
}

401

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 401
  }
}

403

Forbidden. Authenticated user does not have the necessary permissions.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 403
  }
}

404

Not Found - The namespace specified does not exist

application/json

Schema

Schema

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

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

NamespaceNotFound

The requested namespace does not exist

{
  "error": {
    "message": "The given namespace does not exist",
    "type": "NoSuchNamespaceException",
    "code": 404
  }
}

409

Conflict - The identifier already exists as a table or view

application/json

Schema

Schema

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

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

ViewAlreadyExists

The requested view identifier already exists

{
  "error": {
    "message": "The requested view identifier already exists",
    "type": "AlreadyExistsException",
    "code": 409
  }
}

419

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Credentials have timed out",
    "type": "AuthenticationTimeoutException",
    "code": 419
  }
}

503

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Slow down",
    "type": "SlowDownException",
    "code": 503
  }
}

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/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Internal Server Error",
    "type": "InternalServerError",
    "code": 500
  }
}

Loading...