org.apache.spark.sql.connector.catalog

Interface CatalogExtension

All Superinterfaces:

CatalogPlugin, SupportsNamespaces, TableCatalog

All Known Implementing Classes:

DelegatingCatalogExtension

@Experimental
public interface CatalogExtension
extends TableCatalog, SupportsNamespaces

An API to extend the Spark built-in session catalog. Implementation can get the built-in session catalog from setDelegateCatalog(CatalogPlugin), implement catalog functions with some custom logic and call the built-in session catalog at the end. For example, they can implement createTable, do something else before calling createTable of the built-in session catalog.

Field Summary

Fields inherited from interface org.apache.spark.sql.connector.catalog.TableCatalog

PROP_COMMENT, PROP_LOCATION, PROP_PROVIDER, RESERVED_PROPERTIES

Fields inherited from interface org.apache.spark.sql.connector.catalog.SupportsNamespaces

PROP_COMMENT, PROP_LOCATION, PROP_OWNER_NAME, PROP_OWNER_TYPE, RESERVED_PROPERTIES

Method Summary

Modifier and Type	Method and Description
void	setDelegateCatalog(CatalogPlugin delegate) This will be called only once by Spark to pass in the Spark built-in session catalog, after CatalogPlugin.initialize(String, CaseInsensitiveStringMap) is called.

Methods inherited from interface org.apache.spark.sql.connector.catalog.TableCatalog

alterTable, createTable, dropTable, invalidateTable, listTables, loadTable, renameTable, tableExists

Methods inherited from interface org.apache.spark.sql.connector.catalog.SupportsNamespaces

alterNamespace, createNamespace, defaultNamespace, dropNamespace, listNamespaces, listNamespaces, loadNamespaceMetadata, namespaceExists

Methods inherited from interface org.apache.spark.sql.connector.catalog.CatalogPlugin

initialize, name

Method Detail

setDelegateCatalog

void setDelegateCatalog(CatalogPlugin delegate)

This will be called only once by Spark to pass in the Spark built-in session catalog, after CatalogPlugin.initialize(String, CaseInsensitiveStringMap) is called.