com.datastrato.gravitino.rel

Interface TableCatalog

All Known Implementing Classes:

RelationalCatalog

public interface TableCatalog

The TableCatalog interface defines the public API for managing tables in a schema. If the catalog implementation supports tables, it must implement this interface.

Method Summary

Modifier and Type	Method and Description
Table	alterTable(NameIdentifier ident, TableChange... changes) Apply the change to a table in the catalog.
default Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Create a table in the catalog.
default Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, Distribution distribution) Create a table in the catalog.
default Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, Distribution distribution, SortOrder[] sortOrders) Create a table in the catalog.
default Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, SortOrder[] sortOrders) Create a table in the catalog.
default Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, Transform[] partitions) Create a table in the catalog.
Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, Transform[] partitions, Distribution distribution, SortOrder[] sortOrders) Create a partitioned table in the catalog.
boolean	dropTable(NameIdentifier ident) Drop a table from the catalog.
NameIdentifier[]	listTables(Namespace namespace) List the tables in a namespace from the catalog.
Table	loadTable(NameIdentifier ident) Load table metadata by NameIdentifier from the catalog.
default boolean	purgeTable(NameIdentifier ident) Drop a table from the catalog and completely remove its data.
default boolean	tableExists(NameIdentifier ident) Check if a table exists using an NameIdentifier from the catalog.

Method Detail

listTables

NameIdentifier[] listTables(Namespace namespace)
                     throws NoSuchSchemaException

List the tables in a namespace from the catalog.

Parameters:

namespace - A namespace.

Returns:

An array of table identifiers in the namespace.

Throws:

NoSuchSchemaException - If the schema does not exist.

loadTable

Table loadTable(NameIdentifier ident)
         throws NoSuchTableException

Load table metadata by NameIdentifier from the catalog.

Parameters:

ident - A table identifier.

Returns:

The table metadata.

Throws:

NoSuchTableException - If the table does not exist.

tableExists

default boolean tableExists(NameIdentifier ident)

Check if a table exists using an NameIdentifier from the catalog.

Parameters:

ident - A table identifier.

Returns:

true If the table exists, false otherwise.

createTable

default Table createTable(NameIdentifier ident,
                          Column[] columns,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.String> properties)
                   throws NoSuchSchemaException,
                          TableAlreadyExistsException

Create a table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

Returns:

The created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

createTable

default Table createTable(NameIdentifier ident,
                          Column[] columns,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          Transform[] partitions)
                   throws NoSuchSchemaException,
                          TableAlreadyExistsException

Create a table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

partitions - The table partitioning.

Returns:

The created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

createTable

default Table createTable(NameIdentifier ident,
                          Column[] columns,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          Distribution distribution,
                          SortOrder[] sortOrders)
                   throws NoSuchSchemaException,
                          TableAlreadyExistsException

Create a table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

distribution - The distribution of the table

sortOrders - The sort orders of the table

Returns:

The created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

createTable

default Table createTable(NameIdentifier ident,
                          Column[] columns,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          Distribution distribution)
                   throws NoSuchSchemaException,
                          TableAlreadyExistsException

Create a table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

distribution - The distribution of the table.

Returns:

The created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

createTable

default Table createTable(NameIdentifier ident,
                          Column[] columns,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          SortOrder[] sortOrders)
                   throws NoSuchSchemaException,
                          TableAlreadyExistsException

Create a table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

sortOrders - The sort orders of the table

Returns:

The created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

createTable

Table createTable(NameIdentifier ident,
                  Column[] columns,
                  java.lang.String comment,
                  java.util.Map<java.lang.String,java.lang.String> properties,
                  Transform[] partitions,
                  Distribution distribution,
                  SortOrder[] sortOrders)
           throws NoSuchSchemaException,
                  TableAlreadyExistsException

Create a partitioned table in the catalog.

Parameters:

ident - A table identifier.

columns - The columns of the new table.

comment - The table comment.

properties - The table properties.

distribution - The distribution of the table

sortOrders - The sort orders of the table

partitions - The table partitioning.

Returns:

Fhe created table metadata.

Throws:

NoSuchSchemaException - If the schema does not exist.

TableAlreadyExistsException - If the table already exists.

alterTable

Table alterTable(NameIdentifier ident,
                 TableChange... changes)
          throws NoSuchTableException,
                 java.lang.IllegalArgumentException

Apply the change to a table in the catalog.

Implementations may reject the change. If any change is rejected, no changes should be applied to the table.

Parameters:

ident - A table identifier.

changes - Table changes to apply to the table.

Returns:

The updated table metadata.

Throws:

NoSuchTableException - If the table does not exist.

java.lang.IllegalArgumentException - If the change is rejected by the implementation.

dropTable

boolean dropTable(NameIdentifier ident)

Drop a table from the catalog.

Parameters:

ident - A table identifier.

Returns:

True if the table was dropped, false if the table did not exist.

purgeTable

default boolean purgeTable(NameIdentifier ident)
                    throws java.lang.UnsupportedOperationException

Drop a table from the catalog and completely remove its data.

If the catalog supports to purge a table, this method should be overridden. The default implementation throws an UnsupportedOperationException.

Parameters:

ident - A table identifier.

Returns:

True if the table was purged, false if the table did not exist.

Throws:

java.lang.UnsupportedOperationException - If the catalog does not support to purge a table.