com.toolsverse.etl.metadata.postgres

Class PostgresMetadata

Object

com.toolsverse.etl.metadata.BaseMetadata

com.toolsverse.etl.metadata.JdbcMetadata

com.toolsverse.etl.metadata.postgres.PostgresMetadata

All Implemented Interfaces:

Metadata, ExtensionModule, Comparable<ExtensionModule>

public class PostgresMetadata
extends JdbcMetadata

The PostgreSQL implementation of the Metadata interface.

Since:

2.0

Version:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.toolsverse.etl.metadata.JdbcMetadata

JdbcMetadata.DbMetadata

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,String>	POSTGRES_METADATA_METHODS The POSTGRES metadata methods.
protected static Map<String,String>	POSTGRES_TYPE_METHODS The Oracle type methods.
protected static Map<String,String>	POSTGRES_TYPE_SUPPORT_AS_TEXT The POSTGRES object types which support asText.
protected static Map<String,String>	POSTGRES_TYPE_SUPPORT_EXECUTE_AS_TEXT The oracle type support execute as text map.
protected static Map<String,String>	POSTGRES_TYPES_BY_PARENT The POSTGRES types by parent.
(package private) static String	TYPE_TRIGGER_EVENTS The TYPE_TRIGGER_EVENTS.

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

ALLOWED_FOR_SCHEMA_CATALOG, ALLOWED_FOR_TABLE, ALLOWED_TOP_LEVEL, METADATA_METHODS, TYPE_METHODS, TYPE_SUPPORT_AS_TEXT, TYPE_SUPPORT_DROP_AS_TEXT, 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
PostgresMetadata()

Method Summary

Modifier and Type	Method and Description
boolean	allowNotDefault() Checks if not default objects are allowed in the restricted mode.
String	asTextMethod(String type) asText method name for the type.
String	executeAsText(String catalog, String schema, String pattern, String type, String metadataId) Shows object execute SQL.
String	getAllowedSchema() Gets the allowed schema when in restricted mode.
DataSet	getConstraints(String catalog, String schema, String pattern, String type) Gets table constraints.
List<String>	getDbObjectTypes() Gets the database object types.
String	getLicensePropertyName() Gets the name of the license property.
Map<String,String>	getMetadataMethods() Gets the metadata methods.
String	getName() Gets the name.
KeyValue[]	getObjectTypes() Gets the object types.
String	getProcAsText(String catalog, String schema, String pattern, String type) Gets the function DDL.
DataSet	getSequences(String catalog, String schema, String pattern, String type) Gets the sequences.
List<String>	getTableMetadataTypes() Gets the table metadata types.
List<String>	getTableTypes() Gets the table types.
DataSet	getTriggerEvents(String catalog, String schema, String pattern, String type) Gets the trigger events.
List<String>	getTriggerMetadataTypes() Gets the trigger metadata types.
DataSet	getTriggers(String catalog, String schema, String pattern, String type) Gets the triggers.
Map<String,String>	getTypeMethods() Gets the type methods.
Map<String,String>	getTypesByParent() Gets the types by parent.
String	getViewAsText(String catalog, String schema, String pattern, String type) Gets the view DDL.
DataSet	searchDatabase(DatabaseFilter filter) Search database objects.
boolean	supportsAsText(String type) Checks if metadata driver supports asText method for the type.
boolean	supportsExecute(String type) Checks if metadata driver supports executeAsText method for the type.
boolean	supportsSearchDatabase() Checks if metadata driver supports search database.

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

asText, chooseBestIndex, createAsText, discoverDatabaseTypes, dropAsText, dropAsTextMethod, free, getAllRefs, getCatalogs, getCatalogSchemaAndPattern, getCatalogSchemaMetadataAllowed, getDbFunctions, getDbInfoObjects, getDbMetadata, getDbObjectsByWildcard, getDbProps, getDeleteRule, getDropAliasAsText, getDropAssemblyAsText, getDropDbLinkAsText, getDropFunctionAsText, getDropIndexAsText, getDropPackageAsText, getDropProcAsText, getDropSequenceAsText, getDropSynonymAsText, getDropTableAsText, getDropTriggerAsText, getDropTypeAsText, getDropViewAsText, getEKColumns, getEKMetadataTypes, getFKColumns, getFkDefinitionAsText, getFKMetadataTypes, getFksAsText, getFuncParamNameForNull, getFuncParamType, getFuncRetType, getFunctMetadataTypes, getFunctParameters, getFuncts, getIndexColumns, getIndexDefinitionAsText, getIndexesAsText, getIndexMetadataTypes, getOwners, getParameters, getPkAsText, getPKColumns, getPKMetadataTypes, getProcMetadataTypes, getProcParameters, getProcs, getProcsRetType, getSchemas, getSuggestedKeyFields, getTableAsText, getTableColumns, getTableEKs, getTableEKs, getTableFKs, getTableIndexes, getTableMetadataAllowed, getTableNameAsText, getTablePKs, getTablePrivs, getTablesByType, getTopLevelAllowed, getTopLevelDbObjects, getTransIsolation, getTypeByTypeFieldValue, getTypeField, getTypes, getUpdateRule, getVendor, getVersion, getViewMetadataTypes, isOutParam, isUnique, needToPopulate, populateTables, supportsDrop

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

compareTo, getColumns, getConfigFileName, getConnectionFactory, getConnectionParamsProvider, getCurrentDatabase, getDefaultColumns, getDisplayName, getDriver, getExtensionRank, getFullObjectName, getIconPath, getLocalUnitClassPath, getMetadataByType, getMetadataByTypePreserveException, getMetadataTypeByParentType, getMetadataTypes, getObjectName, getObjectOwnerName, getType, getXmlConfigFileName, hasCatalogs, hasMetadataTypes, hasSchemas, init, isDatabaseCurrent, setCurrentDatabase, setHasCatalogs, setHasSchemas, supportsRefresh

Methods inherited from class Object

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

Field Detail

TYPE_TRIGGER_EVENTS

static final String TYPE_TRIGGER_EVENTS

The TYPE_TRIGGER_EVENTS.

See Also:

Constant Field Values

POSTGRES_TYPE_METHODS

protected static Map<String,String> POSTGRES_TYPE_METHODS

The Oracle type methods.

POSTGRES_METADATA_METHODS

protected static Map<String,String> POSTGRES_METADATA_METHODS

The POSTGRES metadata methods.

POSTGRES_TYPES_BY_PARENT

protected static Map<String,String> POSTGRES_TYPES_BY_PARENT

The POSTGRES types by parent.

POSTGRES_TYPE_SUPPORT_AS_TEXT

protected static Map<String,String> POSTGRES_TYPE_SUPPORT_AS_TEXT

The POSTGRES object types which support asText.

POSTGRES_TYPE_SUPPORT_EXECUTE_AS_TEXT

protected static Map<String,String> POSTGRES_TYPE_SUPPORT_EXECUTE_AS_TEXT

The oracle type support execute as text map.

Constructor Detail

PostgresMetadata

public PostgresMetadata()

Method Detail

allowNotDefault

public boolean allowNotDefault()

Description copied from interface: Metadata

Checks if not default objects are allowed in the restricted mode.

Specified by:

allowNotDefault in interface Metadata

Overrides:

allowNotDefault in class JdbcMetadata

Returns:

true if not default objects are allowed in the restricted mode

asTextMethod

public String asTextMethod(String type)

Description copied from class: JdbcMetadata

asText method name for the type.

Overrides:

asTextMethod in class JdbcMetadata

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.

Specified by:

executeAsText in interface Metadata

Overrides:

executeAsText in class JdbcMetadata

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

getAllowedSchema

public String getAllowedSchema()

Description copied from interface: Metadata

Gets the allowed schema when in restricted mode.

Specified by:

getAllowedSchema in interface Metadata

Overrides:

getAllowedSchema in class JdbcMetadata

Returns:

the allowed schema when in restricted mode.

getConstraints

public DataSet getConstraints(String catalog,
                              String schema,
                              String pattern,
                              String type)
                       throws Exception

Gets table constraints.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the constraints

Throws:

Exception - the exception

getDbObjectTypes

public List<String> getDbObjectTypes()
                              throws Exception

Description copied from class: JdbcMetadata

Gets the database object types.

Overrides:

getDbObjectTypes in class JdbcMetadata

Returns:

the database object types

Throws:

Exception - in case of any error

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.

Specified by:

getLicensePropertyName in interface ExtensionModule

Overrides:

getLicensePropertyName in class JdbcMetadata

Returns:

the name of the license property

getMetadataMethods

public Map<String,String> getMetadataMethods()

Description copied from class: BaseMetadata

Gets the metadata methods.

Overrides:

getMetadataMethods in class JdbcMetadata

Returns:

the metadata methods

getName

public String getName()

Description copied from interface: Metadata

Gets the name.

Specified by:

getName in interface Metadata

Overrides:

getName in class JdbcMetadata

Returns:

the name

getObjectTypes

public KeyValue[] getObjectTypes()

Description copied from interface: Metadata

Gets the object types.

Specified by:

getObjectTypes in interface Metadata

Overrides:

getObjectTypes in class BaseMetadata

Returns:

the object types, key = type, value = description

getProcAsText

public String getProcAsText(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the function DDL.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the function DDL

Throws:

Exception - the exception in case of any error

getSequences

public DataSet getSequences(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the sequences.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the sequences

Throws:

Exception - in case of any error

getTableMetadataTypes

public List<String> getTableMetadataTypes()

Description copied from class: JdbcMetadata

Gets the table metadata types.

Overrides:

getTableMetadataTypes in class JdbcMetadata

Returns:

the table metadata types

getTableTypes

public List<String> getTableTypes()
                           throws Exception

Description copied from class: JdbcMetadata

Gets the table types.

Overrides:

getTableTypes in class JdbcMetadata

Returns:

the table types

Throws:

Exception - in case of any error

getTriggerEvents

public DataSet getTriggerEvents(String catalog,
                                String schema,
                                String pattern,
                                String type)
                         throws Exception

Gets the trigger events.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the trigger events

Throws:

Exception - the exception

getTriggerMetadataTypes

public List<String> getTriggerMetadataTypes()

Gets the trigger metadata types.

Returns:

the trigger metadata types

getTriggers

public DataSet getTriggers(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception

Gets the triggers.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the triggers

Throws:

Exception - in case of any error

getTypeMethods

public Map<String,String> getTypeMethods()

Description copied from interface: Metadata

Gets the type methods.

Specified by:

getTypeMethods in interface Metadata

Overrides:

getTypeMethods in class JdbcMetadata

Returns:

the type methods

getTypesByParent

public Map<String,String> getTypesByParent()

Description copied from class: BaseMetadata

Gets the types by parent.

Overrides:

getTypesByParent in class JdbcMetadata

Returns:

the types by parent

getViewAsText

public String getViewAsText(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the view DDL.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the view DDL

Throws:

Exception - the exception in case of any error

searchDatabase

public DataSet searchDatabase(DatabaseFilter filter)
                       throws Exception

Description copied from interface: Metadata

Search database objects.

Specified by:

searchDatabase in interface Metadata

Overrides:

searchDatabase in class BaseMetadata

Parameters:

filter - the search filter

Returns:

the data set

Throws:

Exception - in case of any error

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 JdbcMetadata

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.

Specified by:

supportsExecute in interface Metadata

Overrides:

supportsExecute in class JdbcMetadata

Parameters:

type - the type

Returns:

true, if successful

supportsSearchDatabase

public boolean supportsSearchDatabase()

Description copied from interface: Metadata

Checks if metadata driver supports search database.

Specified by:

supportsSearchDatabase in interface Metadata

Overrides:

supportsSearchDatabase in class BaseMetadata

Returns:

true, if successful