JdbcMetadata (Toolsverse API Reference 5.9)

Object
- com.toolsverse.etl.metadata.BaseMetadata
- - com.toolsverse.etl.metadata.JdbcMetadata

All Implemented Interfaces:

Metadata, ExtensionModule, Comparable<ExtensionModule>

Direct Known Subclasses:

Db2Metadata, ExcelOdbcMetadata, InformixMetadata, MsSqlMetadata, MySqlMetadata, OracleMetadata, PostgresMetadata, SybaseMetadata
```
public class JdbcMetadata
extends BaseMetadata
```
The implementation of the Metadata interface for the jdbc complaint databases.

Since:

1.0

Version:

2.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class JdbcMetadata.DbMetadata
The Class DbMetadata.

Nested Classes
Modifier and Type	Class and Description
`class`	`JdbcMetadata.DbMetadata` The Class DbMetadata.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Set<String>`	`ALLOWED_FOR_SCHEMA_CATALOG` The allowed objects for schemas and catalogs.
`protected static Set<String>`	`ALLOWED_FOR_TABLE` The allowed objects for tables.
`protected static Set<String>`	`ALLOWED_TOP_LEVEL` The allowed top level.
`protected static Map<String,String>`	`METADATA_METHODS` The metadata methods.
`protected static Map<String,String>`	`TYPE_METHODS` The type methods.
`protected static Map<String,String>`	`TYPE_SUPPORT_AS_TEXT` The types which support asText method.
`protected static Map<String,String>`	`TYPE_SUPPORT_DROP_AS_TEXT` The types which support dropAsText method.
`protected static Map<String,String>`	`TYPES_BY_PARENT` The types by parent.

Fields inherited from class com.toolsverse.etl.metadata.BaseMetadata
TYPES_SUPPORT_REFRESH

Fields inherited from interface com.toolsverse.etl.metadata.Metadata
ALL_REFS, ALL_TYPES, BASE_CLASS_PATH, DB_DELIMITER, DEFAULT_METHOD, DEFAULT_TYPE, ID_FIELD, METADATA_DELIMITER, SYNONYMS_DATASET_TYPE, TABLE_PRIV, TABLE_PRIVS, TABLES_DATASET_TYPE, TYPE_ALIAS, TYPE_ALIASES, TYPE_ASSEMBLIES, TYPE_ASSEMBLY, TYPE_CATALOG, TYPE_CLASS, TYPE_COLUMN, TYPE_COLUMNS, TYPE_CONSTRAINTS, TYPE_DATA_SET, TYPE_DB_LINK, TYPE_DB_LINKS, TYPE_DBFUNCT, TYPE_DBFUNCTIONS, TYPE_DBINFO, TYPE_DBPROP, TYPE_DBPROPS, TYPE_DIRECTORIES, TYPE_DIRECTORY, TYPE_EK, TYPE_EK_COLUMN, TYPE_EK_COLUMNS, TYPE_EKS, TYPE_EXEC_METHOD, TYPE_EXEC_METHODS, TYPE_FILE, TYPE_FK, TYPE_FK_COLUMN, TYPE_FK_COLUMNS, TYPE_FKS, TYPE_FUNCT, TYPE_FUNCT_PARAMETERS, TYPE_FUNCTS, TYPE_GLOBAL_TEMPORARIES, TYPE_INDEX, TYPE_INDEX_COLUMN, TYPE_INDEX_COLUMNS, TYPE_INDEXES, TYPE_JAVA_CLASSES, TYPE_LOCAL_TEMPORARIES, TYPE_NICKNAME, TYPE_PACKAGE, TYPE_PACKAGE_BODY, TYPE_PACKAGES, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_PK, TYPE_PK_COLUMN, TYPE_PK_COLUMNS, TYPE_PKS, TYPE_PROC, TYPE_PROC_PARAMETERS, TYPE_PROCS, TYPE_PROCS_FUNCS, TYPE_QUEUE, TYPE_QUEUE_TABLE, TYPE_QUEUE_TABLES, TYPE_QUEUES, TYPE_RECYCLE_BIN, TYPE_RECYCLE_BIN_ITEM, TYPE_SCHEMA, TYPE_SEQUENCE, TYPE_SEQUENCES, TYPE_SYNONYM, TYPE_SYNONYMS, TYPE_SYSTEM_TABLES, TYPE_SYSTEM_VIEWS, TYPE_TABLE, TYPE_TABLES, TYPE_TEMPORARY_TABLES, TYPE_TEMPORARY_VIEWS, TYPE_TRIGGER, TYPE_TRIGGERS, TYPE_TYPE, TYPE_TYPES, TYPE_USER_TYPE, TYPE_USER_TYPES, TYPE_VIEW, TYPE_VIEWS, TYPE_WORKSHEET, TYPE_WORKSHEETS, TYPE_XML_SCHEMA, TYPE_XML_SCHEMAS, VIEWS_DATASET_TYPE

Fields inherited from interface com.toolsverse.ext.ExtensionModule
APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Constructor Summary

Constructors
Constructor and Description

JdbcMetadata()

Constructors
Constructor and Description
`JdbcMetadata()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowNotDefault()` Checks if not default objects are allowed in the restricted mode.
`String`	`asText(String catalog, String schema, String pattern, String type, String metadataId)` Shows object DDL.
`String`	`asTextMethod(String type)` asText method name for the type.
`static List<String>`	`chooseBestIndex(LinkedHashMap<String,List<String>> indexes, DataSetFields fields)` Choose the best index and return list of fields in the index.
`String`	`createAsText(String sql, String catalog, String schema, String pattern, String type)` Shows object create DDL.
`Map<Integer,List<FieldDef>>`	`discoverDatabaseTypes()` Discovers database types.
`String`	`dropAsText(String catalog, String schema, String pattern, String type)` Shows object drop DDL.
`String`	`dropAsTextMethod(String type)` dropAsText method name for the type.
`String`	`executeAsText(String catalog, String schema, String pattern, String type, String metadataId)` Shows object execute SQL.
`void`	`free()` Free the resources.
`String`	`getAllowedSchema()` Gets the allowed schema when in restricted mode.
`DataSet`	`getAllRefs(String catalog, String schema, String pattern, String type)` Get the all references including inner tables.
`List<Object>`	`getCatalogs(boolean hasSchemas)` Gets the catalogs.
`String[]`	`getCatalogSchemaAndPattern(String value)` Gets the catalog schema and pattern from the value.
`Set<String>`	`getCatalogSchemaMetadataAllowed()` Gets the set of allowed database objects for catalogs and schemas when in restricted mode.
`DataSet`	`getDbFunctions(String catalog, String schema, String pattern, String type)` Gets the database functions.
`List<String>`	`getDbInfoObjects()` Gets the database info objects.
`JdbcMetadata.DbMetadata`	`getDbMetadata()` Gets the database metadata.
`static List<String>`	`getDbObjectsByWildcard(String wildcard, Alias alias, Driver driver, Set<String> excludedObjects, Set<String> includedObjects, boolean includeViews, boolean includeTables)` Gets the database objects by a wildcard.
`List<String>`	`getDbObjectTypes()` Gets the database object types.
`DataSet`	`getDbProps(String catalog, String schema, String pattern, String type)` Gets the database properties.
`static String`	`getDeleteRule(Object rule)` Gets the delete rule.
`String`	`getDropAliasAsText(String catalog, String schema, String pattern, String type)` Gets the drop alias SQL.
`String`	`getDropAssemblyAsText(String catalog, String schema, String pattern, String type)` Gets the drop assembly SQL.
`String`	`getDropDbLinkAsText(String catalog, String schema, String pattern, String type)` Gets the drop alias SQL.
`String`	`getDropFunctionAsText(String catalog, String schema, String pattern, String type)` Gets the drop function SQL.
`String`	`getDropIndexAsText(String catalog, String schema, String pattern, String type)` Gets the drop index SQL.
`String`	`getDropPackageAsText(String catalog, String schema, String pattern, String type)` Gets the drop package SQL.
`String`	`getDropProcAsText(String catalog, String schema, String pattern, String type)` Gets the drop procedure SQL.
`String`	`getDropSequenceAsText(String catalog, String schema, String pattern, String type)` Gets the drop sequence SQL.
`String`	`getDropSynonymAsText(String catalog, String schema, String pattern, String type)` Gets the drop db link SQL.
`String`	`getDropTableAsText(String catalog, String schema, String pattern, String type)` Gets the drop table SQL.
`String`	`getDropTriggerAsText(String catalog, String schema, String pattern, String type)` Gets the drop trigger SQL.
`String`	`getDropTypeAsText(String catalog, String schema, String pattern, String type)` Gets the drop type SQL.
`String`	`getDropViewAsText(String catalog, String schema, String pattern, String type)` Gets the drop view SQL.
`DataSet`	`getEKColumns(String catalog, String schema, String pattern, String type)` Gets the external key columns.
`List<String>`	`getEKMetadataTypes()` Gets the external key metadata types.
`DataSet`	`getFKColumns(String catalog, String schema, String pattern, String type)` Gets the foreign key columns.
`String`	`getFkDefinitionAsText(String catalog, String schema, String pattern, String type, String name)` Gets the foreign key definition as text.
`List<String>`	`getFKMetadataTypes()` Gets the foreign key metadata types.
`String`	`getFksAsText(String catalog, String schema, String pattern, String type)` Gets the foreign key as text.
`static String`	`getFuncParamNameForNull(Object name)` Gets the function parameter name when it is null.
`static String`	`getFuncParamType(Object type)` Gets the function parameter type.
`static String`	`getFuncRetType(Object type)` Gets the function return type.
`List<String>`	`getFunctMetadataTypes()` Gets the function metadata types.
`DataSet`	`getFunctParameters(String catalog, String schema, String pattern, String type)` Gets the function parameters.
`DataSet`	`getFuncts(String catalog, String schema, String pattern, String type)` Gets the functions.
`DataSet`	`getIndexColumns(String catalog, String schema, String pattern, String type)` Gets the index columns.
`String`	`getIndexDefinitionAsText(String catalog, String schema, String pattern, String type, String tableName, String name, boolean unique, String suffix, boolean toUpper, boolean leadingNumberNotAllowed)` Gets the index definition as text.
`String`	`getIndexesAsText(String catalog, String schema, String pattern, String type, String tName, String suffix, boolean toUpper, boolean leadingNumberNotAllowed)` Gets the indexes as text.
`List<String>`	`getIndexMetadataTypes()` Gets the index metadata types.
`String`	`getLicensePropertyName()` Gets the name of the license property.
`Map<String,String>`	`getMetadataMethods()` Gets the metadata methods.
`String`	`getName()` Gets the name.
`List<Object>`	`getOwners()` Gets the owners.
`DataSet`	`getParameters(String catalog, String schema, String pattern, String type)` Gets the parameters.
`String`	`getPkAsText(String catalog, String schema, String pattern, String type)` Gets the primary key as text.
`DataSet`	`getPKColumns(String catalog, String schema, String pattern, String type)` Gets the primary key columns.
`List<String>`	`getPKMetadataTypes()` Gets the primary key metadata types.
`List<String>`	`getProcMetadataTypes()` Gets the procedure metadata types.
`DataSet`	`getProcParameters(String catalog, String schema, String pattern, String type)` Gets the procedure parameters.
`DataSet`	`getProcs(String catalog, String schema, String pattern, String type)` Gets the procedures.
`static String`	`getProcsRetType(Object type)` Gets the procedure return type.
`List<Object>`	`getSchemas(String catalog)` Gets the schemas.
`static List<String>`	`getSuggestedKeyFields(Connection connection, Driver driver, String theTableName, DataSetFields dataSetFields)` Gets the suggested key fields.
`String`	`getTableAsText(String catalog, String schema, String pattern, String type)` Gets the table as text.
`DataSet`	`getTableColumns(String catalog, String schema, String pattern, String type)` Gets the table columns.
`DataSet`	`getTableEKs(String catalog, String schema, String pattern, String type)` Gets the table external keys.
`DataSet`	`getTableEKs(String catalog, String schema, String pattern, String type, DataSet dataSet)` Gets the table external keys.
`DataSet`	`getTableFKs(String catalog, String schema, String pattern, String type)` Gets the table foreign keys.
`DataSet`	`getTableIndexes(String catalog, String schema, String pattern, String type)` Gets the table indexes.
`Set<String>`	`getTableMetadataAllowed()` Gets the set of allowed database objects for tables when in restricted mode.
`List<String>`	`getTableMetadataTypes()` Gets the table metadata types.
`String`	`getTableNameAsText(String catalog, String schema, String pattern, String type, String name)` Gets the table name as text.
`DataSet`	`getTablePKs(String catalog, String schema, String pattern, String type)` Gets the table primary key.
`DataSet`	`getTablePrivs(String catalog, String schema, String pattern, String type)` Gets the table privileges.
`DataSet`	`getTablesByType(String catalog, String schema, String pattern, String type)` Gets the tables by type.
`List<String>`	`getTableTypes()` Gets the table types.
`Set<String>`	`getTopLevelAllowed()` Gets the set of allowed top level database objects when in restricted mode.
`List<Object>`	`getTopLevelDbObjects()` Gets the top level database objects.
`String`	`getTransIsolation(Object value)` Gets the transaction isolation level.
`String`	`getTypeByTypeFieldValue(String value)` Gets the type by type field value.
`String`	`getTypeField()` Gets the type field.
`Map<String,String>`	`getTypeMethods()` Gets the type methods.
`DataSet`	`getTypes(String catalog, String schema, String pattern, String type)` Gets the types.
`Map<String,String>`	`getTypesByParent()` Gets the types by parent.
`static String`	`getUpdateRule(Object rule)` Gets the update rule.
`String`	`getVendor()` Gets the vendor.
`String`	`getVersion()` Gets the version of the extension module.
`List<String>`	`getViewMetadataTypes()` Gets the view metadata types.
`boolean`	`isOutParam(String parType)` Checks if this is output parameter.
`boolean`	`isUnique(DataSet dataSet, int row)` Checks if index is unique using given data set with indexes and row which is a number of the index.
`boolean`	`needToPopulate(String type)` Checks if metadata node needs to be populatet.
`static void`	`populateTables(List<String> objects, DataSet tables, Metadata metadata, String wildcard, Set<String> excludedObjects, Set<String> includedObjects)` Populate tables.
`boolean`	`supportsAsText(String type)` Checks if metadata driver supports asText method for the type.
`boolean`	`supportsDrop(String type)` Checks if metadata driver supports dropAsText method for the type.
`boolean`	`supportsExecute(String type)` Checks if metadata driver supports executeAsText method for the type.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_METHODS
```
protected static Map<String,String> TYPE_METHODS
```
    The type methods.
  - METADATA_METHODS
```
protected static Map<String,String> METADATA_METHODS
```
    The metadata methods.
  - TYPES_BY_PARENT
```
protected static Map<String,String> TYPES_BY_PARENT
```
    The types by parent.
  - TYPE_SUPPORT_AS_TEXT
```
protected static Map<String,String> TYPE_SUPPORT_AS_TEXT
```
    The types which support asText method.
  - TYPE_SUPPORT_DROP_AS_TEXT
```
protected static Map<String,String> TYPE_SUPPORT_DROP_AS_TEXT
```
    The types which support dropAsText method.
  - ALLOWED_TOP_LEVEL
```
protected static Set<String> ALLOWED_TOP_LEVEL
```
    The allowed top level.
  - ALLOWED_FOR_SCHEMA_CATALOG
```
protected static Set<String> ALLOWED_FOR_SCHEMA_CATALOG
```
    The allowed objects for schemas and catalogs.
  - ALLOWED_FOR_TABLE
```
protected static Set<String> ALLOWED_FOR_TABLE
```
    The allowed objects for tables.
- Constructor Detail
  - JdbcMetadata
```
public JdbcMetadata()
```
- Method Detail
  - getDeleteRule
```
public static String getDeleteRule(Object rule)
```
    Gets the delete rule.
    
    Parameters:
    
    rule - the rule
    
    Returns:
    
    the update rule
  - getFuncParamNameForNull
```
public static String getFuncParamNameForNull(Object name)
```
    Gets the function parameter name when it is null.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the name
  - getFuncParamType
```
public static String getFuncParamType(Object type)
```
    Gets the function parameter type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the function parameter type
  - getFuncRetType
```
public static String getFuncRetType(Object type)
```
    Gets the function return type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the function return type
  - getProcsRetType
```
public static String getProcsRetType(Object type)
```
    Gets the procedure return type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the procedure return type
  - getUpdateRule
```
public static String getUpdateRule(Object rule)
```
    Gets the update rule.
    
    Parameters:
    
    rule - the rule
    
    Returns:
    
    the update rule
  - allowNotDefault
```
public boolean allowNotDefault()
```
    Description copied from interface: Metadata
    
    Checks if not default objects are allowed in the restricted mode.
    
    Returns:
    
    true if not default objects are allowed in the restricted mode
  - asText
```
public String asText(String catalog,
                     String schema,
                     String pattern,
                     String type,
                     String metadataId)
              throws Exception
```
    Description copied from interface: Metadata
    
    Shows object DDL.
    
    Specified by:
    
    asText in interface Metadata
    
    Overrides:
    
    asText in class BaseMetadata
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    metadataId - the metadata id
    
    Returns:
    
    the string
    
    Throws:
    
    Exception - in case of any error
  - asTextMethod
```
public String asTextMethod(String type)
```
    asText method name for the type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the string
  - createAsText
```
public String createAsText(String sql,
                           String catalog,
                           String schema,
                           String pattern,
                           String type)
```
    Description copied from interface: Metadata
    
    Shows object create DDL.
    
    Parameters:
    
    sql - the sql
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the string
  - discoverDatabaseTypes
```
public Map<Integer,List<FieldDef>> discoverDatabaseTypes()
                                                  throws Exception
```
    Description copied from interface: Metadata
    
    Discovers database types.
    
    Returns:
    
    the map of database types
    
    Throws:
    
    Exception - in case of any error
  - dropAsText
```
public String dropAsText(String catalog,
                         String schema,
                         String pattern,
                         String type)
                  throws Exception
```
    Description copied from interface: Metadata
    
    Shows object drop DDL.
    
    Specified by:
    
    dropAsText in interface Metadata
    
    Overrides:
    
    dropAsText in class BaseMetadata
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the string
    
    Throws:
    
    Exception - in case of any error
  - dropAsTextMethod
```
public String dropAsTextMethod(String type)
```
    dropAsText method name for the type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the string
  - executeAsText
```
public String executeAsText(String catalog,
                            String schema,
                            String pattern,
                            String type,
                            String metadataId)
                     throws Exception
```
    Description copied from interface: Metadata
    
    Shows object execute SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    metadataId - the metadata id
    
    Returns:
    
    the string
    
    Throws:
    
    Exception - in case of any error
  - free
```
public void free()
```
    Description copied from interface: Metadata
    
    Free the resources.
  - getAllowedSchema
```
public String getAllowedSchema()
```
    Description copied from interface: Metadata
    
    Gets the allowed schema when in restricted mode.
    
    Returns:
    
    the allowed schema when in restricted mode.
  - getAllRefs
```
public DataSet getAllRefs(String catalog,
                          String schema,
                          String pattern,
                          String type)
                   throws Exception
```
    Get the all references including inner tables. Basically populates entire reference graph.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the references
    
    Throws:
    
    Exception - in case of any error
  - getCatalogs
```
public List<Object> getCatalogs(boolean hasSchemas)
                         throws Exception
```
    Gets the catalogs.
    
    Parameters:
    
    hasSchemas - the "has schemas" flag
    
    Returns:
    
    the catalogs
    
    Throws:
    
    Exception - in case of any error
  - getCatalogSchemaAndPattern
```
public String[] getCatalogSchemaAndPattern(String value)
```
    Gets the catalog schema and pattern from the value. Can have database specific implementations
    
    Parameters:
    
    value - an array where catalog is a first element, schema is a second and pattern is a third
    
    Returns:
    
    the catalog schema and pattern
  - getCatalogSchemaMetadataAllowed
```
public Set<String> getCatalogSchemaMetadataAllowed()
```
    Description copied from interface: Metadata
    
    Gets the set of allowed database objects for catalogs and schemas when in restricted mode.
    
    Returns:
    
    the set of allowed database objects for catalogs and schemas when in restricted mode
  - getDbFunctions
```
public DataSet getDbFunctions(String catalog,
                              String schema,
                              String pattern,
                              String type)
                       throws Exception
```
    Gets the database functions.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the database functions
    
    Throws:
    
    Exception - in case of any error
  - getDbInfoObjects
```
public List<String> getDbInfoObjects()
                              throws Exception
```
    Gets the database info objects.
    
    Returns:
    
    the database info objects
    
    Throws:
    
    Exception - in case of any error
  - getDbMetadata
```
public JdbcMetadata.DbMetadata getDbMetadata()
                                      throws Exception
```
    Gets the database metadata.
    
    Returns:
    
    the database metadata
    
    Throws:
    
    Exception - in case of any error
  - getDbObjectTypes
```
public List<String> getDbObjectTypes()
                              throws Exception
```
    Gets the database object types.
    
    Returns:
    
    the database object types
    
    Throws:
    
    Exception - in case of any error
  - getDbProps
```
public DataSet getDbProps(String catalog,
                          String schema,
                          String pattern,
                          String type)
                   throws Exception
```
    Gets the database properties.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the database properties
    
    Throws:
    
    Exception - in case of any error
  - getDropAliasAsText
```
public String getDropAliasAsText(String catalog,
                                 String schema,
                                 String pattern,
                                 String type)
                          throws Exception
```
    Gets the drop alias SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropAssemblyAsText
```
public String getDropAssemblyAsText(String catalog,
                                    String schema,
                                    String pattern,
                                    String type)
                             throws Exception
```
    Gets the drop assembly SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropDbLinkAsText
```
public String getDropDbLinkAsText(String catalog,
                                  String schema,
                                  String pattern,
                                  String type)
                           throws Exception
```
    Gets the drop alias SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropFunctionAsText
```
public String getDropFunctionAsText(String catalog,
                                    String schema,
                                    String pattern,
                                    String type)
                             throws Exception
```
    Gets the drop function SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropIndexAsText
```
public String getDropIndexAsText(String catalog,
                                 String schema,
                                 String pattern,
                                 String type)
                          throws Exception
```
    Gets the drop index SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropPackageAsText
```
public String getDropPackageAsText(String catalog,
                                   String schema,
                                   String pattern,
                                   String type)
                            throws Exception
```
    Gets the drop package SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropProcAsText
```
public String getDropProcAsText(String catalog,
                                String schema,
                                String pattern,
                                String type)
                         throws Exception
```
    Gets the drop procedure SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropSequenceAsText
```
public String getDropSequenceAsText(String catalog,
                                    String schema,
                                    String pattern,
                                    String type)
                             throws Exception
```
    Gets the drop sequence SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropSynonymAsText
```
public String getDropSynonymAsText(String catalog,
                                   String schema,
                                   String pattern,
                                   String type)
                            throws Exception
```
    Gets the drop db link SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropTableAsText
```
public String getDropTableAsText(String catalog,
                                 String schema,
                                 String pattern,
                                 String type)
                          throws Exception
```
    Gets the drop table SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropTriggerAsText
```
public String getDropTriggerAsText(String catalog,
                                   String schema,
                                   String pattern,
                                   String type)
                            throws Exception
```
    Gets the drop trigger SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropTypeAsText
```
public String getDropTypeAsText(String catalog,
                                String schema,
                                String pattern,
                                String type)
                         throws Exception
```
    Gets the drop type SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getDropViewAsText
```
public String getDropViewAsText(String catalog,
                                String schema,
                                String pattern,
                                String type)
                         throws Exception
```
    Gets the drop view SQL.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the SQL
    
    Throws:
    
    Exception - the exception
  - getEKColumns
```
public DataSet getEKColumns(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception
```
    Gets the external key columns.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the external key columns
    
    Throws:
    
    Exception - in case of any error
  - getEKMetadataTypes
```
public List<String> getEKMetadataTypes()
```
    Gets the external key metadata types.
    
    Returns:
    
    the external key metadata types
  - getFKColumns
```
public DataSet getFKColumns(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception
```
    Gets the foreign key columns.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the foreign key columns
    
    Throws:
    
    Exception - in case of any error
  - getFkDefinitionAsText
```
public String getFkDefinitionAsText(String catalog,
                                    String schema,
                                    String pattern,
                                    String type,
                                    String name)
                             throws Exception
```
    Gets the foreign key definition as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    name - the name
    
    Returns:
    
    the foreign key definition as text
    
    Throws:
    
    Exception - in case of any error
  - getFKMetadataTypes
```
public List<String> getFKMetadataTypes()
```
    Gets the foreign key metadata types.
    
    Returns:
    
    the foreign key metadata types
  - getFksAsText
```
public String getFksAsText(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception
```
    Gets the foreign key as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the foreign key as text
    
    Throws:
    
    Exception - in case of any error
  - getFunctMetadataTypes
```
public List<String> getFunctMetadataTypes()
```
    Gets the function metadata types.
    
    Returns:
    
    the function metadata types
  - getFunctParameters
```
public DataSet getFunctParameters(String catalog,
                                  String schema,
                                  String pattern,
                                  String type)
                           throws Exception
```
    Gets the function parameters.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the function parameters
    
    Throws:
    
    Exception - in case of any error
  - getFuncts
```
public DataSet getFuncts(String catalog,
                         String schema,
                         String pattern,
                         String type)
                  throws Exception
```
    Gets the functions.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the function
    
    Throws:
    
    Exception - in case of any error
  - getIndexColumns
```
public DataSet getIndexColumns(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception
```
    Gets the index columns.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the index columns
    
    Throws:
    
    Exception - in case of any error
  - getIndexDefinitionAsText
```
public String getIndexDefinitionAsText(String catalog,
                                       String schema,
                                       String pattern,
                                       String type,
                                       String tableName,
                                       String name,
                                       boolean unique,
                                       String suffix,
                                       boolean toUpper,
                                       boolean leadingNumberNotAllowed)
                                throws Exception
```
    Gets the index definition as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    tableName - the table name
    
    name - the name
    
    unique - if true the "unique" is added before index name
    
    suffix - the suffix will be added to the index name
    
    toUpper - if true converts fields names to upper case
    
    leadingNumberNotAllowed - the leading number not allowed
    
    Returns:
    
    the index definition as text
    
    Throws:
    
    Exception - in case of any error
  - getIndexesAsText
```
public String getIndexesAsText(String catalog,
                               String schema,
                               String pattern,
                               String type,
                               String tName,
                               String suffix,
                               boolean toUpper,
                               boolean leadingNumberNotAllowed)
                        throws Exception
```
    Gets the indexes as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    tName - the table name to replace original table name
    
    suffix - will be added to the end of the index name
    
    toUpper - if true converts fields names to upper case
    
    leadingNumberNotAllowed - the leading number not allowed
    
    Returns:
    
    the indexes as text
    
    Throws:
    
    Exception - in case of any error
  - getIndexMetadataTypes
```
public List<String> getIndexMetadataTypes()
```
    Gets the index metadata types.
    
    Returns:
    
    the index metadata types
  - getLicensePropertyName
```
public String getLicensePropertyName()
```
    Description copied from interface: ExtensionModule
    
    Gets the name of the license property. If not null the model is a subject of licensing.
    
    Returns:
    
    the name of the license property
  - getMetadataMethods
```
public Map<String,String> getMetadataMethods()
```
    Description copied from class: BaseMetadata
    
    Gets the metadata methods.
    
    Specified by:
    
    getMetadataMethods in class BaseMetadata
    
    Returns:
    
    the metadata methods
  - getName
```
public String getName()
```
    Description copied from interface: Metadata
    
    Gets the name.
    
    Returns:
    
    the name
  - getOwners
```
public List<Object> getOwners()
                       throws Exception
```
    Gets the owners.
    
    Returns:
    
    the owners
    
    Throws:
    
    Exception - in case of any error
  - getParameters
```
public DataSet getParameters(String catalog,
                             String schema,
                             String pattern,
                             String type)
                      throws Exception
```
    Gets the parameters.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the parameters
    
    Throws:
    
    Exception - in case of any error
  - getPkAsText
```
public String getPkAsText(String catalog,
                          String schema,
                          String pattern,
                          String type)
                   throws Exception
```
    Gets the primary key as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the primary key as text
    
    Throws:
    
    Exception - in case of any error
  - getPKColumns
```
public DataSet getPKColumns(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception
```
    Gets the primary key columns.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the primary key columns
    
    Throws:
    
    Exception - in case of any error
  - getPKMetadataTypes
```
public List<String> getPKMetadataTypes()
```
    Gets the primary key metadata types.
    
    Returns:
    
    the primary key metadata types
  - getProcMetadataTypes
```
public List<String> getProcMetadataTypes()
```
    Gets the procedure metadata types.
    
    Returns:
    
    the procedure metadata types
  - getProcParameters
```
public DataSet getProcParameters(String catalog,
                                 String schema,
                                 String pattern,
                                 String type)
                          throws Exception
```
    Gets the procedure parameters.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the procedure parameters
    
    Throws:
    
    Exception - in case of any error
  - getProcs
```
public DataSet getProcs(String catalog,
                        String schema,
                        String pattern,
                        String type)
                 throws Exception
```
    Gets the procedures.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the procedures
    
    Throws:
    
    Exception - in case of any error
  - getSchemas
```
public List<Object> getSchemas(String catalog)
                        throws Exception
```
    Gets the schemas.
    
    Parameters:
    
    catalog - the catalog
    
    Returns:
    
    the schemas
    
    Throws:
    
    Exception - in case of any error
  - getTableAsText
```
public String getTableAsText(String catalog,
                             String schema,
                             String pattern,
                             String type)
                      throws Exception
```
    Gets the table as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table as text
    
    Throws:
    
    Exception - in case of any error
  - getTableColumns
```
public DataSet getTableColumns(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception
```
    Gets the table columns.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table columns
    
    Throws:
    
    Exception - in case of any error
  - getTableEKs
```
public DataSet getTableEKs(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception
```
    Gets the table external keys.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table external keys
    
    Throws:
    
    Exception - in case of any error
  - getTableEKs
```
public DataSet getTableEKs(String catalog,
                           String schema,
                           String pattern,
                           String type,
                           DataSet dataSet)
                    throws Exception
```
    Gets the table external keys.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    dataSet - the existing data set
    
    Returns:
    
    the table external keys
    
    Throws:
    
    Exception - in case of any error
  - getTableFKs
```
public DataSet getTableFKs(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception
```
    Gets the table foreign keys.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table foreign keys
    
    Throws:
    
    Exception - in case of any error
  - getTableIndexes
```
public DataSet getTableIndexes(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception
```
    Gets the table indexes.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table indexes
    
    Throws:
    
    Exception - in case of any error
  - getTableMetadataAllowed
```
public Set<String> getTableMetadataAllowed()
```
    Description copied from interface: Metadata
    
    Gets the set of allowed database objects for tables when in restricted mode.
    
    Returns:
    
    the set of allowed database objects for tables when in restricted mode
  - getTableMetadataTypes
```
public List<String> getTableMetadataTypes()
```
    Gets the table metadata types.
    
    Returns:
    
    the table metadata types
  - getTableNameAsText
```
public String getTableNameAsText(String catalog,
                                 String schema,
                                 String pattern,
                                 String type,
                                 String name)
                          throws Exception
```
    Gets the table name as text.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    name - the name
    
    Returns:
    
    the table name as text
    
    Throws:
    
    Exception - in case of any error
  - getTablePKs
```
public DataSet getTablePKs(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception
```
    Gets the table primary key.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table primary key
    
    Throws:
    
    Exception - in case of any error
  - getTablePrivs
```
public DataSet getTablePrivs(String catalog,
                             String schema,
                             String pattern,
                             String type)
                      throws Exception
```
    Gets the table privileges.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the table external keys
    
    Throws:
    
    Exception - in case of any error
  - getTablesByType
```
public DataSet getTablesByType(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception
```
    Gets the tables by type.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the tables by type
    
    Throws:
    
    Exception - in case of any error
  - getTableTypes
```
public List<String> getTableTypes()
                           throws Exception
```
    Gets the table types.
    
    Returns:
    
    the table types
    
    Throws:
    
    Exception - in case of any error
  - getTopLevelAllowed
```
public Set<String> getTopLevelAllowed()
```
    Description copied from interface: Metadata
    
    Gets the set of allowed top level database objects when in restricted mode.
    
    Returns:
    
    the top level database objects
  - getTopLevelDbObjects
```
public List<Object> getTopLevelDbObjects()
                                  throws Exception
```
    Description copied from interface: Metadata
    
    Gets the top level database objects. Such as schemas etc.
    
    Returns:
    
    the top level database objects
    
    Throws:
    
    Exception - in case of any error
  - getTransIsolation
```
public String getTransIsolation(Object value)
```
    Gets the transaction isolation level.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the transaction isolation level
  - getTypeByTypeFieldValue
```
public String getTypeByTypeFieldValue(String value)
```
    Description copied from interface: Metadata
    
    Gets the type by type field value.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the type by type field value
  - getTypeField
```
public String getTypeField()
```
    Description copied from interface: Metadata
    
    Gets the type field.
    
    Returns:
    
    the type field
  - getTypeMethods
```
public Map<String,String> getTypeMethods()
```
    Description copied from interface: Metadata
    
    Gets the type methods.
    
    Returns:
    
    the type methods
  - getTypes
```
public DataSet getTypes(String catalog,
                        String schema,
                        String pattern,
                        String type)
                 throws Exception
```
    Gets the types.
    
    Parameters:
    
    catalog - the catalog
    
    schema - the schema
    
    pattern - the pattern
    
    type - the type
    
    Returns:
    
    the types
    
    Throws:
    
    Exception - in case of any error
  - getTypesByParent
```
public Map<String,String> getTypesByParent()
```
    Description copied from class: BaseMetadata
    
    Gets the types by parent.
    
    Specified by:
    
    getTypesByParent in class BaseMetadata
    
    Returns:
    
    the types by parent
  - getVendor
```
public String getVendor()
```
    Description copied from interface: ExtensionModule
    
    Gets the vendor.
    
    Returns:
    
    the vendor
  - getVersion
```
public String getVersion()
```
    Description copied from interface: ExtensionModule
    
    Gets the version of the extension module.
    
    Returns:
    
    the version
  - getViewMetadataTypes
```
public List<String> getViewMetadataTypes()
```
    Gets the view metadata types.
    
    Returns:
    
    the view metadata types
  - isOutParam
```
public boolean isOutParam(String parType)
```
    Checks if this is output parameter.
    
    Parameters:
    
    parType - the parameter type
    
    Returns:
    
    true, if this is output parameter
  - isUnique
```
public boolean isUnique(DataSet dataSet,
                        int row)
```
    Checks if index is unique using given data set with indexes and row which is a number of the index. Can be database specific.
    
    Parameters:
    
    dataSet - the data set with indexes
    
    row - the a number of the index
    
    Returns:
    
    true if index is unique
  - needToPopulate
```
public boolean needToPopulate(String type)
```
    Description copied from interface: Metadata
    
    Checks if metadata node needs to be populatet.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    true, if successful
  - supportsAsText
```
public boolean supportsAsText(String type)
```
    Description copied from interface: Metadata
    
    Checks if metadata driver supports asText method for the type.
    
    Specified by:
    
    supportsAsText in interface Metadata
    
    Overrides:
    
    supportsAsText in class BaseMetadata
    
    Parameters:
    
    type - the type
    
    Returns:
    
    true, if successful
  - supportsDrop
```
public boolean supportsDrop(String type)
```
    Description copied from interface: Metadata
    
    Checks if metadata driver supports dropAsText method for the type.
    
    Specified by:
    
    supportsDrop in interface Metadata
    
    Overrides:
    
    supportsDrop in class BaseMetadata
    
    Parameters:
    
    type - the type
    
    Returns:
    
    true, if successful
  - supportsExecute
```
public boolean supportsExecute(String type)
```
    Description copied from interface: Metadata
    
    Checks if metadata driver supports executeAsText method for the type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    true, if successful
  - populateTables
```
public static void populateTables(List<String> objects,
                                  DataSet tables,
                                  Metadata metadata,
                                  String wildcard,
                                  Set<String> excludedObjects,
                                  Set<String> includedObjects)
```
    Populate tables.
    
    Parameters:
    
    objects - the objects
    
    tables - the tables
    
    metadata - the metadata
    
    wildcard - the wildcard
    
    excludedObjects - the excluded objects
    
    includedObjects - the included objects
  - getDbObjectsByWildcard
```
public static List<String> getDbObjectsByWildcard(String wildcard,
                                                  Alias alias,
                                                  Driver driver,
                                                  Set<String> excludedObjects,
                                                  Set<String> includedObjects,
                                                  boolean includeViews,
                                                  boolean includeTables)
                                           throws Exception
```
    Gets the database objects by a wildcard.
    
    Parameters:
    
    wildcard - the wildcard
    
    alias - the alias
    
    driver - the driver
    
    excludedObjects - the excluded objects
    
    includedObjects - the included objects
    
    includeViews - the include views flag
    
    includeTables - the include tables flag
    
    Returns:
    
    the list of tables/views/etc.
    
    Throws:
    
    Exception - the exception
  - chooseBestIndex
```
public static List<String> chooseBestIndex(LinkedHashMap<String,List<String>> indexes,
                                           DataSetFields fields)
```
    Choose the best index and return list of fields in the index.
    
    Parameters:
    
    indexes - the indexes and fields
    
    fields - the fields
    
    Returns:
    
    the list of fields in the index
  - getSuggestedKeyFields
```
public static List<String> getSuggestedKeyFields(Connection connection,
                                                 Driver driver,
                                                 String theTableName,
                                                 DataSetFields dataSetFields)
                                          throws Exception
```
    Gets the suggested key fields.
    
    Parameters:
    
    connection - the connection
    
    driver - the driver
    
    theTableName - the the table name
    
    fields - the fields
    
    Returns:
    
    the suggested key fields
    
    Throws:
    
    Exception - in case of any error

Class JdbcMetadata

Nested Class Summary

Field Summary

Fields inherited from class com.toolsverse.etl.metadata.BaseMetadata

Fields inherited from interface com.toolsverse.etl.metadata.Metadata

Fields inherited from interface com.toolsverse.ext.ExtensionModule

Constructor Summary

Method Summary

Methods inherited from class com.toolsverse.etl.metadata.BaseMetadata

Methods inherited from class Object

Field Detail

TYPE_METHODS

METADATA_METHODS

TYPES_BY_PARENT

TYPE_SUPPORT_AS_TEXT

TYPE_SUPPORT_DROP_AS_TEXT

ALLOWED_TOP_LEVEL

ALLOWED_FOR_SCHEMA_CATALOG

ALLOWED_FOR_TABLE

Constructor Detail

JdbcMetadata

Method Detail

getDeleteRule

getFuncParamNameForNull

getFuncParamType

getFuncRetType

getProcsRetType

getUpdateRule

allowNotDefault

asText

asTextMethod

createAsText

discoverDatabaseTypes

dropAsText

dropAsTextMethod

executeAsText

free

getAllowedSchema

getAllRefs

getCatalogs

getCatalogSchemaAndPattern

getCatalogSchemaMetadataAllowed

getDbFunctions

getDbInfoObjects

getDbMetadata

getDbObjectTypes

getDbProps

getDropAliasAsText

getDropAssemblyAsText

getDropDbLinkAsText

getDropFunctionAsText

getDropIndexAsText

getDropPackageAsText

getDropProcAsText

getDropSequenceAsText

getDropSynonymAsText

getDropTableAsText

getDropTriggerAsText

getDropTypeAsText

getDropViewAsText

getEKColumns

getEKMetadataTypes

getFKColumns

getFkDefinitionAsText

getFKMetadataTypes

getFksAsText

getFunctMetadataTypes

getFunctParameters

getFuncts

getIndexColumns

getIndexDefinitionAsText

getIndexesAsText

getIndexMetadataTypes

getLicensePropertyName

getMetadataMethods

getName

getOwners

getParameters

getPkAsText

getPKColumns