-
Notifications
You must be signed in to change notification settings - Fork 3k
Allow loading custom Catalog implementation in Spark and Flink #1640
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
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions
28
core/src/main/java/org/apache/iceberg/CatalogProperties.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,28 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| public class CatalogProperties { | ||
|
|
||
| private CatalogProperties() { | ||
| } | ||
|
|
||
| public static final String CATALOG_IMPL = "catalog-impl"; | ||
| } |
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
216 changes: 216 additions & 0 deletions
216
core/src/test/java/org/apache/iceberg/TestCatalogUtil.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,216 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.apache.hadoop.conf.Configurable; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.iceberg.catalog.Catalog; | ||
| import org.apache.iceberg.catalog.Namespace; | ||
| import org.apache.iceberg.catalog.TableIdentifier; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| public class TestCatalogUtil { | ||
|
|
||
| @Test | ||
| public void loadCustomCatalog() { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put("key", "val"); | ||
| Configuration hadoopConf = new Configuration(); | ||
| String name = "custom"; | ||
| Catalog catalog = CatalogUtil.loadCatalog(TestCatalog.class.getName(), name, options, hadoopConf); | ||
| Assert.assertTrue(catalog instanceof TestCatalog); | ||
| Assert.assertEquals(name, ((TestCatalog) catalog).catalogName); | ||
| Assert.assertEquals(options, ((TestCatalog) catalog).flinkOptions); | ||
| } | ||
|
|
||
| @Test | ||
| public void loadCustomCatalog_withHadoopConfig() { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put("key", "val"); | ||
| Configuration hadoopConf = new Configuration(); | ||
| hadoopConf.set("key", "val"); | ||
| String name = "custom"; | ||
| Catalog catalog = CatalogUtil.loadCatalog(TestCatalogConfigurable.class.getName(), name, options, hadoopConf); | ||
| Assert.assertTrue(catalog instanceof TestCatalogConfigurable); | ||
| Assert.assertEquals(name, ((TestCatalogConfigurable) catalog).catalogName); | ||
| Assert.assertEquals(options, ((TestCatalogConfigurable) catalog).flinkOptions); | ||
| Assert.assertEquals(hadoopConf, ((TestCatalogConfigurable) catalog).configuration); | ||
| } | ||
|
|
||
| @Test | ||
| public void loadCustomCatalog_NoArgConstructorNotFound() { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put("key", "val"); | ||
| Configuration hadoopConf = new Configuration(); | ||
| String name = "custom"; | ||
| AssertHelpers.assertThrows("must have no-arg constructor", | ||
| IllegalArgumentException.class, | ||
| "missing no-arg constructor", | ||
| () -> CatalogUtil.loadCatalog(TestCatalogBadConstructor.class.getName(), name, options, hadoopConf)); | ||
| } | ||
|
|
||
| @Test | ||
| public void loadCustomCatalog_NotImplementCatalog() { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put("key", "val"); | ||
| Configuration hadoopConf = new Configuration(); | ||
| String name = "custom"; | ||
|
|
||
| AssertHelpers.assertThrows("must implement catalog", | ||
| IllegalArgumentException.class, | ||
| "does not implement Catalog", | ||
| () -> CatalogUtil.loadCatalog(TestCatalogNoInterface.class.getName(), name, options, hadoopConf)); | ||
| } | ||
|
|
||
| public static class TestCatalog extends BaseMetastoreCatalog { | ||
|
|
||
| private String catalogName; | ||
| private Map<String, String> flinkOptions; | ||
|
|
||
| public TestCatalog() { | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize(String name, Map<String, String> properties) { | ||
| this.catalogName = name; | ||
| this.flinkOptions = properties; | ||
| } | ||
|
|
||
| @Override | ||
| protected TableOperations newTableOps(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| protected String defaultWarehouseLocation(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public List<TableIdentifier> listTables(Namespace namespace) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean dropTable(TableIdentifier identifier, boolean purge) { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void renameTable(TableIdentifier from, TableIdentifier to) { | ||
|
|
||
| } | ||
| } | ||
|
|
||
| public static class TestCatalogConfigurable extends BaseMetastoreCatalog implements Configurable { | ||
|
|
||
| private String catalogName; | ||
| private Map<String, String> flinkOptions; | ||
| private Configuration configuration; | ||
|
|
||
| public TestCatalogConfigurable() { | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize(String name, Map<String, String> properties) { | ||
| this.catalogName = name; | ||
| this.flinkOptions = properties; | ||
| } | ||
|
|
||
| @Override | ||
| public void setConf(Configuration conf) { | ||
| this.configuration = conf; | ||
| } | ||
|
|
||
| @Override | ||
| public Configuration getConf() { | ||
| return configuration; | ||
| } | ||
|
|
||
| @Override | ||
| protected TableOperations newTableOps(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| protected String defaultWarehouseLocation(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public List<TableIdentifier> listTables(Namespace namespace) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean dropTable(TableIdentifier identifier, boolean purge) { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void renameTable(TableIdentifier from, TableIdentifier to) { | ||
|
|
||
| } | ||
| } | ||
|
|
||
| public static class TestCatalogBadConstructor extends BaseMetastoreCatalog { | ||
|
|
||
| public TestCatalogBadConstructor(String arg) { | ||
| } | ||
|
|
||
| @Override | ||
| protected TableOperations newTableOps(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| protected String defaultWarehouseLocation(TableIdentifier tableIdentifier) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public List<TableIdentifier> listTables(Namespace namespace) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean dropTable(TableIdentifier identifier, boolean purge) { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void renameTable(TableIdentifier from, TableIdentifier to) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void initialize(String name, Map<String, String> properties) { | ||
| } | ||
| } | ||
|
|
||
| public static class TestCatalogNoInterface { | ||
| public TestCatalogNoInterface() { | ||
| } | ||
| } | ||
| } |
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
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.