public interface AQMetadata
Most of the methods take a database and/or schema parameter. This will have different affects according to the database type you are connecting to.
Here is a list of database vendors and whether they take a database and/or a schema parameter :-
Database | use database | use schema |
---|---|---|
Apache Cassandra | Y | N |
Apache Derby | N | Y |
Apache Hive | Y | N |
DB2 LUW | N | Y |
DB2 iSeries | N | Y |
DB2 z/OS | N | Y |
Greenplum | N | Y |
Informix | Y | N |
Microsoft Excel | Y | Y |
Microsoft SQL Server | Y | Y |
MongoDB | Y | N |
MySQL | Y | N |
nCluster | N | Y |
Oracle | N | Y |
ParAccel | N | Y |
PostgreSQL | N | Y |
SQLite | N | N |
Sybase Anywhere | Y | Y |
Sybase ASE | Y | Y |
Sybase IQ | Y | Y |
TeraData | Y | N |
Vertica | N | Y |
Windows Azure | Y | Y |
Modifier and Type | Method and Description |
---|---|
AQArrayType |
extractArrayType(String database,
String schema,
String name)
To get an array type specified from the database.
|
AQArrayType[] |
extractArrayTypes(String database,
String schema)
To get a list of array types from the database schema.
|
AQAssembly[] |
extractAssemblies(String database)
To get a list of assembly objects from the database.
|
AQAsymmetricKey[] |
extractAsymmetricKeys(String database)
To get a list of symmetric keys from the database.
|
AQCertificate[] |
extractCertificates(String database)
To get a list of the certificates from the database.
|
AQCluster |
extractCluster(String database,
String schema,
String name)
To get a cluster specified from the schema.
|
AQCluster[] |
extractClusters(String database,
String schema)
To get a list of clusters from the schema.
|
AQDatabase |
extractDatabase(String name)
Returns a single AQDatabase element by database name.
|
AQDatabaseLink |
extractDatabaseLink(String database,
String schema,
String name)
To get a database link object.
|
AQDatabaseLink[] |
extractDatabaseLinks(String database,
String schema)
To get a list of database links.
|
AQDatabase[] |
extractDatabases()
Returns an array containing all the database elements that exist in the metadata object in
the form of AQDatabase Objects.
|
AQDataType |
extractDataType(String database,
String schema,
String name)
To get user defined data type object.
|
AQDataType[] |
extractDataTypes(String database,
String schema)
To get a list of user defined data types.
|
AQDefault |
extractDefault(String database,
String schema,
String name)
To get an user defined default object.
|
AQDefault[] |
extractDefaults(String database,
String schema)
To get a list of user defined defaults.
|
AQDimension |
extractDimension(String database,
String schema,
String name)
To get an AQDimension object specified by the user.
|
AQDimension[] |
extractDimensions(String database,
String schema)
To get an array of AQDimension objects.
|
AQEvent |
extractEvent(String database,
String schema,
String name)
To get an AQEvent object specified by the user.
|
AQEvent[] |
extractEvents(String database,
String schema)
To get an array of AQEvent objects.
|
AQFunction[] |
extractFunctions(String database,
String schema)
To get a list of user defined Functions.
|
AQIndex |
extractIndex(String database,
String schema,
String name)
To get an user defined index object.
|
AQIndex[] |
extractIndexes(String database,
String schema)
To get all indexes.
|
AQJavaResource |
extractJavaResource(String database,
String schema,
String name)
To get a java resource as specified by the user.
|
AQJavaResource[] |
extractJavaResources(String database,
String schema)
To get list of java resources.
|
AQJavaSource |
extractJavaSource(String database,
String schema,
String name)
To get a java source as specified by the user.
|
AQJavaSource[] |
extractJavaSources(String database,
String schema)
To get a list of java sources.
|
AQLanguage[] |
extractLanguages()
To get a list the languages supported by the server.
|
AQMatView |
extractMatView(String database,
String schema,
String name)
To get a materialized view from the database server as specified by the user.
|
AQMatViewLog |
extractMatViewLog(String database,
String schema,
String name)
To get a materialized view log from the database server as specified by the user.
|
AQMatViewLog[] |
extractMatViewLogs(String database,
String schema)
To get a list of materialized view logs.
|
AQMatView[] |
extractMatViews(String database,
String schema)
To get a list of materialized views.
|
AQNickname |
extractNickname(String database,
String schema,
String name)
To get the information of a table nickname specified by the user.
|
AQNickname[] |
extractNicknames(String database,
String schema)
To get a list of defined nicknames for tables in a database.
|
AQIndex[] |
extractNonSystemIndexes(String database,
String schema)
To get a list of user defined indexes.
|
AQObjectType |
extractObjectType(String database,
String schema,
String name)
To get information of object type as specified by the user.
|
AQObjectType[] |
extractObjectTypes(String database,
String schema)
To get a list of object types defined in the schema.
|
AQPackage |
extractPackage(String database,
String schema,
String name)
To get information on a database package object as specified by the user.
|
AQPackageBody[] |
extractPackageBodies(String database,
String schema)
To get a list of database package bodies.
|
AQPackageBody |
extractPackageBody(String database,
String schema,
String name)
To get information on a database package body object as specified by the user.
|
AQPackage[] |
extractPackages(String database,
String schema)
To get a list of packages from the database.
|
AQProcedure[] |
extractProcedures(String database,
String schema)
To get a list of store procedures from the database.
|
AQQueue |
extractQueue(String database,
String schema,
String name)
To get information on a database queue specified by the user.
|
AQQueue[] |
extractQueues(String database,
String schema)
To get a list of database queues.
|
AQRefreshGroup |
extractRefreshGroup(String database,
String schema,
String name)
To get information on a refresh group as specified by the user.
|
AQRefreshGroup[] |
extractRefreshGroups(String database,
String schema)
To get a list of refresh groups.
|
AQDatabaseLink[] |
extractRemoteServers(String database)
To get a list of remote databases.
|
AQRole |
extractRole(String database,
String schema,
String name)
To get a role from the database as specified by the user.
|
AQRole[] |
extractRoles(String database,
String schema)
To get a list of roles from the database.
|
AQRule |
extractRule(String database,
String schema,
String name)
To get rule from the database as specified by the user.
|
AQRule[] |
extractRules(String database,
String schema)
To get a list of rules from the database schema.
|
AQSchema |
extractSchema(String database,
String name)
To get information on the schema specified by the user.
|
AQSchema[] |
extractSchemas(String database)
To get a list of database schemas.
|
AQSegment |
extractSegment(String database,
String schema,
String name)
To get the information on the segment specified.
|
AQSegment[] |
extractSegments(String database,
String schema)
To get a list of segments from the database.
|
AQSequence |
extractSequence(String database,
String schema,
String name)
To get information on the sequence specified.
|
AQSequence[] |
extractSequences(String database,
String schema)
To get a list of sequences from the database.
|
AQSymmetricKey[] |
extractSymmetricKeys(String database)
To get a list of asymmetric keys from the database.
|
AQSynonym |
extractSynonym(String database,
String schema,
String name)
To get the specified synonym from the database.
|
AQSynonym[] |
extractSynonyms(String database,
String schema)
To get a list of synonyms from the database.
|
AQTable |
extractTable(String database,
String schema,
String name)
Returns a single AQDatabase element by database/Schema
|
AQTable[] |
extractTables(String database,
String schema)
Returns an array containing all the table elements that exist in the specified database/schema
in the form of AQTable Objects.
|
AQTableType |
extractTableType(String database,
String schema,
String name)
To get information on the specified table type.
|
AQTableType[] |
extractTableTypes(String database,
String schema)
To get a list of table types from the database.
|
AQTrigger |
extractTrigger(String database,
String schema,
String name,
String tableSchema,
String tableName)
To get information on a trigger specified by the trigger name, table and the name of the table schema.
|
AQTrigger[] |
extractTriggers(String database,
String schema)
To get a list triggers from the database.
|
AQUser |
extractUser(String database,
String schema,
String name)
To get information on a user as specified.
|
AQUser[] |
extractUsers(String database,
String schema)
To get a list of database users.
|
AQView |
extractView(String database,
String schema,
String name)
Returns a single AQView element by database & Schema
|
AQView[] |
extractViews(String database,
String schema)
To get a list of views from the database.
|
AQXmlSchemaCollection[] |
extractXmlSchemaCollections(String database)
To get a list of XML schema collections from the database.
|
String |
getCurrentDatabase()
Get the current database the connection is connected to.
|
String[] |
getDataTypes()
To get a list of valid data types supported by the server.
|
String |
getLeadingColumnQuoteIdentifier()
To get the database specific leading column quote identifier.
|
String |
getLeadingObjectQuoteIdentifier()
To get the database specific leading quote identifier.
|
String |
getStatementSeparator()
To get the database specific statement separator.
|
String |
getTrailingColumnQuoteIdentifier()
To get the database specific trailing column quote identifier.
|
String |
getTrailingObjectQuoteIdentifier()
To get the database specific trailing quote identifier.
|
boolean |
isApacheDerby()
To test if the server backed by this connection is an Apache Derby server.
|
boolean |
isAzure()
To test if the database backed by this connection is an Azure database.
|
boolean |
isBigQuery()
Aqua Data Server doesn't support BigQuery.
|
boolean |
isCassandra()
To test if the database backed by this connection is an Apache Cassandra database.
|
boolean |
isDB2()
To test if the server backed by this connection is a DB2 server.
|
boolean |
isDB2iSeries()
To test if the server backed by this connection is a DB2 iSeries server.
|
boolean |
isDB2zOS()
To test if the server backed by this connection is a DB2 zOS server.
|
boolean |
isExcel()
To test if the database backed by this connection is a Microsoft Excel database.
|
boolean |
isGreenplum()
To test if the server backed by this connection is a Greenplum server.
|
boolean |
isHana()
To test if the server backed by this connection is a SAP Hana server.
|
boolean |
isHive()
To test if the database backed by this connection is an Hive database.
|
boolean |
isInformix()
To test if the server backed by this connection is an Informix server.
|
boolean |
isMongoDB()
To test if the database backed by this connection is a MongoDB database.
|
boolean |
isMssql()
To test if the server backed by this connection is a MSSQL server.
|
boolean |
isMySQL()
To test if the server backed by this connection is a MySQL server.
|
boolean |
isNCluster()
To test if the server backed by this connection is a nCluster server.
|
boolean |
isNetezza()
To test if the server backed by this connection is a Netezza server.
|
boolean |
isOracle()
To test if the server backed by this connection is an Oracle server.
|
boolean |
isParAccel()
To test if the server backed by this connection is a ParAccel server.
|
boolean |
isPostgreSQL()
To test if the server backed by this connection is a PostgreSQL server.
|
boolean |
isRedShift()
To test if the server backed by this connection is a PostgreSQL server.
|
boolean |
isSQLite()
To test if the database backed by this connection is a SQLite database.
|
boolean |
isSybaseAnywhere()
To test if the server backed by this connection is a Sybase Anywhere server.
|
boolean |
isSybaseASE()
To test if the server backed by this connection is a Sybse ASE server.
|
boolean |
isSybaseIQ()
To test if the server backed by this connection is a Sybase IQ server.
|
boolean |
isTeradata()
To test if the server backed by this connection is a TeraData server.
|
boolean |
isVertica()
To test if the server backed by this connection is a Vertica server.
|
boolean |
isVoltDB()
To test if the server backed by this connection is a VoltDB server.
|
AQDatabase[] extractDatabases()
Not all Servers use multiple databases in a single server, so this method may not return more than a single element for some server types.
Informix, Microsoft SQL Server, MySQL, SybaseASE & TeraData use many databases with schemas per database and may return an array.
Apache Derby, DB2, DB2Iseries, DB2zOS, Oracle & OracleOCI are schema driven and will only return a single database.
Apache Cassandra, Greenplum, NCluster, PostgreSQL, SybaseAnywhere & SybaseIQ are database driven but you may only be connected to one database at a time and thus one database object extraction at a time.
AQDatabase extractDatabase(String name)
name
- The name of the database.AQTable[] extractTables(String database, String schema)
The database and schema parameters will have different affects according to the database type you are connecting to. for example:
SQL Server has databases & schemas
db2 / oracle only uses schemas
mysql only uses databases
database
- The name of the database.schema
- The name of the schema.AQTable extractTable(String database, String schema, String name)
The database and schema parameters will have different affects according to the database type you are connecting to. for example:
SQL Server has databases & schemas
db2 / oracle only uses schemas
mysql only uses databases
database
- The name of the database.schema
- The name of the schema.name
- The name of the table.AQLanguage[] extractLanguages()
AQSchema[] extractSchemas(String database)
database
- The name of the database.AQSchema extractSchema(String database, String name)
database
- The name of the database.name
- The name of the schema.AQAssembly[] extractAssemblies(String database)
database
- The name of the database.AQCertificate[] extractCertificates(String database)
database
- Name of the databaseAQDatabaseLink[] extractRemoteServers(String database)
database
- The name of the database.AQSymmetricKey[] extractSymmetricKeys(String database)
database
- The name of the database.AQAsymmetricKey[] extractAsymmetricKeys(String database)
database
- The name of the database.AQXmlSchemaCollection[] extractXmlSchemaCollections(String database)
database
- The name of the database.AQView[] extractViews(String database, String schema)
database
- The name of the database.schema
- The name of the schemaAQView extractView(String database, String schema, String name)
The database and schema parameters will have different affects according to the database type you are connecting to. for example:
SQL Server has databases & schemas
db2 / oracle only uses schemas
mysql only uses databases
database
- The database in which to retrieve data fromschema
- The schema in which to retrieve data fromname
- The name of the view which is to be extractedAQArrayType[] extractArrayTypes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQArrayType extractArrayType(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the array type.AQCluster[] extractClusters(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQCluster extractCluster(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the cluster.AQDatabaseLink[] extractDatabaseLinks(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQDatabaseLink extractDatabaseLink(String database, String schema, String name)
database
- Name of the database.schema
- Name of the schema.name
- Name of the database link.AQDataType[] extractDataTypes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQDataType extractDataType(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the user defined data type.AQDefault[] extractDefaults(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQDefault extractDefault(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the user defined default.AQDimension[] extractDimensions(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQDimension extractDimension(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the dimension.AQEvent[] extractEvents(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQEvent extractEvent(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the event.AQFunction[] extractFunctions(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQIndex[] extractIndexes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQIndex[] extractNonSystemIndexes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQIndex extractIndex(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the index.AQJavaResource[] extractJavaResources(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQJavaResource extractJavaResource(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the resource.AQJavaSource[] extractJavaSources(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQJavaSource extractJavaSource(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the java sourceAQMatView[] extractMatViews(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQMatView extractMatView(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the materialized view.AQMatViewLog[] extractMatViewLogs(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQMatViewLog extractMatViewLog(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the materialized view log.AQNickname[] extractNicknames(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQNickname extractNickname(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The nickname.AQObjectType[] extractObjectTypes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQObjectType extractObjectType(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the object type.AQPackage[] extractPackages(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQPackage extractPackage(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the package.AQPackageBody[] extractPackageBodies(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQPackageBody extractPackageBody(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the package body.AQQueue[] extractQueues(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQQueue extractQueue(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the queue.AQProcedure[] extractProcedures(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQSynonym[] extractSynonyms(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQSynonym extractSynonym(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the synonym.AQRefreshGroup[] extractRefreshGroups(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQRefreshGroup extractRefreshGroup(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the refresh group.AQRule[] extractRules(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQRule extractRule(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the rule.AQSegment[] extractSegments(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQSegment extractSegment(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the segment.AQSequence[] extractSequences(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQSequence extractSequence(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the sequence.AQTableType[] extractTableTypes(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQTableType extractTableType(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the table type.AQUser[] extractUsers(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQUser extractUser(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the user.AQRole[] extractRoles(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQRole extractRole(String database, String schema, String name)
database
- The name of the database.schema
- The name of the schema.name
- The name of the role.AQTrigger[] extractTriggers(String database, String schema)
database
- The name of the database.schema
- The name of the schema.AQTrigger extractTrigger(String database, String schema, String name, String tableSchema, String tableName)
database
- The name of the database.schema
- The name of the schema.name
- The name of the trigger.tableSchema
- The name of the schema where the table is associated with.tableName
- The name of the table where the trigger is associated with.String getTrailingObjectQuoteIdentifier()
String getLeadingObjectQuoteIdentifier()
String getStatementSeparator()
String[] getDataTypes()
boolean isOracle()
boolean isBigQuery()
boolean isMySQL()
boolean isMssql()
boolean isHana()
boolean isDB2()
boolean isDB2zOS()
boolean isDB2iSeries()
boolean isInformix()
boolean isSybaseASE()
boolean isSybaseAnywhere()
boolean isSybaseIQ()
boolean isApacheDerby()
boolean isNCluster()
boolean isTeradata()
boolean isNetezza()
boolean isParAccel()
boolean isPostgreSQL()
boolean isRedShift()
boolean isGreenplum()
boolean isVertica()
boolean isVoltDB()
boolean isSQLite()
boolean isAzure()
boolean isMongoDB()
boolean isHive()
boolean isCassandra()
boolean isExcel()
String getTrailingColumnQuoteIdentifier()
String getLeadingColumnQuoteIdentifier()
String getCurrentDatabase()
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.