-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Add new SnowflakeCatalog implementation to enable directly using Snowflake-managed Iceberg tables #6428
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
Merged
danielcweeks
merged 23 commits into
apache:master
from
Snowflake-Labs:snowflake-catalog-initial
Jan 14, 2023
Merged
Add new SnowflakeCatalog implementation to enable directly using Snowflake-managed Iceberg tables #6428
Changes from 4 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
5ad32b0
Initial read-only Snowflake Catalog implementation by @sfc-gh-mparmar…
sfc-gh-dhuo 930a3f0
Add JdbcSnowflakeClientTest using mocks (#2)
dennishuo 86b3d11
Merge branch 'main' into snowflake-catalog-initial
dennishuo 076a14a
Add test { useJUnitPlatform() } tuple to iceberg-snowflake for
dennishuo a7b5aa7
Extract versions into versions.props per PR review
dennishuo dd5255c
Misc test-related refactors per review suggestions
dennishuo 500b36b
Fix unsupported behaviors of loadNamedpaceMetadata and defaultWarehou…
dennishuo ad2c55f
Move TableIdentifier checks out of newTableOps into the
dennishuo 7f13674
Refactor out any Namespace-related business logic from the lower
dennishuo 58d258e
Finish migrating JdbcSnowflakeClientTest off any usage of org.junit.A…
dennishuo 0183129
Style refactorings from review comments, expanded and moved InMemoryF…
dennishuo ca6deab
Fix behavior of getNamespaceMetadata to throw when the namespace doesn't
dennishuo b3a2842
Move private constructor to top, add assertion to test case.
dennishuo 676d024
Define minimal ResultSetParser/QueryHarness classes to fully replace
dennishuo cc493d0
Update snowflake/src/main/java/org/apache/iceberg/snowflake/Snowflake…
dennishuo ce7e28c
Refactor style suggestions; remove debug-level logging, arguments in …
dennishuo 2729e64
Fix precondition messages, remove getConf()
dennishuo 4c1e79f
Clean up varargs.
dennishuo bc0c6ee
Make data members final, include rawJsonVal in toString for debuggabi…
dennishuo 8240d9e
Merge branch 'main' into snowflake-catalog-initial
dennishuo ebe5dd6
Combine some small test cases into roundtrip test cases, misc cleanup
dennishuo 9e9b9e6
Add comment for why a factory class is exposed for testing purposes.
dennishuo e8fee31
Merge remote-tracking branch 'origin/main' into snowflake-catalog-ini…
dennishuo 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,4 +81,6 @@ ALIYUN: | |
| GCP: | ||
| - gcp/**/* | ||
| DELL: | ||
| - dell/**/* | ||
| - dell/**/* | ||
| SNOWFLAKE: | ||
| - snowflake/**/* | ||
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
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
163 changes: 163 additions & 0 deletions
163
snowflake/src/main/java/org/apache/iceberg/snowflake/JdbcSnowflakeClient.java
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,163 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.iceberg.snowflake; | ||
|
|
||
| import java.sql.SQLException; | ||
| import java.util.List; | ||
| import org.apache.commons.dbutils.QueryRunner; | ||
| import org.apache.iceberg.catalog.Namespace; | ||
| import org.apache.iceberg.catalog.TableIdentifier; | ||
| import org.apache.iceberg.jdbc.JdbcClientPool; | ||
| import org.apache.iceberg.jdbc.UncheckedInterruptedException; | ||
| import org.apache.iceberg.jdbc.UncheckedSQLException; | ||
| import org.apache.iceberg.relocated.com.google.common.annotations.VisibleForTesting; | ||
| import org.apache.iceberg.snowflake.entities.SnowflakeSchema; | ||
| import org.apache.iceberg.snowflake.entities.SnowflakeTable; | ||
| import org.apache.iceberg.snowflake.entities.SnowflakeTableMetadata; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This implementation of SnowflakeClient builds on top of Snowflake's JDBC driver to interact with | ||
| * Snowflake's Iceberg-aware resource model. Despite using JDBC libraries, the resource model is | ||
| * derived from Snowflake's own first-class support for Iceberg tables as opposed to using an opaque | ||
| * JDBC layer to store Iceberg metadata itself in an Iceberg-agnostic database. | ||
| * | ||
| * <p>This thus differs from the JdbcCatalog in that Snowflake's service provides the source of | ||
|
danielcweeks marked this conversation as resolved.
Outdated
|
||
| * truth of Iceberg metadata, rather than serving as a storage layer for a client-defined Iceberg | ||
| * resource model. | ||
| */ | ||
| public class JdbcSnowflakeClient implements SnowflakeClient { | ||
|
danielcweeks marked this conversation as resolved.
Outdated
|
||
| public static final String EXPECTED_JDBC_IMPL = "net.snowflake.client.jdbc.SnowflakeDriver"; | ||
|
danielcweeks marked this conversation as resolved.
Outdated
|
||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(JdbcSnowflakeClient.class); | ||
|
danielcweeks marked this conversation as resolved.
Outdated
|
||
| private final JdbcClientPool connectionPool; | ||
| private QueryRunner queryRunner = new QueryRunner(true); | ||
|
danielcweeks marked this conversation as resolved.
Outdated
|
||
|
|
||
| JdbcSnowflakeClient(JdbcClientPool conn) { | ||
| connectionPool = conn; | ||
|
danielcweeks marked this conversation as resolved.
|
||
| } | ||
|
|
||
| @VisibleForTesting | ||
| void setQueryRunner(QueryRunner queryRunner) { | ||
| this.queryRunner = queryRunner; | ||
| } | ||
|
|
||
| @Override | ||
| public List<SnowflakeSchema> listSchemas(Namespace namespace) { | ||
| StringBuilder baseQuery = new StringBuilder("SHOW SCHEMAS"); | ||
| Object[] queryParams = null; | ||
| if (namespace == null || namespace.isEmpty()) { | ||
| // for empty or null namespace search for all schemas at account level where the user | ||
| // has access to list. | ||
| baseQuery.append(" IN ACCOUNT"); | ||
| } else { | ||
| // otherwise restrict listing of schema within the database. | ||
| baseQuery.append(" IN DATABASE IDENTIFIER(?)"); | ||
| queryParams = new Object[] {namespace.level(SnowflakeResources.NAMESPACE_DB_LEVEL - 1)}; | ||
| } | ||
|
|
||
| final String finalQuery = baseQuery.toString(); | ||
| final Object[] finalQueryParams = queryParams; | ||
| List<SnowflakeSchema> schemas; | ||
| try { | ||
| schemas = | ||
| connectionPool.run( | ||
| conn -> | ||
| queryRunner.query( | ||
| conn, finalQuery, SnowflakeSchema.createHandler(), finalQueryParams)); | ||
| } catch (SQLException e) { | ||
| throw new UncheckedSQLException( | ||
| e, | ||
| "Failed to list schemas for namespace %s", | ||
| namespace != null ? namespace.toString() : ""); | ||
| } catch (InterruptedException e) { | ||
| throw new UncheckedInterruptedException(e, "Interrupted while listing schemas"); | ||
| } | ||
| return schemas; | ||
| } | ||
|
|
||
| @Override | ||
| public List<SnowflakeTable> listIcebergTables(Namespace namespace) { | ||
| StringBuilder baseQuery = new StringBuilder("SHOW ICEBERG TABLES"); | ||
|
danielcweeks marked this conversation as resolved.
|
||
| Object[] queryParams = null; | ||
| if (namespace.length() == SnowflakeResources.MAX_NAMESPACE_DEPTH) { | ||
| // For two level namespace, search for iceberg tables within the given schema. | ||
| baseQuery.append(" IN SCHEMA IDENTIFIER(?)"); | ||
| queryParams = | ||
| new Object[] { | ||
| String.format( | ||
| "%s.%s", | ||
| namespace.level(SnowflakeResources.NAMESPACE_DB_LEVEL - 1), | ||
| namespace.level(SnowflakeResources.NAMESPACE_SCHEMA_LEVEL - 1)) | ||
| }; | ||
| } else if (namespace.length() == SnowflakeResources.NAMESPACE_DB_LEVEL) { | ||
| // For one level namespace, search for iceberg tables within the given database. | ||
| baseQuery.append(" IN DATABASE IDENTIFIER(?)"); | ||
| queryParams = new Object[] {namespace.level(SnowflakeResources.NAMESPACE_DB_LEVEL - 1)}; | ||
| } else { | ||
| // For empty or db level namespace, search at account level. | ||
| baseQuery.append(" IN ACCOUNT"); | ||
| } | ||
|
|
||
| final String finalQuery = baseQuery.toString(); | ||
| final Object[] finalQueryParams = queryParams; | ||
| List<SnowflakeTable> tables; | ||
| try { | ||
| tables = | ||
| connectionPool.run( | ||
| conn -> | ||
| queryRunner.query( | ||
| conn, finalQuery, SnowflakeTable.createHandler(), finalQueryParams)); | ||
| } catch (SQLException e) { | ||
| throw new UncheckedSQLException( | ||
| e, "Failed to list tables for namespace %s", namespace.toString()); | ||
| } catch (InterruptedException e) { | ||
| throw new UncheckedInterruptedException(e, "Interrupted while listing tables"); | ||
| } | ||
| return tables; | ||
| } | ||
|
|
||
| @Override | ||
| public SnowflakeTableMetadata getTableMetadata(TableIdentifier tableIdentifier) { | ||
| SnowflakeTableMetadata tableMeta; | ||
| try { | ||
| final String finalQuery = "SELECT SYSTEM$GET_ICEBERG_TABLE_INFORMATION(?) AS METADATA"; | ||
| tableMeta = | ||
| connectionPool.run( | ||
| conn -> | ||
| queryRunner.query( | ||
| conn, | ||
| finalQuery, | ||
| SnowflakeTableMetadata.createHandler(), | ||
| tableIdentifier.toString())); | ||
| } catch (SQLException e) { | ||
| throw new UncheckedSQLException( | ||
| e, "Failed to get table metadata for %s", tableIdentifier.toString()); | ||
| } catch (InterruptedException e) { | ||
| throw new UncheckedInterruptedException(e, "Interrupted while getting table metadata"); | ||
| } | ||
| return tableMeta; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| connectionPool.close(); | ||
|
danielcweeks marked this conversation as resolved.
|
||
| } | ||
| } | ||
Oops, something went wrong.
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.