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 string

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

A map of partition names to their statistics (which is a map of statistic names to their values)

property name*

object

property name* any

Example (from schema)

{
  "code": 0,
  "partitionStatistics": {}
}

PartitionStatisticsListResponse

{
  "code": 0,
  "partitionStatistics": {
    "2023-10-01": {
      "row_count": "500",
      "file_size": "250MB"
    },
    "2023-10-02": {
      "row_count": "600",
      "file_size": "300MB"
    }
  }
}

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