Getting Started with Apache Polaris on Apache Polaris

Quickstart

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

Use this guide to quickly start running Polaris. This is not intended for production use.

Prerequisites🔗

Have Docker (with Docker Compose v2) installed & running on your machine

Running🔗

Run the following command:

1curl -s https://raw.githubusercontent.com/apache/polaris/refs/heads/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - up

This command will:

Create a Catalog named quickstart_catalog with RustFS-backed storage.
Create a user principal quickstart_user with full access to the catalog.

Once the command has been run, you will see examples on how to interact with this Polaris server in the logs.

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 and extract the binary distribution:

1curl -L https://downloads.apache.org/incubator/polaris/1.4.1/polaris-bin-1.4.1.tgz | tar xz
2cd polaris-bin-1.3.0-incubating

Start the Polaris server:

1bin/server

The server will start and listen on http://localhost:8182. Health and metrics endpoints are available under /q.

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

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.