CatalogHelper¶

CatalogHelper is a Scala implicit class that adds extensions methods to CatalogPlugin.

Creating Instance¶

CatalogHelper takes the following to be created:

• CatalogPlugin

asNamespaceCatalog¶

asNamespaceCatalog: SupportsNamespaces

asNamespaceCatalog returns the CatalogPlugin if it is a SupportsNamespaces or throws an AnalysisException otherwise:

Cannot use catalog [name]: does not support namespaces

asNamespaceCatalog is used when:

• ResolveCatalogs logical resolution rule is executed
• DataSourceV2Strategy execution planning strategy is executed
• DropNamespaceExec physical command is executed

asTableCatalog¶

asTableCatalog: TableCatalog

asTableCatalog returns the CatalogPlugin if it is a TableCatalog or throws an AnalysisException otherwise:

Cannot use catalog [name]: not a TableCatalog

asTableCatalog is used when:

• ResolveTables, ResolveRelations, ResolveCatalogs and ResolveSessionCatalog logical resolution rules are executed
• CatalogV2Util utility is used to load a table, createAlterTable and getTableProviderCatalog
• DataFrameWriter is requested to insertInto and saveAsTable
• DataFrameWriterV2 is created
• DataSourceV2Strategy execution planning strategy is executed
• DropNamespaceExec physical command is executed