io.cdap.delta.api.assessment

Interface TableRegistry

All Superinterfaces:

AutoCloseable, Closeable

public interface TableRegistry
extends Closeable

Fetches information about tables in a database. The registry is used when a user is configuring a delta pipeline.

Method Summary

Modifier and Type	Method and Description
default TableDetail	describeTable(String database, String table) Return details about a table.
default TableDetail	describeTable(String database, String schema, String table) Return details about a table.
TableList	listTables()
StandardizedTableDetail	standardize(TableDetail tableDetail) Standardize raw column information into a standard schema that will be sent to the target.

Methods inherited from interface java.io.Closeable

close

Method Detail

listTables

TableList listTables()
              throws IOException

Returns:

list of readable tables

Throws:

IOException - if the table information could not be read

describeTable

default TableDetail describeTable(String database,
                                  String table)
                           throws TableNotFoundException,
                                  IOException

Return details about a table.

Parameters:

database - name of the database that table resides in

table - the table name

Returns:

detail about the table

Throws:

TableNotFoundException - if the specified table does not exist

IOException - if the table information could not be read

describeTable

default TableDetail describeTable(String database,
                                  String schema,
                                  String table)
                           throws TableNotFoundException,
                                  IOException

Return details about a table.

Parameters:

database - name of the database that table resides in

schema - name of the schema that table resides in, it's only required for some DB to

table - the table name identify a table.

Returns:

detail about the table

Throws:

TableNotFoundException - if the specified table does not exist

IOException - if the table information could not be read

standardize

StandardizedTableDetail standardize(TableDetail tableDetail)

Standardize raw column information into a standard schema that will be sent to the target. If there are columns that are not supported by the source, an exception should be thrown.

Parameters:

tableDetail - raw table descriptor

Returns:

standardized table descriptor