org.eclipse.dirigible.databases.helpers

Class DatabaseMetadataHelper

java.lang.Object

org.eclipse.dirigible.databases.helpers.DatabaseMetadataHelper

public class DatabaseMetadataHelper
extends Object

The Database Metadata Helper.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DatabaseMetadataHelper.ColumnsIteratorCallback The Interface ColumnsIteratorCallback.
static interface	DatabaseMetadataHelper.Filter<T> The Interface Filter.
static interface	DatabaseMetadataHelper.IndicesIteratorCallback The Interface IndicesIteratorCallback.

Constructor Summary

Constructors

Constructor and Description
DatabaseMetadataHelper()

Method Summary

Modifier and Type	Method and Description
static TableMetadata	describeTable(Connection connection, String catalogName, String schemeName, String tableName) List tables.
static String	getMetadataAsJson(DataSource dataSource) Gets the metadata as json.
static String	getProductName(DataSource dataSource) Gets the product name
static String	getTableMetadataAsJson(DataSource dataSource, String schema, String table) Gets the metadata as json.
static void	iterateTableDefinition(Connection connection, String catalogName, String schemaName, String tableName, DatabaseMetadataHelper.ColumnsIteratorCallback columnsIteratorCallback, DatabaseMetadataHelper.IndicesIteratorCallback indicesIteratorCallback) Iterate table definition.
static List<SchemaMetadata>	listSchemas(Connection connection, String catalogName, DatabaseMetadataHelper.Filter<String> schemaNameFilter, DatabaseMetadataHelper.Filter<String> tableNameFilter) List schemas.
static List<TableMetadata>	listTables(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> tableNameFilter) List tables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseMetadataHelper

public DatabaseMetadataHelper()

Method Detail

listSchemas

public static List<SchemaMetadata> listSchemas(Connection connection,
                                               String catalogName,
                                               DatabaseMetadataHelper.Filter<String> schemaNameFilter,
                                               DatabaseMetadataHelper.Filter<String> tableNameFilter)
                                        throws SQLException

List schemas.

Parameters:

connection - the connection

catalogName - the catalog name

schemaNameFilter - the schema name filter

tableNameFilter - the table name filter

Returns:

the list

Throws:

SQLException - the SQL exception

listTables

public static List<TableMetadata> listTables(Connection connection,
                                             String catalogName,
                                             String schemeName,
                                             DatabaseMetadataHelper.Filter<String> tableNameFilter)
                                      throws SQLException

List tables.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

tableNameFilter - the table name filter

Returns:

the list

Throws:

SQLException - the SQL exception

describeTable

public static TableMetadata describeTable(Connection connection,
                                          String catalogName,
                                          String schemeName,
                                          String tableName)
                                   throws SQLException

List tables.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

tableName - the table name

Returns:

the TableMetadata

Throws:

SQLException - the SQL exception

iterateTableDefinition

public static void iterateTableDefinition(Connection connection,
                                          String catalogName,
                                          String schemaName,
                                          String tableName,
                                          DatabaseMetadataHelper.ColumnsIteratorCallback columnsIteratorCallback,
                                          DatabaseMetadataHelper.IndicesIteratorCallback indicesIteratorCallback)
                                   throws SQLException

Iterate table definition.

Parameters:

connection - the connection

catalogName - the catalog name

schemaName - the schema name

tableName - the table name

columnsIteratorCallback - the columns iterator callback

indicesIteratorCallback - the indices iterator callback

Throws:

SQLException - the SQL exception

getMetadataAsJson

public static String getMetadataAsJson(DataSource dataSource)
                                throws SQLException

Gets the metadata as json.

Parameters:

dataSource - the data source

Returns:

the metadata as json

Throws:

SQLException - the SQL exception

getTableMetadataAsJson

public static String getTableMetadataAsJson(DataSource dataSource,
                                            String schema,
                                            String table)
                                     throws SQLException

Gets the metadata as json.

Parameters:

dataSource - the data source

schema - the schema name

table - the table name

Returns:

the metadata as json

Throws:

SQLException - the SQL exception

getProductName

public static String getProductName(DataSource dataSource)
                             throws SQLException

Gets the product name

Parameters:

dataSource - the data source

Returns:

the product name

Throws:

SQLException - the SQL exception