[SPARK-28341][SQL] create a public API for V2SessionCatalog #25104
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 |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * 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.spark.sql.catalog.v2; | ||
|
|
||
| import org.apache.spark.annotation.Experimental; | ||
| import org.apache.spark.sql.util.CaseInsensitiveStringMap; | ||
|
|
||
| /** | ||
| * An API to extend the Spark built-in session catalog. Implementation can get the built-in session | ||
| * catalog from {@link #setDelegateCatalog(TableCatalog)}, implement catalog functions with | ||
| * some custom logic and call the built-in session catalog at the end. For example, they can | ||
| * implement {@code createTable}, do something else before calling {@code createTable} of the | ||
| * built-in session catalog. | ||
| */ | ||
| @Experimental | ||
| public interface CatalogExtension extends TableCatalog { | ||
|
|
||
| /** | ||
| * This will be called only once by Spark to pass in the Spark built-in session catalog, after | ||
| * {@link #initialize(String, CaseInsensitiveStringMap)} is called. | ||
| */ | ||
| void setDelegateCatalog(TableCatalog delegate); | ||
| } |
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,101 @@ | ||
| /* | ||
| * 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.spark.sql.catalog.v2; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import org.apache.spark.annotation.Experimental; | ||
| import org.apache.spark.sql.catalog.v2.expressions.Transform; | ||
| import org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException; | ||
| import org.apache.spark.sql.catalyst.analysis.NoSuchTableException; | ||
| import org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException; | ||
| import org.apache.spark.sql.sources.v2.Table; | ||
| import org.apache.spark.sql.types.StructType; | ||
| import org.apache.spark.sql.util.CaseInsensitiveStringMap; | ||
|
|
||
| /** | ||
| * A simple implementation of {@link CatalogExtension}, which implements all the catalog functions | ||
| * by calling the built-in session catalog directly. This is created for convenience, so that users | ||
| * only need to override some methods where they want to apply custom logic. For example, they can | ||
| * override {@code createTable}, do something else before calling {@code super.createTable}. | ||
| */ | ||
| @Experimental | ||
| public abstract class DelegatingCatalogExtension implements CatalogExtension { | ||
|
|
||
| private TableCatalog delegate; | ||
|
|
||
| public final void setDelegateCatalog(TableCatalog delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return delegate.name(); | ||
| } | ||
|
|
||
| @Override | ||
| public final void initialize(String name, CaseInsensitiveStringMap options) {} | ||
|
|
||
| @Override | ||
| public Identifier[] listTables(String[] namespace) throws NoSuchNamespaceException { | ||
| return delegate.listTables(namespace); | ||
| } | ||
|
|
||
| @Override | ||
| public Table loadTable(Identifier ident) throws NoSuchTableException { | ||
| return delegate.loadTable(ident); | ||
| } | ||
|
|
||
| @Override | ||
| public void invalidateTable(Identifier ident) { | ||
| delegate.invalidateTable(ident); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean tableExists(Identifier ident) { | ||
| return delegate.tableExists(ident); | ||
| } | ||
|
|
||
| @Override | ||
| public Table createTable( | ||
| Identifier ident, | ||
| StructType schema, | ||
| Transform[] partitions, | ||
| Map<String, String> properties) throws TableAlreadyExistsException, NoSuchNamespaceException { | ||
| return delegate.createTable(ident, schema, partitions, properties); | ||
| } | ||
|
|
||
| @Override | ||
| public Table alterTable( | ||
| Identifier ident, | ||
| TableChange... changes) throws NoSuchTableException { | ||
| return delegate.alterTable(ident, changes); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean dropTable(Identifier ident) { | ||
| return delegate.dropTable(ident); | ||
| } | ||
|
|
||
| @Override | ||
| public void renameTable( | ||
| Identifier oldIdent, | ||
| Identifier newIdent) throws NoSuchTableException, TableAlreadyExistsException { | ||
| delegate.renameTable(oldIdent, newIdent); | ||
| } | ||
| } |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brkyvz I agree with you that the logic was a bit confusing, so I refine it a little bit:
V2_SESSION_CATALOGis not set, return the default session catalogV2SessionCatalog.V2_SESSION_CATALOGis set, try to instantiate it, and return the default session catalog if we hit problems during instantiating.