Get partition by name

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/tables/:table/partitions/:partition

Returns the specified partition

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

partition stringrequired

The name of the partition

Responses

200

Returns include the partition object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

partition

object

oneOf

IdentityPartition

type stringrequired

Possible values: [identity]

name Name

The name of the partition

fieldNames array[]required

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

values

object[]

required

The values of the partition, must be the same length and order as fieldNames

Array [

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

]

properties

object

nullable

The properties of the partition

property name* string

RangePartition

type stringrequired

Possible values: [range]

name Namerequired

The name of the partition

upper

object

required

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

lower

object

required

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

properties

object

nullable

The properties of the partition

property name* string

ListPartition

type stringrequired

Possible values: [list]

name Namerequired

The name of the partition

lists array[]required

The values of the partition

properties

object

nullable

The properties of the partition

property name* string

Example (from schema)

{
  "code": 0,
  "partition": {}
}

GetHivePartitionResponse

{
  "code": 0,
  "partition": {
    "type": "identity",
    "name": "hive_col_name2=2023-01-01/hive_col_name3=gravitino_it_test",
    "fieldNames": [
      [
        "hive_col_name2"
      ],
      [
        "hive_col_name3"
      ]
    ],
    "values": [
      {
        "type": "literal",
        "dataType": "string",
        "value": "2023-01-01"
      },
      {
        "type": "literal",
        "dataType": "string",
        "value": "gravitino_it_test"
      }
    ],
    "properties": {
      "totalSize": "2",
      "numRows": "0",
      "rawDataSize": "0",
      "COLUMN_STATS_ACCURATE": "{\"BASIC_STATS\":\"true\"}",
      "numFiles": "1",
      "transient_lastDdlTime": "1706950516"
    }
  }
}

404

Not Found - The specified partition 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",
    "..."
  ]
}

NoSuchTableException

{
  "code": 1003,
  "type": "NoSuchTableException",
  "message": "Failed to operate table(s) [test_table] operation [LOAD] under schema [test_schema], reason [NoSuchTableException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchTableException: Hive table does not exist: test_table in Hive Metastore",
    "..."
  ]
}

NoSuchPartitionException

{
  "code": 1003,
  "type": "NoSuchPartitionException",
  "message": "Failed to operate partition(s) operation [GET] of table [table1], reason [p3]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchPartitionException: p3",
    "..."
  ]
}

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