Get view

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/views/:view

Return the specified view 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

view stringrequired

The name of the view

Responses

200

Returns include the view object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

view

object

name stringrequired

The name of the view

comment stringnullable

The comment of the view

columns

object[]

required

The output columns of the view

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

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

comment stringnullable

The comment of the column

nullable booleannullable

Default value: true

Whether the column is nullable

defaultValue

object

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

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

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

autoIncrement booleannullable

Whether the column is auto increment

]

representations

object[]

required

The representations of the view, keyed by dialect

Array [

oneOf

SQLRepresentation

type stringrequired

Possible values: [sql]

The representation type discriminator

dialect stringrequired

The SQL dialect of this representation

sql stringrequired

The SQL text of the view

]

defaultCatalog stringnullable

The default catalog used to resolve unqualified identifiers in the view representations

defaultSchema stringnullable

The default schema used to resolve unqualified identifiers in the view representations

properties

object

nullable

The properties of the view

property name* string

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

Example (from schema)

{
  "code": 0,
  "view": {
    "name": "string",
    "comment": "string",
    "columns": [
      {
        "name": "string",
        "type": [
          "boolean",
          "byte",
          "byte unsigned",
          "short",
          "short unsigned",
          "integer",
          "integer unsigned",
          "long",
          "long unsigned",
          "float",
          "double",
          "decimal(10,2)",
          "date",
          "time(3)",
          "timestamp(3)",
          "timestamp_tz(3)",
          "string",
          "char(10)",
          "varchar(10)",
          "interval_day",
          "interval_year",
          "uuid",
          "fixed(16)",
          "binary"
        ],
        "comment": "string",
        "nullable": true,
        "defaultValue": {},
        "autoIncrement": false
      }
    ],
    "representations": [
      {}
    ],
    "defaultCatalog": "string",
    "defaultSchema": "string",
    "properties": {},
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    }
  }
}

ViewResponse

{
  "code": 0,
  "view": {
    "name": "view1",
    "comment": "This is a view",
    "audit": {
      "creator": "gravitino",
      "createTime": "2024-01-01T00:00:00Z",
      "lastModifier": "gravitino",
      "lastModifiedTime": "2024-01-01T00:00:00Z"
    },
    "columns": [
      {
        "name": "id",
        "type": "long",
        "comment": "id column",
        "nullable": true
      }
    ],
    "representations": [
      {
        "type": "sql",
        "dialect": "trino",
        "sql": "SELECT id FROM t"
      }
    ],
    "properties": {
      "key": "value"
    }
  }
}

404

Not Found - The target view does not exist

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"
  ]
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchCatalogException

{
  "code": 1003,
  "type": "NoSuchCatalogException",
  "message": "Failed to operate catalog(s) [test] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchCatalogException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchCatalogException: Catalog my_test_metalake.test does not exist",
    "..."
  ]
}

NoSuchSchemaException

{
  "code": 1003,
  "type": "NoSuchSchemaException",
  "message": "Failed to operate schema(s) [my_hive_schema1] operation [LOAD] under catalog [my_hive_catalog], reason [NoSuchSchemaException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchSchemaException: Hive schema (database) does not exist: my_hive_schema1 in Hive Metastore",
    "..."
  ]
}

NoSuchViewException

{
  "code": 1003,
  "type": "NoSuchViewException",
  "message": "Failed to operate view(s) [test_view] operation [LOAD] under schema [test_schema], reason [NoSuchViewException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchViewException: View test_view does not exist",
    "..."
  ]
}

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