public class JdbcCatalog extends BaseMetastoreCatalog implements Configurable<java.lang.Object>, SupportsNamespaces, java.io.Closeable
BaseMetastoreCatalog.BaseMetastoreCatalogTableBuilder
Catalog.TableBuilder
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROPERTY_PREFIX |
Constructor and Description |
---|
JdbcCatalog() |
JdbcCatalog(java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,FileIO> ioBuilder,
java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,JdbcClientPool> clientPoolBuilder,
boolean initializeCatalogTables) |
Modifier and Type | Method and Description |
---|---|
void |
close() |
void |
createNamespace(Namespace namespace,
java.util.Map<java.lang.String,java.lang.String> metadata)
Create a namespace in the catalog.
|
protected java.lang.String |
defaultWarehouseLocation(TableIdentifier table) |
boolean |
dropNamespace(Namespace namespace)
Drop a namespace.
|
boolean |
dropTable(TableIdentifier identifier,
boolean purge)
Drop a table; optionally delete data and metadata files.
|
void |
initialize(java.lang.String name,
java.util.Map<java.lang.String,java.lang.String> properties)
Initialize a catalog given a custom name and a map of catalog properties.
|
java.util.List<Namespace> |
listNamespaces()
List top-level namespaces from the catalog.
|
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.
|
boolean |
namespaceExists(Namespace namespace)
Checks whether the Namespace exists.
|
protected TableOperations |
newTableOps(TableIdentifier tableIdentifier) |
protected java.util.Map<java.lang.String,java.lang.String> |
properties() |
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 to)
Rename a table.
|
void |
setConf(java.lang.Object 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.
|
buildTable, fullTableName, isValidIdentifier, loadTable, registerTable, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
createNamespace
createTable, createTable, createTable, createTable, dropTable, invalidateTable, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, tableExists
public static final java.lang.String PROPERTY_PREFIX
public JdbcCatalog()
public JdbcCatalog(java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,FileIO> ioBuilder, java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,JdbcClientPool> clientPoolBuilder, boolean initializeCatalogTables)
public void initialize(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties)
Catalog
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.
initialize
in interface Catalog
name
- a custom name for the catalogproperties
- catalog propertiesprotected TableOperations newTableOps(TableIdentifier tableIdentifier)
newTableOps
in class BaseMetastoreCatalog
protected java.lang.String defaultWarehouseLocation(TableIdentifier table)
defaultWarehouseLocation
in class BaseMetastoreCatalog
public boolean dropTable(TableIdentifier identifier, boolean purge)
Catalog
If purge is set to true the implementation should delete all data and metadata files.
public java.util.List<TableIdentifier> listTables(Namespace namespace)
Catalog
listTables
in interface Catalog
namespace
- a namespacepublic void renameTable(TableIdentifier from, TableIdentifier to)
Catalog
renameTable
in interface Catalog
from
- identifier of the table to renameto
- new table namepublic java.lang.String name()
Catalog
public void setConf(java.lang.Object conf)
setConf
in interface Configurable<java.lang.Object>
public void createNamespace(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> metadata)
SupportsNamespaces
createNamespace
in interface SupportsNamespaces
namespace
- a multi-part namespacemetadata
- a string Map of properties for the given namespacepublic java.util.List<Namespace> listNamespaces()
SupportsNamespaces
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.
listNamespaces
in interface SupportsNamespaces
Namespace
namespublic java.util.List<Namespace> listNamespaces(Namespace namespace) throws NoSuchNamespaceException
SupportsNamespaces
For example, if table a.b.t exists, use 'SELECT NAMESPACE IN a' this method must return
Namepace.of("a","b") Namespace
.
listNamespaces
in interface SupportsNamespaces
Namespace
namesNoSuchNamespaceException
- If the namespace does not exist (optional)public java.util.Map<java.lang.String,java.lang.String> loadNamespaceMetadata(Namespace namespace) throws NoSuchNamespaceException
SupportsNamespaces
loadNamespaceMetadata
in interface SupportsNamespaces
namespace
- a namespace. Namespace
NoSuchNamespaceException
- If the namespace does not exist (optional)public boolean dropNamespace(Namespace namespace) throws NamespaceNotEmptyException
SupportsNamespaces
dropNamespace
in interface SupportsNamespaces
namespace
- a namespace. Namespace
NamespaceNotEmptyException
- If the namespace is not emptypublic boolean setProperties(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> properties) throws NoSuchNamespaceException
SupportsNamespaces
Properties that are not in the given map are not modified or removed by this method.
setProperties
in interface SupportsNamespaces
namespace
- a namespace. Namespace
properties
- a collection of metadata to apply to the namespaceNoSuchNamespaceException
- If the namespace does not exist (optional)public boolean removeProperties(Namespace namespace, java.util.Set<java.lang.String> properties) throws NoSuchNamespaceException
SupportsNamespaces
Properties that are not in the given set are not modified or removed by this method.
removeProperties
in interface SupportsNamespaces
namespace
- a namespace. Namespace
properties
- a collection of metadata to apply to the namespaceNoSuchNamespaceException
- If the namespace does not exist (optional)public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
public boolean namespaceExists(Namespace namespace)
SupportsNamespaces
namespaceExists
in interface SupportsNamespaces
namespace
- a namespace. Namespace
protected java.util.Map<java.lang.String,java.lang.String> properties()
properties
in class BaseMetastoreCatalog