Skip to main content

Client access

Everything that talks to Gravitino reaches it through one of a small set of endpoints, and engines reach it through a connector or a client library. The UI gathers both in one place: the address of each endpoint the server runs, and the install coordinates for each connector and client, each with a link to its full page.

Quick Start

1. Copy the endpoint the client needs. Engines using a Gravitino connector and applications using a client library point at the Gravitino API. Engines speaking the Iceberg REST protocol point at the Iceberg REST endpoint instead.

2. Install the matching connector or client. Each has its own page with install and configuration steps.

3. Authenticate as the server expects. A client presents the same credentials as any other caller, so the server's authentication settings apply unchanged.

Endpoints

EndpointWhat Uses ItDetails
Gravitino APIThe UI, the Gravitino connectors, the Java and Python clients, and direct REST calls.Java client
Iceberg RESTAny engine with an Iceberg REST catalog client, with no Gravitino connector required.Iceberg REST catalog service
Lance RESTEngines and libraries reading and writing Lance tables.Lance REST service
SCIMIdentity providers pushing users and groups.SCIM provisioning

The Iceberg REST, Lance REST, and SCIM endpoints are auxiliary services on their own ports, and each runs only when enabled. An endpoint that is not enabled shows as such in the UI rather than with an address.

The addresses shown are the ones the server knows itself by. Behind an ingress or load balancer, clients outside the cluster use the external address instead.

Connectors and Clients

ClientUse It ForDetails
Trino connectorQuerying every catalog Gravitino manages from Trino.Trino connector
Spark connectorReading and writing Gravitino catalogs from Spark.Spark connector
Flink connectorReading and writing Gravitino catalogs from Flink.Flink connector
Python clientManaging metadata from Python.Python client
Java clientManaging metadata from Java.Java client

The UI shows the install coordinates for the version the server runs, so a connector installed from there matches the server.