Package org.apache.iceberg.gcp.bigquery

Class BigQueryMetastoreCatalog

java.lang.Object
org.apache.iceberg.BaseMetastoreCatalog
org.apache.iceberg.gcp.bigquery.BigQueryMetastoreCatalog
All Implemented Interfaces:
Closeable, AutoCloseable, Catalog, SupportsNamespaces, Configurable<Object>
public class BigQueryMetastoreCatalog extends BaseMetastoreCatalog implements SupportsNamespaces, Configurable<Object>
Iceberg Bigquery Metastore Catalog implementation.

  • Field Details

  • Constructor Details

    • BigQueryMetastoreCatalog

      public BigQueryMetastoreCatalog()

  • Method Details

    • initialize

      public void initialize(String name, Map<String,String> properties)
      Description copied from interface: Catalog
      Initialize a catalog given a custom name and a map of catalog properties.

      A custom Catalog implementation must have a no-arg constructor. A compute engine like Spark or Flink will first initialize the catalog without any arguments, and then call this method to complete catalog initialization with properties passed into the engine.

      Specified by:
      initialize in interface Catalog
      Parameters:
      name - a custom name for the catalog
      properties - catalog properties

    • newTableOps

      protected TableOperations newTableOps(TableIdentifier identifier)
      Specified by:
      newTableOps in class BaseMetastoreCatalog

    • defaultWarehouseLocation

      protected String defaultWarehouseLocation(TableIdentifier identifier)
      Specified by:
      defaultWarehouseLocation in class BaseMetastoreCatalog

    • listTables

      public List<TableIdentifier> listTables(Namespace namespace)
      Description copied from interface: Catalog
      Return all the identifiers under this namespace.
      Specified by:
      listTables in interface Catalog
      Parameters:
      namespace - a namespace
      Returns:
      a list of identifiers for tables

    • dropTable

      public boolean dropTable(TableIdentifier identifier, boolean purge)
      Description copied from interface: Catalog
      Drop a table; optionally delete data and metadata files.

      If purge is set to true the implementation should delete all data and metadata files.

      Specified by:
      dropTable in interface Catalog
      Parameters:
      identifier - a table identifier
      purge - if true, delete all data and metadata files in the table
      Returns:
      true if the table was dropped, false if the table did not exist

    • renameTable

      public void renameTable(TableIdentifier from, TableIdentifier to)
      Description copied from interface: Catalog
      Rename a table.
      Specified by:
      renameTable in interface Catalog
      Parameters:
      from - identifier of the table to rename
      to - new table name

    • createNamespace

      public void createNamespace(Namespace namespace, Map<String,String> metadata)
      Description copied from interface: SupportsNamespaces
      Create a namespace in the catalog.
      Specified by:
      createNamespace in interface SupportsNamespaces
      Parameters:
      namespace - a multi-part namespace
      metadata - a string Map of properties for the given namespace

    • listNamespaces

      public List<Namespace> listNamespaces()
      Description copied from interface: SupportsNamespaces
      List top-level namespaces from the catalog.

      If an object such as a table, view, or function exists, its parent namespaces must also exist and must be returned by this discovery method. For example, if table a.b.t exists, this method must return ["a"] in the result array.

      Specified by:
      listNamespaces in interface SupportsNamespaces
      Returns:
      a List of namespace Namespace names

    • listNamespaces

      public List<Namespace> listNamespaces(Namespace namespace)
      Since this catalog only supports one-level namespaces, it always returns an empty list unless passed an empty namespace to list all namespaces within the catalog.
      Specified by:
      listNamespaces in interface SupportsNamespaces
      Returns:
      a List of child Namespace names from the given namespace

    • dropNamespace

      public boolean dropNamespace(Namespace namespace)
      Description copied from interface: SupportsNamespaces
      Drop a namespace. If the namespace exists and was dropped, this will return true.
      Specified by:
      dropNamespace in interface SupportsNamespaces
      Parameters:
      namespace - a namespace. Namespace
      Returns:
      true if the namespace was dropped, false otherwise.

    • setProperties

      public boolean setProperties(Namespace namespace, Map<String,String> properties)
      Description copied from interface: SupportsNamespaces
      Set a collection of properties on a namespace in the catalog.

      Properties that are not in the given map are not modified or removed by this method.

      Specified by:
      setProperties in interface SupportsNamespaces
      Parameters:
      namespace - a namespace. Namespace
      properties - a collection of metadata to apply to the namespace

    • removeProperties

      public boolean removeProperties(Namespace namespace, Set<String> properties)
      Description copied from interface: SupportsNamespaces
      Remove a set of property keys from a namespace in the catalog.

      Properties that are not in the given set are not modified or removed by this method.

      Specified by:
      removeProperties in interface SupportsNamespaces
      Parameters:
      namespace - a namespace. Namespace
      properties - a collection of metadata to apply to the namespace

    • loadNamespaceMetadata

      public Map<String,String> loadNamespaceMetadata(Namespace namespace)
      Description copied from interface: SupportsNamespaces
      Load metadata properties for a namespace.
      Specified by:
      loadNamespaceMetadata in interface SupportsNamespaces
      Parameters:
      namespace - a namespace. Namespace
      Returns:
      a string map of properties for the given namespace

    • name

      public String name()
      Description copied from interface: Catalog
      Return the name for this catalog.
      Specified by:
      name in interface Catalog
      Returns:
      this catalog's name

    • properties

      protected Map<String,String> properties()
      Overrides:
      properties in class BaseMetastoreCatalog

    • setConf

      public void setConf(Object conf)
      Specified by:
      setConf in interface Configurable<Object>