-
Notifications
You must be signed in to change notification settings - Fork 448
Create Polaris Data Catalog Setup Guide #5602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
amychen1776
wants to merge
5
commits into
main
Choose a base branch
from
polaris
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+108
−2
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6cd5ad0
add in first draft of Polaris doc
amychen1776 0669f1e
Update docs/use-cases/data_lake/polaris.md
amychen1776 94f6d07
Update docs/use-cases/data_lake/polaris.md
amychen1776 0c0a1ed
add in </VerticalStepper>
amychen1776 f022373
removing whitespaces
dhtclk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| slug: /use-cases/data-lake/polaris-catalog | ||
| sidebar_label: 'Polaris catalog' | ||
| title: 'Polaris catalog' | ||
| pagination_prev: null | ||
| pagination_next: null | ||
| description: 'In this guide, we will walk you through the steps to query | ||
| your data using ClickHouse and the Snowflake Polaris catalog.' | ||
| keywords: ['Polaris', 'Snowflake', 'Data Lake'] | ||
| show_related_blogs: true | ||
| doc_type: 'guide' | ||
| --- | ||
|
|
||
| import BetaBadge from '@theme/badges/BetaBadge'; | ||
|
|
||
| <BetaBadge/> | ||
|
|
||
| ClickHouse supports integration with multiple catalogs (Unity, Glue, Polaris, | ||
| etc.). In this guide, we will walk you through the steps to query your data | ||
| using ClickHouse and the [Apache Polaris Catalog](https://polaris.apache.org/releases/1.1.0/getting-started/using-polaris/#setup). | ||
| Apache Polaris supports Iceberg tables and Delta Tables (via Generic Tables). This integration only supports Iceberg tables at this time. | ||
|
|
||
| :::note | ||
| As this feature is experimental, you will need to enable it using: | ||
| `SET allow_experimental_database_unity_catalog = 1;` | ||
| ::: | ||
|
|
||
| ## Prerequisites {#prerequisites} | ||
|
|
||
| To connect to the Polaris catalog, you will need: | ||
|
|
||
| - Snowflake Open Catalog (hosted Polaris) or self-hosted Polaris Catalog | ||
| - Your Polaris catalog URI (for example, `https://<account-id>.<region>.aws.snowflakecomputing.com/polaris/api/catalog/v1` or `http://polaris:8181/api/catalog/v1/oauth/tokens`) | ||
| - Catalog credentials (client ID and client secret) | ||
| - The OAuth tokens URI for your Polaris instance | ||
| - Storage endpoint for the object store where your Iceberg data lives (for example, S3) | ||
| - ClickHouse version 26.1+ | ||
|
|
||
| For Open Catalog, Snowflake's managed Polaris offering, your URI will include `/polaris` while for self-hosted, it may not. | ||
|
|
||
| <VerticalStepper> | ||
|
|
||
| ## Creating a connection between Polaris and ClickHouse {#connecting} | ||
|
|
||
| Create a database that connects ClickHouse to your Polaris catalog: | ||
|
|
||
| ```sql | ||
| CREATE DATABASE polaris_catalog | ||
| ENGINE = DataLakeCatalog('https://<catalog_uri>/api/catalog/v1') | ||
| SETTINGS | ||
| catalog_type = 'rest', | ||
| catalog_credential = '<client-id>:<client-secret>', | ||
| warehouse = 'snowflake', | ||
| auth_scope = 'PRINCIPAL_ROLE:ALL', | ||
| oauth_server_uri = 'https://<catalog_uri>/api/catalog/v1/oauth/tokens', | ||
| storage_endpoint = '<storage_endpoint>' | ||
| ``` | ||
|
|
||
| ## Query the Polaris catalog using ClickHouse {#query-polaris-catalog} | ||
|
|
||
| Once the connection is in place, you can query Polaris: | ||
|
|
||
| ```sql title="Query" | ||
| USE polaris_catalog; | ||
| SHOW TABLES; | ||
| ``` | ||
|
|
||
| To query a table: | ||
|
|
||
| ```sql title="Query" | ||
| SELECT count(*) FROM `polaris_db.my_iceberg_table`; | ||
| ``` | ||
|
|
||
| :::note | ||
| Backticks are required, for example, `schema.table`. | ||
| ::: | ||
|
|
||
| To inspect the table DDL: | ||
|
|
||
| ```sql | ||
| SHOW CREATE TABLE `polaris_db.my_iceberg_table`; | ||
| ``` | ||
|
|
||
| ## Loading data from Polaris into ClickHouse {#loading-data-into-clickhouse} | ||
|
|
||
| To load data from Polaris into a ClickHouse table, create the target table with your desired schema, then insert from the Polaris table: | ||
|
|
||
| ```sql title="Query" | ||
| CREATE TABLE my_clickhouse_table | ||
| ( | ||
| -- define columns to match your Iceberg table | ||
| `id` Int64, | ||
| `name` String, | ||
| `event_time` DateTime64(3) | ||
| ) | ||
| ENGINE = MergeTree | ||
| ORDER BY id; | ||
|
|
||
| INSERT INTO my_clickhouse_table | ||
| SELECT * FROM polaris_catalog.`polaris_db.my_iceberg_table`; | ||
| ``` | ||
| </VerticalStepper> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.