List partitions (names)

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

List partitions (names)

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

Query Parameters

details boolean

Include detailed information about the partitions

Responses

200

Returns list of partition objects if {details} is true, else returns list of partition names

application/vnd.gravitino.v1+json

Schema

Schema

oneOf

PartitionNameListResponse

code int32

Possible values: [0]

Status code of the response

names string[]

A list of partition names

PartitionListResponse

code int32

Possible values: [0]

Status code of the response

partitions

object[]

A list of partitions

Array [

oneOf

IdentityPartition

type stringrequired

Possible values: [identity]

name Name (string)

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 Name (string)required

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 Name (string)required

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)

{}

PartitionNameListResponse

{
  "code": 0,
  "names": [
    "p1",
    "p2"
  ]
}

PartitionListResponse

{
  "code": 0,
  "partitions": [
    {
      "type": "identity",
      "name": "p1",
      "fieldNames": [
        [
          "col1"
        ]
      ],
      "values": [
        {
          "type": "literal",
          "dataType": "string",
          "value": "v1"
        }
      ],
      "properties": {}
    },
    {
      "type": "identity",
      "name": "p2",
      "fieldNames": [
        [
          "col1"
        ]
      ],
      "values": [
        {
          "type": "literal",
          "dataType": "string",
          "value": "v2"
        }
      ],
      "properties": {}
    }
  ]
}

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/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": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

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