gravitino.client.gravitino_client_base.GravitinoClientBase

class gravitino.client.gravitino_client_base.GravitinoClientBase(uri: str, check_version: bool = True, auth_data_provider: AuthDataProvider | None = None)

Bases: object

Base class for Gravitino Java client; It uses an underlying {@link RESTClient} to send HTTP requests and receive responses from the API.

__init__(uri: str, check_version: bool = True, auth_data_provider: AuthDataProvider | None = None)

Methods

__init__(uri[, check_version, ...])
check_metalake_name(metalake_name)
check_version()	Check the compatibility of the client with the target server.
close()	Closes the GravitinoClient and releases any underlying resources.
get_client_version()	Retrieves the version of the Gravitino Python Client.
get_server_version()	Retrieves the version of the Gravitino API.
load_metalake(name)	Loads a specific Metalake from the Gravitino API.

Attributes

API_METALAKES_IDENTIFIER_PATH	The REST API path prefix for load a specific metalake
API_METALAKES_LIST_PATH	The REST API path for listing metalakes

API_METALAKES_IDENTIFIER_PATH = 'api/metalakes/'

The REST API path prefix for load a specific metalake

API_METALAKES_LIST_PATH = 'api/metalakes'

The REST API path for listing metalakes

check_version()

Check the compatibility of the client with the target server.

Raises:

GravitinoRuntimeException If the client version is greater than the server version.

close()

Closes the GravitinoClient and releases any underlying resources.

get_client_version() → GravitinoVersion

Retrieves the version of the Gravitino Python Client.

Returns:

A GravitinoVersion instance representing the version of the Gravitino Python Client.

get_server_version() → GravitinoVersion

Retrieves the version of the Gravitino API.

Returns:

A GravitinoVersion instance representing the version of the Gravitino API.

load_metalake(name: str) → GravitinoMetalake

Loads a specific Metalake from the Gravitino API.

Args:

name: The name of the Metalake to be loaded.

Returns:

A GravitinoMetalake instance representing the loaded Metalake.

Raises:

NoSuchMetalakeException If the specified Metalake does not exist.