List partition statistics

GET 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/statistics/partitions

List partition statistics

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

Possible values: [METALAKE, CATALOG, SCHEMA, TABLE, COLUMN, FILESET, TOPIC, MODEL, ROLE]

The type of the metadata object

metadataObjectFullName stringrequired

The full name of the metadata object

Query Parameters

from string

The lower partition name

to string

The upper partition name

fromInclusive boolean

Whether the lower partition name is inclusive

toInclusive boolean

Whether the upper partition name is inclusive

Responses

200

Returns the partition statistics for the specified metadata object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

partitionStatistics

object[]

The list of partition statistics results

Array [

partitionName stringrequired

The name of the partition

statistics

object[]

required

Array [

name stringrequired

The name of the statistic

value

object

The value of the statistic

oneOf

MOD1

string

MOD2

number

MOD3

integer

MOD4

boolean

MOD5

Array [

]

MOD6

property name* any

reserved booleanrequired

Whether the statistic is reserved

modifiable booleanrequired

Whether the statistic is modifiable

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,
  "partitionStatistics": [
    {
      "partitionName": "string",
      "statistics": [
        {
          "name": "string",
          "value": "string",
          "reserved": true,
          "modifiable": true,
          "audit": {
            "creator": "string",
            "createTime": "2024-07-29T15:51:28.071Z",
            "lastModifier": "string",
            "lastModifiedTime": "2024-07-29T15:51:28.071Z"
          }
        }
      ]
    }
  ]
}

PartitionStatisticsListResponse

{
  "code": 0,
  "partitionStatistics": [
    {
      "partitionName": "p0",
      "statistics": [
        {
          "name": "row_count",
          "value": "1000",
          "reserved": true,
          "modifiable": false,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        },
        {
          "name": "file_size",
          "value": "500MB",
          "reserved": true,
          "modifiable": false,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        },
        {
          "name": "custom-k1",
          "value": "v1",
          "reserved": false,
          "modifiable": true,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        }
      ]
    },
    {
      "partitionName": "p1",
      "statistics": [
        {
          "name": "row_count",
          "value": "2000",
          "reserved": true,
          "modifiable": false,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        },
        {
          "name": "file_size",
          "value": "1GB",
          "reserved": true,
          "modifiable": false,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        },
        {
          "name": "custom-k1",
          "value": "v2",
          "reserved": false,
          "modifiable": true,
          "audit": {
            "creator": "user1",
            "createTime": "2023-10-01T12:00:00Z",
            "lastModifier": "user2",
            "lastModifiedTime": "2023-10-02T12:00:00Z"
          }
        }
      ]
    }
  ]
}

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

404

Not Found - The specified metadata object doesn't 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"
  ]
}

NoSuchMetadataObjectException

{
  "code": 1003,
  "type": "NoSuchMetadataObjectException",
  "message": "Metadata object does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetadataObjectException: Metadata object 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...