org.apache.iceberg.catalog

Interface Catalog

All Known Implementing Classes:

BaseMetastoreCatalog, HiveCatalog

public interface Catalog

A Catalog API for table create, drop, and load operations.

Method Summary

Modifier and Type	Method and Description
default Table	createTable(TableIdentifier identifier, Schema schema) Create an unpartitioned table.
default Table	createTable(TableIdentifier identifier, Schema schema, PartitionSpec spec) Create a table.
default Table	createTable(TableIdentifier identifier, Schema schema, PartitionSpec spec, java.util.Map<java.lang.String,java.lang.String> properties) Create a table.
Table	createTable(TableIdentifier identifier, Schema schema, PartitionSpec spec, java.lang.String location, java.util.Map<java.lang.String,java.lang.String> properties) Create a table.
boolean	dropTable(TableIdentifier identifier) Drop a table.
Table	loadTable(TableIdentifier identifier) Load a table.
void	renameTable(TableIdentifier from, TableIdentifier to) Rename a table.
default boolean	tableExists(TableIdentifier identifier) Check whether table exists.

Method Detail

createTable

Table createTable(TableIdentifier identifier,
                  Schema schema,
                  PartitionSpec spec,
                  java.lang.String location,
                  java.util.Map<java.lang.String,java.lang.String> properties)

Create a table.

Parameters:

identifier - a table identifier

schema - a schema

spec - a partition spec

location - a location for the table; leave null if unspecified

properties - a string map of table properties

Returns:

a Table instance

Throws:

AlreadyExistsException - if the table already exists

createTable

default Table createTable(TableIdentifier identifier,
                          Schema schema,
                          PartitionSpec spec,
                          java.util.Map<java.lang.String,java.lang.String> properties)

Create a table.

Parameters:

identifier - a table identifier

schema - a schema

spec - a partition spec

properties - a string map of table properties

Returns:

a Table instance

Throws:

AlreadyExistsException - if the table already exists

createTable

default Table createTable(TableIdentifier identifier,
                          Schema schema,
                          PartitionSpec spec)

Create a table.

Parameters:

identifier - a table identifier

schema - a schema

spec - a partition spec

Returns:

a Table instance

Throws:

AlreadyExistsException - if the table already exists

createTable

default Table createTable(TableIdentifier identifier,
                          Schema schema)

Create an unpartitioned table.

Parameters:

identifier - a table identifier

schema - a schema

Returns:

a Table instance

Throws:

AlreadyExistsException - if the table already exists

tableExists

default boolean tableExists(TableIdentifier identifier)

Check whether table exists.

Parameters:

identifier - a table identifier

Returns:

true if the table exists, false otherwise

dropTable

boolean dropTable(TableIdentifier identifier)

Drop a table.

Parameters:

identifier - a table identifier

Returns:

true if the table was dropped, false if the table did not exist

renameTable

void renameTable(TableIdentifier from,
                 TableIdentifier to)

Rename a table.

Parameters:

from - identifier of the table to rename

to - new table name

Throws:

NoSuchTableException - if the table does not exist

loadTable

Table loadTable(TableIdentifier identifier)

Load a table.

Parameters:

identifier - a table identifier

Returns:

instance of Table implementation referred by tableIdentifier

Throws:

NoSuchTableException - if the table does not exist