Skip to content
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.

Sign up for GitHub

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

Jump to bottom

How to query Iceberg topics using Snowflake and Open Catalog #957

Merged
merged 15 commits into from
Feb 7, 2025
Merged

How to query Iceberg topics using Snowflake and Open Catalog #957

merged 15 commits into from
Feb 7, 2025

Conversation

kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Jan 17, 2025 •
edited
Loading

Description

Add new guide for integrating Redpanda topics as Iceberg tables in Snowflake + Open Catalog.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 18 Feb

Page previews

Query Iceberg Topics using Snowflake and Open Catalog

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify Netlify
Copy link

netlify bot commented Jan 17, 2025 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 399f398
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67a68ffcc0b102000867b108
😎 Deploy Preview https://deploy-preview-957--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

kbatuigas
kbatuigas commented Jan 27, 2025
View reviewed changes
modules/manage/pages/redpanda-topics-iceberg-snowflake-catalog.adoc Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should "polaris" or "open" be part of the page URL? I guess wondering for SEO purposes

@kbatuigas kbatuigas marked this pull request as ready for review February 7, 2025 18:03
@kbatuigas kbatuigas requested a review from a team as a code owner February 7, 2025 18:03
@kbatuigas kbatuigas requested a review from andrwng February 7, 2025 19:01
Feediver1
Feediver1 reviewed Feb 7, 2025
View reviewed changes
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc Outdated
--
- `<snowflake-orgname>` and `<open-catalog-account-name>`: Your https://docs.snowflake.com/en/sql-reference/sql/create-catalog-integration-open-catalog#required-parameters[Open Catalog account URI] is composed of these values.
+
TIP: In Snowflake, navigate to **Admin**, then **Accounts**. Click **...** to the right of your Open Catalog account name, and select **Manage URLs**. The **Current URL** contains `<snowflake-orgname>` and `<open-catalog-account-name>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

hmmmm...I've always been told to not describe the location of elements in UIs, because if they are moved, then you have to update the doc. If they move the ellipsis, then this may be confusing. To avoid that possibility, maybe say "Click the ellipsis near your Open Catalog..."

Feediver1
Feediver1 reviewed Feb 7, 2025
View reviewed changes
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc Outdated
You should see the topic as a table in Open Catalog.

. In Open Catalog, select *Catalogs*, then open your catalog.
. Under your catalog, you should see the `redpanda` namespace, and a table with the name of your topic. The `redpanda` namespace and the table are automatically created for you.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. Under your catalog, you should see the `redpanda` namespace, and a table with the name of your topic. The `redpanda` namespace and the table are automatically created for you.
. Under your catalog, you should see the `redpanda` namespace, and a table with the name of your topic, which are automatically created for you.

Feediver1
Feediver1 approved these changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@Feediver1 Feediver1 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Wow, this is a complex setup. Thanks for testing the steps to ensure it works! I did not have time to test them given that I started this review late on a Friday. If you have gone through them successfully, great.
Despite the complexity of using other tools along with RP, this seems very clear and straightforward. Nice.
Try to avoid using future tense (per our Style Guide: Avoid using future tense, such as "will". Especially avoid the use of future and passive used in tandem, such as "will not be".).
Also, if the user must absolutely do something, just say so. Otherwise, some readers might interpret as a suggestion. Great job @kbatuigas !

@kbatuigas kbatuigas merged commit 1ca009e into main Feb 7, 2025
7 checks passed
@kbatuigas kbatuigas deleted the DOC-898-Iceberg-Snowflake-Open-Catalog-doc branch February 7, 2025 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrwng andrwng andrwng approved these changes

@Feediver1 Feediver1 Feediver1 approved these changes

@mattschumpert mattschumpert Awaiting requested review from mattschumpert

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kbatuigas @andrwng @Feediver1