List partitions

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

Returns the names of the partitions of the table, or the full partitions when details is true.

Sign in with a bearer token or a local user's password; see Authentication.

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

When true, returns the full partition objects instead of their names

Responses

200

The names of the table's partitions, or the full partitions with their values and properties when details is true.

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

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as 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) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

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

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

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

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as 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) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

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

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

value stringrequired

The string format of the literal value

lower

object

required

type string

Possible values: [literal]

dataType

object

required

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as 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) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

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

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

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

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

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[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

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[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...