Getting Started with Apache Polaris on Apache Polaris

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

Use the Quickstart guide for running Polaris locally with Docker Compose: prerequisites, the one-liner command, default catalog and principal, service URLs, and suggested next steps.

This setup is not intended for production use.

Setup Tools

Mon, 01 Jan 0001 00:00:00 +0000

This guide describes how to use the setup command to manage Apache Polaris configuration using an infrastructure-as-code approach. Define your Polaris configuration in a single YAML file and apply it with a single command.

The Polaris CLI can be installed from PyPI:

pip install apache-polaris

This command supports bootstrapping new environments and exporting existing configurations for reuse or version control.

Exporting Your Configuration🔗

If you already have an Apache Polaris environment, you can export its current state to a YAML file using the export subcommand:

Binary Distribution

Mon, 01 Jan 0001 00:00:00 +0000

Use this guide to quickly start running Polaris using the pre-built binary distribution.

Prerequisites🔗

Java SE 21 or later installed on your machine

Running🔗

Download the latest release and extract the binary distribution:

POLARIS_VERSION=1.6.0
curl -Lf https://downloads.apache.org/polaris/${POLARIS_VERSION}/polaris-bin-${POLARIS_VERSION}.tgz | tar xzf -
cd polaris-bin-${POLARIS_VERSION}

Start the Polaris server:

bin/server

The server will start and listen on http://localhost:8181 (main REST APIs) and http://localhost:8182 (management interface, for health checks and metrics).

Installing Dependencies

Mon, 01 Jan 0001 00:00:00 +0000

This guide serves as an introduction to several key entities that can be managed with Apache Polaris, describes how to build and deploy Polaris locally, and finally includes examples of how to use Polaris with Apache Spark™.

If you only need the Polaris CLI, you can install it without cloning the repository:

pip install apache-polaris

Prerequisites🔗

This guide covers building Polaris, deploying it locally or via Docker, and interacting with it using the command-line interface and Apache Spark. Before proceeding with Polaris, be sure to satisfy the relevant prerequisites listed here.