Package 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	Description
static interface	DatabaseMetadataHelper.ColumnsIteratorCallback	The Interface ColumnsIteratorCallback.
static interface	DatabaseMetadataHelper.Filter<T>	The Interface Filter.
static interface	DatabaseMetadataHelper.FunctionColumnsIteratorCallback	The Interface FunctionColumnsIteratorCallback.
static interface	DatabaseMetadataHelper.IndicesIteratorCallback	The Interface IndicesIteratorCallback.
static interface	DatabaseMetadataHelper.ProcedureColumnsIteratorCallback	The Interface ProceduresColumnsIteratorCallback.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DECIMAL_DIGITS	The Constant DECIMAL_DIGITS.

Constructor Summary

Constructors

Constructor	Description
DatabaseMetadataHelper()

Method Summary

Modifier and Type	Method	Description
static FunctionMetadata	describeFunction(Connection connection, String catalogName, String schemeName, String functionName)	Describe function.
static ProcedureMetadata	describeProcedure(Connection connection, String catalogName, String schemeName, String procedureName)	Describe procedure.
static TableMetadata	describeTable(Connection connection, String catalogName, String schemeName, String tableName)	Describe table.
static String	getFunctionMetadataAsJson(DataSource dataSource, String schema, String function)	Gets the metadata as json.
static String	getMetadataAsJson(DataSource dataSource)	Gets the metadata as json.
static String	getProcedureMetadataAsJson(DataSource dataSource, String schema, String procedure)	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	iterateFunctionDefinition(Connection connection, String catalogName, String schemaName, String functionName, DatabaseMetadataHelper.FunctionColumnsIteratorCallback functionColumnsIteratorCallback)	Iterate function definition.
static void	iterateProcedureDefinition(Connection connection, String catalogName, String schemaName, String procedureName, DatabaseMetadataHelper.ProcedureColumnsIteratorCallback procedureColumnsIteratorCallback)	Iterate procedure definition.
static void	iterateTableDefinition(Connection connection, String catalogName, String schemaName, String tableName, DatabaseMetadataHelper.ColumnsIteratorCallback columnsIteratorCallback, DatabaseMetadataHelper.IndicesIteratorCallback indicesIteratorCallback)	Iterate table definition.
static List<FunctionMetadata>	listFunctions(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> functionNameFilter)	List functions.
static List<ProcedureMetadata>	listProcedures(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> procedureNameFilter)	List procedures.
static List<SchemaMetadata>	listSchemas(Connection connection, String catalogName, DatabaseMetadataHelper.Filter<String> schemaNameFilter, DatabaseMetadataHelper.Filter<String> nameFilter)	List schemas.
static List<TableMetadata>	listTables(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> tableNameFilter)	List tables.
static String	normalizeTableName(String table)	Makes necessary formatting if needed.

Methods inherited from class java.lang.Object

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

Field Details

DECIMAL_DIGITS

public static final String DECIMAL_DIGITS

The Constant DECIMAL_DIGITS.

See Also:

Constant Field Values

Constructor Details

DatabaseMetadataHelper

public DatabaseMetadataHelper()

Method Details

listSchemas

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

List schemas.

Parameters:

connection - the connection

catalogName - the catalog name

schemaNameFilter - the schema name filter

nameFilter - the 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

listProcedures

public static List<ProcedureMetadata> listProcedures(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> procedureNameFilter) throws SQLException

List procedures.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

procedureNameFilter - the procedure name filter

Returns:

the list

Throws:

SQLException - the SQL exception

listFunctions

public static List<FunctionMetadata> listFunctions(Connection connection, String catalogName, String schemeName, DatabaseMetadataHelper.Filter<String> functionNameFilter) throws SQLException

List functions.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

functionNameFilter - the function 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

Describe table.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

tableName - the table name

Returns:

the TableMetadata

Throws:

SQLException - the SQL exception

describeProcedure

public static ProcedureMetadata describeProcedure(Connection connection, String catalogName, String schemeName, String procedureName) throws SQLException

Describe procedure.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

procedureName - the procedure name

Returns:

the ProcedureMetadata

Throws:

SQLException - the SQL exception

describeFunction

public static FunctionMetadata describeFunction(Connection connection, String catalogName, String schemeName, String functionName) throws SQLException

Describe function.

Parameters:

connection - the connection

catalogName - the catalog name

schemeName - the scheme name

functionName - the function name

Returns:

the FunctionMetadata

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

iterateProcedureDefinition

public static void iterateProcedureDefinition(Connection connection, String catalogName, String schemaName, String procedureName, DatabaseMetadataHelper.ProcedureColumnsIteratorCallback procedureColumnsIteratorCallback) throws SQLException

Iterate procedure definition.

Parameters:

connection - the connection

catalogName - the catalog name

schemaName - the schema name

procedureName - the procedure name

procedureColumnsIteratorCallback - the procedure columns iterator callback

Throws:

SQLException - the SQL exception

iterateFunctionDefinition

public static void iterateFunctionDefinition(Connection connection, String catalogName, String schemaName, String functionName, DatabaseMetadataHelper.FunctionColumnsIteratorCallback functionColumnsIteratorCallback) throws SQLException

Iterate function definition.

Parameters:

connection - the connection

catalogName - the catalog name

schemaName - the schema name

functionName - the function name

functionColumnsIteratorCallback - the function columns 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

getProcedureMetadataAsJson

public static String getProcedureMetadataAsJson(DataSource dataSource, String schema, String procedure) throws SQLException

Gets the metadata as json.

Parameters:

dataSource - the data source

schema - the schema name

procedure - the procedure name

Returns:

the metadata as json

Throws:

SQLException - the SQL exception

getFunctionMetadataAsJson

public static String getFunctionMetadataAsJson(DataSource dataSource, String schema, String function) throws SQLException

Gets the metadata as json.

Parameters:

dataSource - the data source

schema - the schema name

function - the function 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

normalizeTableName

public static String normalizeTableName(String table)

Makes necessary formatting if needed.

Parameters:

table - the table name

Returns:

the formatted table name