Activity - extractDatabaseSchema

Activity Type: Relational

Description

Retrieve metadata from a database. Note that output from this activity must be converted into a string representation, e.g. using the databaseSchemaToXML activity, before it can be delivered in the response or to an output stream activity.

Examples

<extractDatabaseSchema name="extract">
  <output name="schema">
</extractDatabaseSchema>

<extractDatabaseSchema name="extract">
  <getTables namesOnly="true">
  <output name="schema">
</extractDatabaseSchema>

<extractDatabaseSchema name="extract">
  <getTables schemaNamePattern="ogsadai" tableNamePattern="littleblackbook">
  <output name="schema">
</extractDatabaseSchema>

Specification

Element extractDatabaseSchema:

• Attribute name - unique name for the activity within the scope of a request.
• Element getTables (optional) - define table specifics.
  • Attribute namesOnly (optional) - boolean indicating whether retrieve only the names of all tables or the full metadata. Default is false.
  • Attribute catalogName (optional) - the catalog where the retrieved tables reside
  • Attribute schemaNamePattern (optional) - the schema where the retrieved tables reside
  • Attribute tableNamePattern (optional) - the name of the table for which to retrieve metadata
• Element output (required) - output stream which produces a table metadata object for each table that matches the input parameters.
  • Attribute name - name of the activity's output stream.

Data Resource Accessor

This activity requires a data resource accessor that implements the following interface: uk.org.ogsadai.dataresource.JDBCConnectionProvider

Input and Output Types

• Output: output — uk.org.ogsadai.converters.databaseschema.TableMetaData

XML Schema

OGSA-DAI/schema/ogsadai/xsd/activities/extract_database_schema.xsd

Class

uk.org.ogsadai.activity.relational.ExtractDatabaseSchemaActivity

Client Toolkit Class

uk.org.ogsadai.client.toolkit.activity.relational.ExtractDatabaseSchema