Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions 0.9.0/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ cascade:
params:
show_page_toc: true
# This file will NOT be copied into a new release's versioned docs folder.
robots: noindex
exclude_search: true
---

Check out the [Quick Start]({{% ref "quickstart" %}}) page to get started.
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Access Control
type: docs
weight: 500
robots: noindex
exclude_search: true
---

This section provides information about how access control works for Apache Polaris (Incubating).
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ linkTitle: Command Line Interface
title: Apache Polaris (Incubating) CLI
type: docs
weight: 300
robots: noindex
exclude_search: true
---

In order to help administrators quickly set up and manage their Polaris server, Polaris provides a simple command-line interface (CLI) for common tasks.
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/configuring-polaris-for-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Configuring Apache Polaris (Incubating) for Production
linkTitle: Deploying In Production
type: docs
weight: 600
robots: noindex
exclude_search: true
---

The default `polaris-server.yml` configuration is intended for development and testing. When deploying Polaris in production, there are several best practices to keep in mind.
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Entities
type: docs
weight: 400
robots: noindex
exclude_search: true
---

This page documents various entities that can be managed in Apache Polaris (Incubating).
Expand Down
4 changes: 3 additions & 1 deletion 0.9.0/metastores.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Metastores
linkTitle: Metastores
type: docs
weight: 700
robots: noindex
exclude_search: true
---

This page documents important configurations for connecting to production database through [EclipseLink](https://eclipse.dev/eclipselink/).
Expand Down Expand Up @@ -109,4 +111,4 @@ To build Polaris with the necessary Postgres dependency and start the Polaris se
```bash
polaris> ./gradlew --no-daemon --info -PeclipseLink=true -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 clean shadowJar
polaris> java -jar dropwizard/service/build/libs/polaris-dropwizard-service-*.jar server ./polaris-server.yml
```
```
2 changes: 2 additions & 0 deletions 0.9.0/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Overview
type: docs
weight: 200
robots: noindex
exclude_search: true
---

Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg™ tables and is built on the open source Apache Iceberg™ REST protocol.
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/polaris-management-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ linkTitle: 'Management OpenAPI'
weight: 800
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

<meta http-equiv="refresh" content="0; url=http://editor-next.swagger.io/?url=https://raw.githubusercontent.com/apache/polaris/refs/tags/apache-polaris-0.9.0-incubating/spec/polaris-management-service.yml" />
2 changes: 2 additions & 0 deletions 0.9.0/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Quick Start
type: docs
weight: 100
robots: noindex
exclude_search: true
---

This guide serves as a introduction to several key entities that can be managed with Apache Polaris (Incubating), describes how to build and deploy Polaris locally, and finally includes examples of how to use Polaris with Apache Spark&trade;.
Expand Down
2 changes: 2 additions & 0 deletions 0.9.0/rest-catalog-open-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ linkTitle: 'Iceberg OpenAPI'
weight: 900
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

<meta http-equiv="refresh" content="0; url=http://editor-next.swagger.io/?url=https://raw.githubusercontent.com/apache/polaris/refs/tags/apache-polaris-0.9.0-incubating/spec/rest-catalog-open-api.yaml" />
2 changes: 2 additions & 0 deletions 1.0.0/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ cascade:
params:
show_page_toc: true
# This file will NOT be copied into a new release's versioned docs folder.
robots: noindex
exclude_search: true
---

Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg&trade; tables and is built on the open source Apache Iceberg&trade; REST protocol.
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Access Control
type: docs
weight: 500
robots: noindex
exclude_search: true
---

This section provides information about how access control works for Apache Polaris (Incubating).
Expand Down
4 changes: 3 additions & 1 deletion 1.0.0/admin-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Admin Tool
type: docs
weight: 300
robots: noindex
exclude_search: true
---

Polaris includes a tool for administrators to manage the metastore.
Expand Down Expand Up @@ -139,4 +141,4 @@ For example, to purge the `realm1` realm, you can run the following command:

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar purge -r realm1
```
```
2 changes: 2 additions & 0 deletions 1.0.0/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Command Line Interface
type: docs
weight: 300
robots: noindex
exclude_search: true
---

In order to help administrators quickly set up and manage their Polaris server, Polaris provides a simple command-line interface (CLI) for common tasks.
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Configuring Polaris
type: docs
weight: 550
robots: noindex
exclude_search: true
---

## Overview
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/configuring-polaris-for-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Configuring Polaris for Production
linkTitle: Production Configuration
type: docs
weight: 600
robots: noindex
exclude_search: true
---

The default server configuration is intended for development and testing. When you deploy Polaris in production,
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Entities
type: docs
weight: 400
robots: noindex
exclude_search: true
---

This page documents various entities that can be managed in Apache Polaris (Incubating).
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/evolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Polaris Evolution
type: docs
weight: 1000
robots: noindex
exclude_search: true
---

This page discusses what can be expected from Apache Polaris as the project evolves.
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/generic-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Generic Table (Beta)
type: docs
weight: 435
robots: noindex
exclude_search: true
---

The Generic Table in Apache Polaris is designed to provide support for non-Iceberg tables across different table formats includes delta, csv etc. It currently provides the following capabilities:
Expand Down
4 changes: 3 additions & 1 deletion 1.0.0/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@
title: 'Getting Started'
type: docs
weight: 101
---
robots: noindex
exclude_search: true
---
4 changes: 3 additions & 1 deletion 1.0.0/getting-started/deploying-polaris/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@
Title: Deploying Polaris on Cloud Providers
type: docs
weight: 300
robots: noindex
exclude_search: true
---

We will now demonstrate how to deploy Polaris locally, as well as with all supported Cloud Providers: Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP).

Locally, Polaris can be deployed using both Docker and local build. On the cloud, this tutorial will deploy Polaris using Docker only - but local builds can also be executed.
Locally, Polaris can be deployed using both Docker and local build. On the cloud, this tutorial will deploy Polaris using Docker only - but local builds can also be executed.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Deploying Polaris on Amazon Web Services (AWS)
type: docs
weight: 310
robots: noindex
exclude_search: true
---

Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start an [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/) instance, which will be used as the backend Postgres instance holding all Polaris data.
Expand Down Expand Up @@ -54,4 +56,4 @@ export ASSETS_PATH=$(pwd)/getting-started/assets/
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
```

To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Deploying Polaris on Azure
type: docs
weight: 320
robots: noindex
exclude_search: true
---

Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start an [Azure Database for PostgreSQL - Flexible Server](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/overview) instance, which will be used as the backend Postgres instance holding all Polaris data.
Expand Down Expand Up @@ -49,4 +51,4 @@ export ASSETS_PATH=$(pwd)/getting-started/assets/
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
```

To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Deploying Polaris on Google Cloud Platform (GCP)
type: docs
weight: 330
robots: noindex
exclude_search: true
---

Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start a [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) instance, which will be used as the backend Postgres instance holding all Polaris data.
Expand Down Expand Up @@ -49,4 +51,4 @@ export ASSETS_PATH=$(pwd)/getting-started/assets/
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
```

To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.
4 changes: 3 additions & 1 deletion 1.0.0/getting-started/install-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Installing Dependencies
type: docs
weight: 100
robots: noindex
exclude_search: true
---

This guide serves as an introduction to several key entities that can be managed with Apache Polaris (Incubating), describes how to build and deploy Polaris locally, and finally includes examples of how to use Polaris with Apache Spark&trade;.
Expand Down Expand Up @@ -115,4 +117,4 @@ Ensure that `java --version` and `javac` both return non-zero responses.

## jq

Most Polaris Quickstart scripts require `jq`. Follow the instructions from the [jq](https://jqlang.org/download/) website to download this tool.
Most Polaris Quickstart scripts require `jq`. Follow the instructions from the [jq](https://jqlang.org/download/) website to download this tool.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the change here? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly something to be fixed in the tool? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Newline

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, a newline at the end of the file

4 changes: 3 additions & 1 deletion 1.0.0/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Quickstart
type: docs
weight: 200
robots: noindex
exclude_search: true
---

Polaris can be deployed via a docker image or as a standalone process. Before starting, be sure that you've satisfied the relevant prerequisites detailed in the previous page.
Expand Down Expand Up @@ -113,4 +115,4 @@ docker run --name trino -d -p 8080:8080 trinodb/trino
```

## Next Steps
Congrats, you now have a running instance of Polaris! For further information regarding how to use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page.
Congrats, you now have a running instance of Polaris! For further information regarding how to use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page.
2 changes: 2 additions & 0 deletions 1.0.0/getting-started/using-polaris.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Using Polaris
type: docs
weight: 400
robots: noindex
exclude_search: true
---

## Setup
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/metastores.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Metastores
type: docs
weight: 700
robots: noindex
exclude_search: true
---

This page explains how to configure and use Polaris metastores with either the recommended Relational JDBC or the
Expand Down
2 changes: 2 additions & 0 deletions 1.0.0/polaris-catalog-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ linkTitle: 'Catalog API Spec'
weight: 900
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

{{< redoc-polaris "generated/bundled-polaris-catalog-service.yaml" >}}
2 changes: 2 additions & 0 deletions 1.0.0/polaris-management-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ linkTitle: 'Management OpenAPI'
weight: 800
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

{{< redoc-polaris "polaris-management-service.yml" >}}
2 changes: 2 additions & 0 deletions 1.0.0/polaris-spark-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Polaris Spark Client
type: docs
weight: 650
robots: noindex
exclude_search: true
---

Apache Polaris now provides Catalog support for Generic Tables (non-Iceberg tables), please check out
Expand Down
4 changes: 3 additions & 1 deletion 1.0.0/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Policy
type: docs
weight: 425
robots: noindex
exclude_search: true
---

The Polaris Policy framework empowers organizations to centrally define, manage, and enforce fine-grained governance, lifecycle, and operational rules across all data resources in the catalog.
Expand Down Expand Up @@ -194,4 +196,4 @@ GET /polaris/v1/catalog/applicable-policies?namespace=finance%1Fquarterly&target

### API Reference

For the complete and up-to-date API specification, see the [policy-api.yaml](https://github.com/apache/polaris/blob/main/spec/polaris-catalog-apis/policy-apis.yaml).
For the complete and up-to-date API specification, see the [policy-api.yaml](https://github.com/apache/polaris/blob/main/spec/polaris-catalog-apis/policy-apis.yaml).
4 changes: 3 additions & 1 deletion 1.0.0/realm.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Realm
type: docs
weight: 350
robots: noindex
exclude_search: true
---

This page explains what a realm is and what it is used for in Polaris.
Expand Down Expand Up @@ -50,4 +52,4 @@ This ensures that each realm's data is stored separately.
authorization.

**Isolation:** In methods like `createEntityManagerFactory(@Nonnull RealmContext realmContext)` from `PolarisEclipseLinkPersistenceUnit` interface, the realm context influence how resources are created or managed based on the security policies of that realm.
An example of this is the way a realm name can be used to create a database connection url so that you have one database instance per realm, when applicable. Or it can be more granular and applied at primary key level (within the same database instance).
An example of this is the way a realm name can be used to create a database connection url so that you have one database instance per realm, when applicable. Or it can be more granular and applied at primary key level (within the same database instance).
4 changes: 3 additions & 1 deletion 1.0.0/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Telemetry
type: docs
weight: 450
robots: noindex
exclude_search: true
---

## Metrics
Expand Down Expand Up @@ -189,4 +191,4 @@ polaris.log.mdc.environment=prod
polaris.log.mdc.region=us-west-2
```

MDC context is propagated across threads, including in `TaskExecutor` threads.
MDC context is propagated across threads, including in `TaskExecutor` threads.
2 changes: 2 additions & 0 deletions 1.0.1/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ cascade:
params:
show_page_toc: true
# This file will NOT be copied into a new release's versioned docs folder.
robots: noindex
exclude_search: true
---

Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg&trade; tables and is built on the open source Apache Iceberg&trade; REST protocol.
Expand Down
2 changes: 2 additions & 0 deletions 1.0.1/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Access Control
type: docs
weight: 500
robots: noindex
exclude_search: true
---

This section provides information about how access control works for Apache Polaris (Incubating).
Expand Down
Loading