public interface Metadata extends ExtensionModule
Modifier and Type | Field and Description |
---|---|
static String |
ALL_REFS
The ALL REFERENCES.
|
static String |
ALL_TYPES
All object types.
|
static String |
BASE_CLASS_PATH
The base class path.
|
static String |
DB_DELIMITER
The DB_DELIMITER.
|
static String |
DEFAULT_METHOD
The DEFAULT_METHOD.
|
static String |
DEFAULT_TYPE
The DEFAULT_TYPE.
|
static String |
ID_FIELD
The ID FIELD name.
|
static String |
METADATA_DELIMITER
The METADATA_DELIMITER.
|
static String |
SYNONYMS_DATASET_TYPE
The SYNONYMS_DATASET_TYPE.
|
static String |
TABLE_PRIV
The TABLE PRIVILIGE.
|
static String |
TABLE_PRIVS
The TABLE PRIVILIGES.
|
static String |
TABLES_DATASET_TYPE
The TABLES_DATASET_TYPE.
|
static String |
TYPE_ALIAS
The TYPE_ALIAS.
|
static String |
TYPE_ALIASES
The TYPE_ALIASES.
|
static String |
TYPE_ASSEMBLIES
The TYPE_ASSEMBLIES.
|
static String |
TYPE_ASSEMBLY
The TYPE_ASSEMBLY.
|
static String |
TYPE_CATALOG
The TYPE_CATALOG.
|
static String |
TYPE_CLASS
The TYPE_CLASS.
|
static String |
TYPE_COLUMN
The TYPE_COLUMN.
|
static String |
TYPE_COLUMNS
The TYPE_COLUMNS.
|
static String |
TYPE_CONSTRAINTS
The TYPE_CONSTRAINTS.
|
static String |
TYPE_DATA_SET
The TYPE_DATA_SET.
|
static String |
TYPE_DB_LINK
The TYPE_DB_LINK.
|
static String |
TYPE_DB_LINKS
The TYPE_DB_LINKS.
|
static String |
TYPE_DBFUNCT
The TYPE_DBFUNCT.
|
static String |
TYPE_DBFUNCTIONS
The TYPE_DBFUNCTIONS.
|
static String |
TYPE_DBINFO
The TYPE_DBINFO.
|
static String |
TYPE_DBPROP
The TYPE_DBPROP.
|
static String |
TYPE_DBPROPS
The TYPE_DBPROPS.
|
static String |
TYPE_DIRECTORIES
The TYPE_DIRECTORIES.
|
static String |
TYPE_DIRECTORY
The TYPE_DIRECTORY.
|
static String |
TYPE_EK
The TYPE_EK.
|
static String |
TYPE_EK_COLUMN
The TYPE_EK_COLUMN.
|
static String |
TYPE_EK_COLUMNS
The TYPE_EK_COLUMNS.
|
static String |
TYPE_EKS
The TYPE_EKS.
|
static String |
TYPE_EXEC_METHOD
The TYPE_EXEC_METHOD.
|
static String |
TYPE_EXEC_METHODS
The TYPE_EXEC_METHODS.
|
static String |
TYPE_FILE
The TYPE_FILE.
|
static String |
TYPE_FK
The TYPE_FK.
|
static String |
TYPE_FK_COLUMN
The TYPE_FK_COLUMN.
|
static String |
TYPE_FK_COLUMNS
The TYPE_FK_COLUMNS.
|
static String |
TYPE_FKS
The TYPE_FKS.
|
static String |
TYPE_FUNCT
The TYPE_FUNCT.
|
static String |
TYPE_FUNCT_PARAMETERS
The TYPE_FUNCT_PARAMETERS.
|
static String |
TYPE_FUNCTS
The TYPE_FUNCTS.
|
static String |
TYPE_GLOBAL_TEMPORARIES
The TYPE_GLOBAL_TEMPORARIES.
|
static String |
TYPE_INDEX
The TYPE_INDEX.
|
static String |
TYPE_INDEX_COLUMN
The TYPE_INDEX_COLUMN.
|
static String |
TYPE_INDEX_COLUMNS
The TYPE_INDEX_COLUMNS.
|
static String |
TYPE_INDEXES
The TYPE_INDEXES.
|
static String |
TYPE_JAVA_CLASSES
The TYPE_JAVA_CLASSES.
|
static String |
TYPE_LOCAL_TEMPORARIES
The TYPE_LOCAL_TEMPORARIES.
|
static String |
TYPE_NICKNAME
The TYPE_NICKNAME.
|
static String |
TYPE_PACKAGE
The TYPE_PACKAGE.
|
static String |
TYPE_PACKAGE_BODY
The TYPE_PACKAGE_BODY.
|
static String |
TYPE_PACKAGES
The TYPE_PACKAGES.
|
static String |
TYPE_PARAMETER
The TYPE_PARAMETER.
|
static String |
TYPE_PARAMETERS
The TYPE_PARAMETERS.
|
static String |
TYPE_PK
The TYPE_PK.
|
static String |
TYPE_PK_COLUMN
The TYPE_PK_COLUMN.
|
static String |
TYPE_PK_COLUMNS
The TYPE_PK_COLUMNS.
|
static String |
TYPE_PKS
The TYPE_PKS.
|
static String |
TYPE_PROC
The TYPE_PROC.
|
static String |
TYPE_PROC_PARAMETERS
The TYPE_PROC_PARAMETERS.
|
static String |
TYPE_PROCS
The TYPE_PROCS.
|
static String |
TYPE_PROCS_FUNCS
The TYPE_PROCS_FUNCS.
|
static String |
TYPE_QUEUE
The TYPE_QUEUE.
|
static String |
TYPE_QUEUE_TABLE
The TYPE_QUEUE_TABLE.
|
static String |
TYPE_QUEUE_TABLES
The TYPE_QUEUE_TABLES.
|
static String |
TYPE_QUEUES
The TYPE_QUEUES.
|
static String |
TYPE_RECYCLE_BIN
The TYPE_RECYCLE_BIN.
|
static String |
TYPE_RECYCLE_BIN_ITEM
The TYPE_RECYCLE_BIN_ITEM.
|
static String |
TYPE_SCHEMA
The TYPE_SCHEMA.
|
static String |
TYPE_SEQUENCE
The TYPE_SEQUENCE.
|
static String |
TYPE_SEQUENCES
The TYPE_SEQUENCES.
|
static String |
TYPE_SYNONYM
The TYPE_SYNONYM.
|
static String |
TYPE_SYNONYMS
The TYPE_SYNONYMS.
|
static String |
TYPE_SYSTEM_TABLES
The TYPE_SYSTEM_TABLES.
|
static String |
TYPE_SYSTEM_VIEWS
The TYPE_SYSTEM_VIEWS.
|
static String |
TYPE_TABLE
The TYPE_TABLE.
|
static String |
TYPE_TABLES
The TYPE_TABLES.
|
static String |
TYPE_TEMPORARY_TABLES
The TYPE_TEMPORARY_TABLES.
|
static String |
TYPE_TEMPORARY_VIEWS
The TYPE_TEMPORARY_VIEWS.
|
static String |
TYPE_TRIGGER
The TYPE_TRIGGER.
|
static String |
TYPE_TRIGGERS
The TYPE_TRIGGERS.
|
static String |
TYPE_TYPE
The TYPE_TYPE.
|
static String |
TYPE_TYPES
The TYPE_TYPES.
|
static String |
TYPE_USER_TYPE
The TYPE_USER_TYPE.
|
static String |
TYPE_USER_TYPES
The TYPE_USER_TYPES.
|
static String |
TYPE_VIEW
The TYPE_VIEW.
|
static String |
TYPE_VIEWS
The TYPE_VIEWS.
|
static String |
TYPE_WORKSHEET
The TYPE_WORKSHEET.
|
static String |
TYPE_WORKSHEETS
The TYPE_WORKSHEETS.
|
static String |
TYPE_XML_SCHEMA
The TYPE_XML_SCHEMA.
|
static String |
TYPE_XML_SCHEMAS
The TYPE_XML_SCHEMAS.
|
static String |
VIEWS_DATASET_TYPE
The VIEWS_DATASET_TYPE.
|
APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET
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 |
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 |
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.
|
Set<String> |
getCatalogSchemaMetadataAllowed()
Gets the set of allowed database objects for catalogs and schemas when in restricted mode.
|
ConnectionParamsProvider<Alias> |
getConnectionParamsProvider()
Gets the connection params provider.
|
Driver |
getDriver()
Gets the driver.
|
String |
getFullObjectName(String pattern,
String catalog,
String schema)
Gets the full object name.
|
DataSet |
getMetadataByType(String catalog,
String schema,
String pattern,
String type,
String metadataId)
Gets the metadata by type.
|
DataSet |
getMetadataByTypePreserveException(String catalog,
String schema,
String pattern,
String type,
String metadataId)
Gets the metadata by type and preserve exception.
|
String |
getMetadataTypeByParentType(String parentType)
Gets the metadata type by parent type.
|
List<Object> |
getMetadataTypes(String parentType)
Gets the metadata types.
|
String |
getName()
Gets the name.
|
String |
getObjectName(String pattern)
Gets the object name.
|
String |
getObjectOwnerName(String pattern)
Gets the object owner name.
|
KeyValue[] |
getObjectTypes()
Gets the object types.
|
Set<String> |
getTableMetadataAllowed()
Gets the set of allowed database objects for tables when in restricted mode.
|
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 |
getTypeByTypeFieldValue(String value)
Gets the type by type field value.
|
String |
getTypeField()
Gets the type field.
|
Map<String,String> |
getTypeMethods()
Gets the type methods.
|
boolean |
hasCatalogs()
Checks if database has catalogs.
|
boolean |
hasMetadataTypes(String type)
Checks if database has given metadata type.
|
boolean |
hasSchemas()
Checks if database has schemas.
|
void |
init(ConnectionFactory connectionFactory,
ConnectionParamsProvider<Alias> connectionParamsProvider,
Driver driver)
Initializes metadata driver.
|
boolean |
isDatabaseCurrent(String compareTo)
Checks if database is current.
|
boolean |
needToPopulate(String type)
Checks if metadata node needs to be populatet.
|
DataSet |
searchDatabase(DatabaseFilter filter)
Search database objects.
|
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.
|
boolean |
supportsRefresh(String type)
Checks if metadata driver supports refresh for the type.
|
boolean |
supportsSearchDatabase()
Checks if metadata driver supports search database.
|
getConfigFileName, getDisplayName, getExtensionRank, getIconPath, getLicensePropertyName, getLocalUnitClassPath, getType, getVendor, getVersion, getXmlConfigFileName
static final String ALL_TYPES
static final String ID_FIELD
static final String BASE_CLASS_PATH
static final String TYPE_CATALOG
static final String TYPE_SCHEMA
static final String TYPE_TYPES
static final String TYPE_DBINFO
static final String TYPE_DBPROPS
static final String TYPE_DBPROP
static final String TYPE_DBFUNCTIONS
static final String TYPE_DBFUNCT
static final String TYPE_FUNCTS
static final String TYPE_FUNCT
static final String TYPE_PROCS
static final String TYPE_PROC
static final String TYPE_EXEC_METHODS
static final String TYPE_EXEC_METHOD
static final String TYPE_PROCS_FUNCS
static final String TYPE_PACKAGES
static final String TYPE_PACKAGE
static final String TYPE_PACKAGE_BODY
static final String TYPE_ASSEMBLIES
static final String TYPE_ASSEMBLY
static final String TYPE_TRIGGERS
static final String TYPE_TRIGGER
static final String TYPE_SEQUENCES
static final String TYPE_SEQUENCE
static final String TYPE_USER_TYPES
static final String TYPE_USER_TYPE
static final String TYPE_DB_LINKS
static final String TYPE_DB_LINK
static final String TYPE_DIRECTORIES
static final String TYPE_DIRECTORY
static final String TYPE_QUEUES
static final String TYPE_QUEUE
static final String TYPE_QUEUE_TABLES
static final String TYPE_QUEUE_TABLE
static final String TYPE_XML_SCHEMAS
static final String TYPE_XML_SCHEMA
static final String TYPE_FUNCT_PARAMETERS
static final String TYPE_PROC_PARAMETERS
static final String TYPE_PARAMETERS
static final String TYPE_PARAMETER
static final String TYPE_TABLES
static final String TYPE_WORKSHEETS
static final String TYPE_DATA_SET
static final String TYPE_VIEWS
static final String TYPE_SYSTEM_TABLES
static final String TYPE_SYSTEM_VIEWS
static final String TYPE_GLOBAL_TEMPORARIES
static final String TYPE_LOCAL_TEMPORARIES
static final String TYPE_TEMPORARY_TABLES
static final String TYPE_TEMPORARY_VIEWS
static final String TYPE_ALIASES
static final String TYPE_SYNONYMS
static final String TYPE_NICKNAME
static final String TYPE_COLUMNS
static final String TYPE_INDEXES
static final String TYPE_PKS
static final String TYPE_FKS
static final String TYPE_EKS
static final String TABLE_PRIVS
static final String ALL_REFS
static final String TABLE_PRIV
static final String TYPE_TYPE
static final String TYPE_TABLE
static final String TYPE_VIEW
static final String TYPE_ALIAS
static final String TYPE_SYNONYM
static final String TYPE_COLUMN
static final String TYPE_INDEX
static final String TYPE_PK
static final String TYPE_FK
static final String TYPE_EK
static final String TYPE_INDEX_COLUMNS
static final String TYPE_PK_COLUMNS
static final String TYPE_FK_COLUMNS
static final String TYPE_EK_COLUMNS
static final String TYPE_INDEX_COLUMN
static final String TYPE_PK_COLUMN
static final String TYPE_FK_COLUMN
static final String TYPE_EK_COLUMN
static final String TYPE_JAVA_CLASSES
static final String TYPE_CLASS
static final String METADATA_DELIMITER
static final String DB_DELIMITER
static final String TABLES_DATASET_TYPE
static final String VIEWS_DATASET_TYPE
static final String SYNONYMS_DATASET_TYPE
static final String DEFAULT_METHOD
static final String DEFAULT_TYPE
static final String TYPE_FILE
static final String TYPE_WORKSHEET
static final String TYPE_RECYCLE_BIN
static final String TYPE_RECYCLE_BIN_ITEM
static final String TYPE_CONSTRAINTS
boolean allowNotDefault()
String asText(String catalog, String schema, String pattern, String type, String metadataId) throws Exception
catalog
- the catalogschema
- the schemapattern
- the patterntype
- the typemetadataId
- the metadata idException
- in case of any errorString createAsText(String sql, String catalog, String schema, String pattern, String type)
sql
- the sqlcatalog
- the catalogschema
- the schemapattern
- the patterntype
- the typeMap<Integer,List<FieldDef>> discoverDatabaseTypes() throws Exception
Exception
- in case of any errorString dropAsText(String catalog, String schema, String pattern, String type) throws Exception
catalog
- the catalogschema
- the schemapattern
- the patterntype
- the typeException
- in case of any errorString executeAsText(String catalog, String schema, String pattern, String type, String metadataId) throws Exception
catalog
- the catalogschema
- the schemapattern
- the patterntype
- the typemetadataId
- the metadata idException
- in case of any errorvoid free()
String getAllowedSchema()
Set<String> getCatalogSchemaMetadataAllowed()
ConnectionParamsProvider<Alias> getConnectionParamsProvider()
Driver getDriver()
String getFullObjectName(String pattern, String catalog, String schema)
pattern
- the patterncatalog
- the catalogschema
- the schemaDataSet getMetadataByType(String catalog, String schema, String pattern, String type, String metadataId) throws Exception
catalog
- the catalogschema
- the schemapattern
- the patterntype
- the typemetadataId
- the metadata idException
- in case of any errorDataSet getMetadataByTypePreserveException(String catalog, String schema, String pattern, String type, String metadataId) throws Exception
catalog
- the catalogschema
- the schemapattern
- the patterntype
- the typemetadataId
- the metadata idException
- in case of any errorString getMetadataTypeByParentType(String parentType)
parentType
- the parent typeList<Object> getMetadataTypes(String parentType) throws Exception
parentType
- the parent typeException
- in case of any errorString getName()
String getObjectName(String pattern)
pattern
- the patternString getObjectOwnerName(String pattern)
pattern
- the patternKeyValue[] getObjectTypes()
Set<String> getTableMetadataAllowed()
Set<String> getTopLevelAllowed()
List<Object> getTopLevelDbObjects() throws Exception
Exception
- in case of any errorString getTypeByTypeFieldValue(String value)
value
- the valueString getTypeField()
Map<String,String> getTypeMethods()
boolean hasCatalogs()
boolean hasMetadataTypes(String type)
type
- the typeboolean hasSchemas()
void init(ConnectionFactory connectionFactory, ConnectionParamsProvider<Alias> connectionParamsProvider, Driver driver) throws Exception
connectionFactory
- the connection factoryconnectionParamsProvider
- the connection params providerdriver
- the driverException
- in case of any errorboolean isDatabaseCurrent(String compareTo)
compareTo
- the compare toboolean needToPopulate(String type)
type
- the typeDataSet searchDatabase(DatabaseFilter filter) throws Exception
filter
- the search filterException
- in case of any errorboolean supportsAsText(String type)
type
- the typeboolean supportsDrop(String type)
type
- the typeboolean supportsExecute(String type)
type
- the typeboolean supportsRefresh(String type)
type
- the typeboolean supportsSearchDatabase()
Copyright © 2010-2020 Toolsverse. All Rights Reserved.