<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Apache Polaris

Apache Polaris™ is an open-source, fully-featured catalog for Apache Iceberg™. It implements Iceberg's REST API, enabling seamless multi-engine interoperability across a wide range of platforms, including Apache Doris™, Apache Flink®, Apache Spark™, Dremio® OSS, StarRocks, and Trino.

Documentation is available at https://polaris.apache.org. The REST OpenAPI specifications are available here: Polaris management API doc and Polaris Catalog API doc.

Subscribe to the dev mailing list to join discussions via email or browse the archives. Check out the CONTRIBUTING guide for contribution guidelines.

Polaris Overview

Click here for a quick overview of Polaris.

Quickstart

Click here for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.

Project Structure

Apache Polaris is organized into the following modules:

• Primary modules:
  • polaris-core - The main Polaris entity definitions and core business logic
  • API modules - Build scripts for generating Java classes from the OpenAPI specifications:
  • polaris-api-management-model - Polaris Management API model classes
  • polaris-api-management-service - Polaris Management API service classes
  • polaris-api-iceberg-service - The Iceberg REST service classes
  • polaris-api-catalog-service - The Polaris Catalog API service classes
  • Runtime modules:
    • polaris-admin - The Polaris Admin Tool; mainly for bootstrapping persistence
    • polaris-runtime-defaults - The runtime configuration defaults
    • polaris-distribution - The Polaris distribution
    • polaris-server - The Polaris Quarkus Server
    • polaris-runtime-service - The package containing the Polaris service.
    • polaris-runtime-spark-tests - Integration tests for the Polaris Spark plugin
    • polaris-runtime-test-common - Test utilities
  • Persistence modules:
    • polaris-relational-jdbc - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager
  • Extensions modules:
    • polaris-extensions-federation-hadoop - The Hadoop federation extension
    • polaris-extensions-federation-hive - The Hive federation extension
• Secondary modules:
  • agregated-license-report - Generates the aggregated license report
  • polaris-bom - The Bill of Materials (BOM) for Polaris
  • polaris-build-logic - Establishes consistent build logic
  • polaris-tests - Normative integration tests for reuse in downstream projects
• Tool modules:
  • Documentation configuration:
    • polaris-config-docs-annotations - Annotations for documentation generator
    • polaris-config-docs-generator - Generates Polaris reference docs
    • polaris-config-docs-site - The configuration documentation site
  • Other Tools:
    • polaris-container-spec-helper - Helper for container specifications
    • polaris-immutables - Predefined Immutables configuration & annotations for Polaris
    • polaris-minio-testcontainer - Minio test container
    • polaris-rustfs-testcontainer - RustFS test container
    • polaris-misc-types - Miscellaneous types for Polaris
    • polaris-version - Versioning for Polaris

In addition to modules, there are:

• API specifications - The OpenAPI specifications
• Python client - The Python client
• codestyle - The code style guidelines
• getting-started - A collection of getting started examples
• gradle - The Gradle wrapper and Gradle configuration files including banned dependencies
• helm - The Helm charts for Polaris.
• Spark Plugin - The Polaris Spark plugin
• regtests - Regression tests
• server-templates - OpenAPI Generator templates to generate the server code
• site - The Polaris website

Outside of this repository, there are several other tools that can be found in a separate Polaris-Tools repository.

Building and Running

Apache Polaris is built using Gradle with Java 21+ and Docker 27+.

• ./gradlew build - To build and run tests. Make sure Docker is running, as the integration tests depend on it.
• ./gradlew assemble - To skip tests.
• ./gradlew check - To run all checks, including unit tests and integration tests.
• ./gradlew run - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property ./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret where:
  • POLARIS is the realm
  • root is the CLIENT_ID
  • secret is the CLIENT_SECRET
  • If credentials are not set, it will use preset credentials POLARIS,root,s3cr3t
• ./regtests/run_spark_sql.sh - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell:

create database db1;
show databases;
create table db1.table1 (id int, name string);
insert into db1.table1 values (1, 'a');
select * from db1.table1;

• env POLARIS_HOST=localhost ./regtests/run.sh - To run regression tests locally, see more options here.

Makefile Convenience Commands

To streamline the developer experience, especially for common setup and build tasks, a root-level Makefile is available. This Makefile acts as a convenient wrapper around various Gradle commands and other tooling, simplifying interactions. While Gradle remains the primary build system, the Makefile provides concise shortcuts for frequent operations like:

• Building Polaris components: e.g., make build-server, make build-admin
• Managing development clusters: e.g., make minikube-start-cluster, make minikube-cleanup
• Automating Helm tasks: e.g., make helm-doc-generate, make helm-unittest
• Handling dependencies: e.g., make install-dependencies-brew
• Managing client operations: e.g., make client-lint, make client-regenerate

To see available commands:

make help

For example, to build the Polaris server and its container image, you can simply run:

make build-server

More build and run options

Running in Docker

• To build the image locally:

  ./gradlew \
    :polaris-server:assemble \
    :polaris-server:quarkusAppPartsBuild --rerun \
    -Dquarkus.container-image.build=true
  

• docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest - To run the image.

The Polaris codebase contains some docker compose examples to quickly get started with Polaris, using different configurations. Check the ./getting-started directory for more information.

Running in Kubernetes

• See README in helm/polaris for more information.

Configuring Polaris

Polaris Servers can be configured using a variety of ways. Please see the Configuration Guide for more information.

Default configuration values can be found in runtime/defaults/src/main/resources/application.properties.

Building docs

• Docs are generated using Hugo using the Docsy theme.
• To view the site locally, run

  site/bin/run-hugo-in-docker.sh
  

• See README in site/ for more information.

Publishing Build Scans to develocity.apache.org

Build scans of CI builds from a branch or tag in the apache/polaris repository on GitHub publish build scans to the ASF Develocity instance at [develocity.apache.org](https://develocity.apache