Package org.apache.iceberg.spark.source

Interface HasIcebergCatalog

All Superinterfaces:
org.apache.spark.sql.connector.catalog.CatalogPlugin, org.apache.spark.sql.connector.catalog.TableCatalog
All Known Implementing Classes:
SparkCatalog, SparkSessionCatalog
public interface HasIcebergCatalog extends org.apache.spark.sql.connector.catalog.TableCatalog

  • Field Summary

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

    OPTION_PREFIX, PROP_COLLATION, PROP_COMMENT, PROP_EXTERNAL, PROP_IS_MANAGED_LOCATION, PROP_LOCATION, PROP_OWNER, PROP_PROVIDER, PROP_TABLE_TYPE

  • Method Summary

    Modifier and Type
    Method
    Description
    Catalog
    icebergCatalog()
    Returns the underlying Catalog backing this Spark Catalog
    default TableIdentifier
    icebergIdentifier(org.apache.spark.sql.connector.catalog.Identifier identifier)
    Converts a Spark identifier to the identifier used by the underlying Iceberg catalog.
    default ViewCatalog
    icebergViewCatalog()
    Returns the underlying Iceberg view catalog backing this Spark Catalog.

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

    defaultNamespace, initialize, name

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

    alterTable, capabilities, createTable, createTable, createTable, createTableLike, dropTable, invalidateTable, listTables, listTableSummaries, loadChangelog, loadTable, loadTable, loadTable, loadTable, purgeTable, renameTable, tableExists, useNullableQuerySchema

  • Method Details

    • icebergCatalog

      Catalog icebergCatalog()
      Returns the underlying Catalog backing this Spark Catalog

    • icebergIdentifier

      default TableIdentifier icebergIdentifier(org.apache.spark.sql.connector.catalog.Identifier identifier)
      Converts a Spark identifier to the identifier used by the underlying Iceberg catalog.
      Parameters:
      identifier - a Spark identifier
      Returns:
      the corresponding Iceberg identifier

    • icebergViewCatalog

      default ViewCatalog icebergViewCatalog()
      Returns the underlying Iceberg view catalog backing this Spark Catalog.
      Returns:
      an Iceberg view catalog, or null if the catalog does not support views