Package org.apache.iceberg.hive
Class HiveCatalog
- java.lang.Object
-
- org.apache.iceberg.BaseMetastoreCatalog
-
- org.apache.iceberg.hive.HiveCatalog
-
- All Implemented Interfaces:
org.apache.hadoop.conf.Configurable
,Catalog
,SupportsNamespaces
public class HiveCatalog extends BaseMetastoreCatalog implements SupportsNamespaces, org.apache.hadoop.conf.Configurable
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.iceberg.BaseMetastoreCatalog
BaseMetastoreCatalog.BaseMetastoreCatalogTableBuilder
-
Nested classes/interfaces inherited from interface org.apache.iceberg.catalog.Catalog
Catalog.TableBuilder
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
LIST_ALL_TABLES
static java.lang.String
LIST_ALL_TABLES_DEFAULT
-
Constructor Summary
Constructors Constructor Description HiveCatalog()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
createNamespace(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> meta)
Create a namespace in the catalog.protected java.lang.String
defaultWarehouseLocation(TableIdentifier tableIdentifier)
boolean
dropNamespace(Namespace namespace)
Drop a namespace.boolean
dropTable(TableIdentifier identifier, boolean purge)
Drop a table; optionally delete data and metadata files.org.apache.hadoop.conf.Configuration
getConf()
void
initialize(java.lang.String inputName, java.util.Map<java.lang.String,java.lang.String> properties)
Initialize a catalog given a custom name and a map of catalog properties.protected boolean
isValidIdentifier(TableIdentifier tableIdentifier)
java.util.List<Namespace>
listNamespaces(Namespace namespace)
List namespaces from the namespace.java.util.List<TableIdentifier>
listTables(Namespace namespace)
Return all the identifiers under this namespace.java.util.Map<java.lang.String,java.lang.String>
loadNamespaceMetadata(Namespace namespace)
Load metadata properties for a namespace.java.lang.String
name()
Return the name for this catalog.TableOperations
newTableOps(TableIdentifier tableIdentifier)
Table
registerTable(TableIdentifier identifier, java.lang.String metadataFileLocation)
Register a table with the catalog if it does not exist.boolean
removeProperties(Namespace namespace, java.util.Set<java.lang.String> properties)
Remove a set of property keys from a namespace in the catalog.void
renameTable(TableIdentifier from, TableIdentifier originalTo)
Rename a table.void
setConf(org.apache.hadoop.conf.Configuration conf)
boolean
setProperties(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> properties)
Set a collection of properties on a namespace in the catalog.java.lang.String
toString()
-
Methods inherited from class org.apache.iceberg.BaseMetastoreCatalog
buildTable, fullTableName, loadTable
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.iceberg.catalog.Catalog
createTable, createTable, createTable, createTable, dropTable, invalidateTable, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, tableExists
-
Methods inherited from interface org.apache.iceberg.catalog.SupportsNamespaces
createNamespace, listNamespaces, namespaceExists
-
-
-
-
Field Detail
-
LIST_ALL_TABLES
public static final java.lang.String LIST_ALL_TABLES
- See Also:
- Constant Field Values
-
LIST_ALL_TABLES_DEFAULT
public static final java.lang.String LIST_ALL_TABLES_DEFAULT
- See Also:
- Constant Field Values
-
-
Method Detail
-
initialize
public void initialize(java.lang.String inputName, java.util.Map<java.lang.String,java.lang.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 interfaceCatalog
- Parameters:
inputName
- a custom name for the catalogproperties
- catalog properties
-
listTables
public java.util.List<TableIdentifier> listTables(Namespace namespace)
Description copied from interface:Catalog
Return all the identifiers under this namespace.- Specified by:
listTables
in interfaceCatalog
- Parameters:
namespace
- a namespace- Returns:
- a list of identifiers for tables
-
name
public java.lang.String name()
Description copied from interface:Catalog
Return the name for this catalog.
-
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.
-
renameTable
public void renameTable(TableIdentifier from, TableIdentifier originalTo)
Description copied from interface:Catalog
Rename a table.- Specified by:
renameTable
in interfaceCatalog
- Parameters:
from
- identifier of the table to renameoriginalTo
- new table name
-
registerTable
public Table registerTable(TableIdentifier identifier, java.lang.String metadataFileLocation)
Description copied from interface:Catalog
Register a table with the catalog if it does not exist.- Specified by:
registerTable
in interfaceCatalog
- Parameters:
identifier
- a table identifiermetadataFileLocation
- the location of a metadata file- Returns:
- a Table instance
-
createNamespace
public void createNamespace(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> meta)
Description copied from interface:SupportsNamespaces
Create a namespace in the catalog.- Specified by:
createNamespace
in interfaceSupportsNamespaces
- Parameters:
namespace
- a multi-part namespacemeta
- a string Map of properties for the given namespace
-
listNamespaces
public java.util.List<Namespace> listNamespaces(Namespace namespace)
Description copied from interface:SupportsNamespaces
List namespaces from the namespace.For example, if table a.b.t exists, use 'SELECT NAMESPACE IN a' this method must return Namepace.of("a","b")
Namespace
.- Specified by:
listNamespaces
in interfaceSupportsNamespaces
- Returns:
- a List of namespace
Namespace
names
-
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 interfaceSupportsNamespaces
- Parameters:
namespace
- a namespace.Namespace
- Returns:
- true if the namespace was dropped, false otherwise.
-
setProperties
public boolean setProperties(Namespace namespace, java.util.Map<java.lang.String,java.lang.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 interfaceSupportsNamespaces
- Parameters:
namespace
- a namespace.Namespace
properties
- a collection of metadata to apply to the namespace
-
removeProperties
public boolean removeProperties(Namespace namespace, java.util.Set<java.lang.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 interfaceSupportsNamespaces
- Parameters:
namespace
- a namespace.Namespace
properties
- a collection of metadata to apply to the namespace
-
loadNamespaceMetadata
public java.util.Map<java.lang.String,java.lang.String> loadNamespaceMetadata(Namespace namespace)
Description copied from interface:SupportsNamespaces
Load metadata properties for a namespace.- Specified by:
loadNamespaceMetadata
in interfaceSupportsNamespaces
- Parameters:
namespace
- a namespace.Namespace
- Returns:
- a string map of properties for the given namespace
-
isValidIdentifier
protected boolean isValidIdentifier(TableIdentifier tableIdentifier)
- Overrides:
isValidIdentifier
in classBaseMetastoreCatalog
-
newTableOps
public TableOperations newTableOps(TableIdentifier tableIdentifier)
- Specified by:
newTableOps
in classBaseMetastoreCatalog
-
defaultWarehouseLocation
protected java.lang.String defaultWarehouseLocation(TableIdentifier tableIdentifier)
- Specified by:
defaultWarehouseLocation
in classBaseMetastoreCatalog
-
toString
public java.lang.String toString()
- Overrides:
toString
in classBaseMetastoreCatalog
-
setConf
public void setConf(org.apache.hadoop.conf.Configuration conf)
- Specified by:
setConf
in interfaceorg.apache.hadoop.conf.Configurable
-
getConf
public org.apache.hadoop.conf.Configuration getConf()
- Specified by:
getConf
in interfaceorg.apache.hadoop.conf.Configurable
-
-