Update statistics

PUT 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/statistics

Sets the values of the given statistics on a table, creating any that do not exist yet. Each statistic name must start with custom- and be at most 128 characters long.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

Possible values: [TABLE]

The type of the metadata object. Statistics are supported for tables only; any other type fails with IllegalArgumentException. The server matches the value case-insensitively.

metadataObjectFullName stringrequired

The full name of the metadata object

application/json

Body

updates

object

required

The statistics to update for each partition

property name* any

The statistics to update for each partition

Responses

200

The operation succeeded. The body carries only code, which is 0.

application/vnd.gravitino.v1+json

Schema

Schema

code int32required

Possible values: [0]

Status code of the response

Example (from schema)

{
  "code": 0
}

Example

{
  "code": 0
}

400

The object is not a table, the request body is invalid, or a statistic name does not start with custom- or is longer than 128 characters.

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

IllegalStatisticNameException

{
  "code": 1001,
  "type": "IllegalStatisticNameException",
  "message": "Custom statistic name must start with 'custom-'",
  "stack": [
    "org.apache.gravitino.exceptions.IllegalStatisticNameException: Custom statistic name must start with 'custom-'",
    "..."
  ]
}

404

The metalake or the metadata object 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[]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"
}

NoSuchMetadataObjectException

{
  "code": 1003,
  "type": "NoSuchMetadataObjectException",
  "message": "Metadata object does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetadataObjectException: Metadata object does not exist",
    "..."
  ]
}

409

One of the named statistics cannot be modified.

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

UnmodifiableStatisticException

{
  "code": 1006,
  "type": "UnmodifiableStatisticException",
  "message": "Statistic is unmodifiable",
  "stack": [
    "org.apache.gravitino.exceptions.UnmodifiableStatisticException: Statistic is unmodifiable",
    "..."
  ]
}

501

The server's statistics storage does not support the requested operation.

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

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