org.plasma.provisioning.cli
Class RDBTool

java.lang.Object
  org.plasma.provisioning.cli.ProvisioningTool
      org.plasma.provisioning.cli.RDBTool

All Implemented Interfaces:

RDBConstants

public class RDBTool
extends ProvisioningTool
implements RDBConstants

The Relational Database (RDB) Tool is used to provision various artifacts useful for management and migration to and from Relational Database.

Usage: java org.plasma.provisioning.cli.RDBTool [-command <create | drop | truncate | reverse>] [dialect <oracle | mysql, ...>] [dest-file] [dest-namespace-URI] [schema1, schema2, ...]*

Where:

-command is one of [create | drop | truncate | reverse]. The create, drop and truncate commands generate a complete DDL script representing the configured set of UML artifacts. The reverse command interrogates one or more database schemas, using vendor specific system tables, and generates a UML model which captures the the physical attributes of the database including all tables, columns, constraints, sequences and comments. Check constraints where the search condition involves limiting the associated property to a list of values are captured and used to produce annotated UML enumerations which are automatically linked as UML enumeration constraints to the source property. Note the reverse command requires a Plasma JDBC service to be configured within the Plasma configuration, where the user specified has read privileges for system schema(s) for the respective database vendor

dialect is one of [oracle | mysql, ...] and the specific database product version is determined at runtime

dest-file is the file name for the target artifact

namespaces the destination or target namespace URIs. These are separated by commas and mapped (in order) to schema names in the resulting document

schema1, schema2, ... is a set of source RDB schemas separated by commas. This argument reverse command as the physical schema names and namespace URI associations are expected to be part of the configured PlasmaSDO UML Profile annotated UML model artifact(s).

Field Summary

Fields inherited from interface org.plasma.provisioning.rdb.RDBConstants

ARTIFACT_NAMESPACE_MYSQL_5_5, ARTIFACT_NAMESPACE_MYSQL_ANY, ARTIFACT_NAMESPACE_ORACLE_11G_SYS, ARTIFACT_NAMESPACE_ORACLE_ANY_SYS, ARTIFACT_RESOURCE_MYSQL, ARTIFACT_RESOURCE_ORACLE

Constructor Summary

RDBTool()

Method Summary

static void

main(String[] args) Command line entry point.

Methods inherited from class org.plasma.provisioning.cli.ProvisioningTool

createStagingModel, createTempFileFromJar, readContent, regenerate, validateStagingModel, writeContent

Methods inherited from class java.lang.Object

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

Constructor Detail

RDBTool

public RDBTool()

Method Detail

main

public static void main(String[] args)
                 throws JAXBException,
                        SAXException,
                        IOException

Command line entry point.

Usage: java org.plasma.provisioning.cli.RDBTool [-command <create | drop | truncate | reverse>] [dialect <oracle | mysql, ...>] [dest-file] [dest-namespace-URI] [schema1, schema2, ...]*

Where:

-command is one of [create | drop | truncate | reverse]. The create, drop and truncate commands generate a complete DDL script representing the configured set of UML artifacts. For these commands the schema-name, namespace-uri pairs are not applicable as the physical schema names and namespace URI associations are expected to be part of the configured PlasmaSDO UML Profile annotated UML model artifact(s). The reverse command interrogates one or more database schemas, using vendor specific system tables, and generates a UML model which captures the the physical attributes of the database including all tables, columns, constraints, sequences and comments. Check constraints where the search condition involves limiting the associated property to a list of values are captured and used to produce annotated UML enumerations which are automatically linked as UML enumeration constraints to the source property.

dialect is one of [oracle | mysql, ...] and the specific database product version is determined at runtime

dest-file is the file name for the target artifact

dest-namespace-URI is the namespace URI used to annotate the UML package(s). If more than one schema is used, each schema name is used as a suffix. If no dest-namespace-URI is present a nemsapace URI based on the destination file name is constructed.

schema1, schema2, ... is a set of source RDB schemas separated by commas

Throws:

JAXBException

SAXException

IOException