TableCatalog¶

TableCatalog is an extension of the CatalogPlugin abstraction for table catalogs.

Contract¶

alterTable¶

Table alterTable(
  Identifier ident,
  TableChange... changes)

TableChanges to alter a table

Used when:

• AlterTableExec physical command is executed

createTable¶

Table createTable(
  Identifier ident,
  StructType schema,
  Transform[] partitions,
  Map<String, String> properties)

Used when the following commands are executed:

• CreateTableExec
• ReplaceTableExec
• CreateTableAsSelectExec
• ReplaceTableAsSelectExec

dropTable¶

boolean dropTable(
  Identifier ident)

Used when the following commands are executed:

• DropTableExec
• ReplaceTableExec
• CreateTableAsSelectExec
• ReplaceTableAsSelectExec

invalidateTable¶

void invalidateTable(
  Identifier ident)

Used when the following commands are executed:

• RefreshTableExec
• RenameTableExec

Listing Tables¶

Identifier[] listTables(
  String[] namespace)

Used when the following commands are executed:

• DropNamespaceExec
• ShowTablesExec

Loading Table¶

Table loadTable(
  Identifier ident)

Used when:

• CatalogV2Util is requested to load a table
• DataFrameReader is requested to load (for SupportsCatalogOptions providers)
• DataFrameWriter is requested to save, insertInto and saveAsTable
• DelegatingCatalogExtension is requested to loadTable
• TableCatalog is requested to tableExists
• V2SessionCatalog is requested to createTable, alterTable, dropTable, renameTable

renameTable¶

void renameTable(
  Identifier oldIdent,
  Identifier newIdent)

Used when the following commands are executed:

• RenameTableExec

tableExists¶

boolean tableExists(
  Identifier ident)

Used when:

• The following commands are executed:
• AtomicCreateTableAsSelectExec
• AtomicReplaceTableAsSelectExec
• AtomicReplaceTableExec
• CreateTableAsSelectExec
• CreateTableExec
• DropTableExec
• ReplaceTableAsSelectExec

• ReplaceTableExec

• V2SessionCatalog is requested to renameTable

Implementations¶

• CatalogExtension
• StagingTableCatalog
• V2SessionCatalog