RdbSchema

Represents a database schema

Overview
Design
Constraints
- Allowed Child Dependencies
- Allowed Parent Dependencies
Attributes
- Defaults for Imported Attributes
Commands
- assertSchemaIsDown
  - Options
- assertSchemaIsUp
  - Options
- runSqlScript
  - Options
- Export
  - Options
- runImport
  - Options
- Deploy
  - Workflow
  - Options
- runPreImportSql
  - Workflow
  - Options
- runPostImportSql
  - Workflow
  - Options
Related Types
- RdbStrategy
- RdbSchemaName
- RdbSchemaUserName
- RdbSchemaPassword
- RdbSchemaPreImportSqlScript
- RdbSchemaPostImportSqlScript
- RdbSchemaExportParams
- RdbSchemaSetting

Overview

RdbSchema: Represents a database schema

Design

Super Type: Deployment

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory
Data View	Children, proximity: 1
Logger Name

Constraints

Allowed Child Dependencies

RdbConfigFile¹
RdbDataPackage ¹
RdbExportDir¹
RdbInstallRoot¹
RdbSchemaExportParams ¹
RdbSchemaName ¹
RdbSchemaPassword ¹
RdbSchemaPostImportSqlScript ¹
RdbSchemaPreImportSqlScript ¹
RdbSchemaUserName ¹
RdbSqlPackage ¹
RdbStrategyModule¹

¹: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Attributes

Defaults for Imported Attributes

Name	Default
rdbInstallRoot	/path/to/rdb/installroot

Commands

Note

Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

assertSchemaIsDown

Confirm the schema is unavailable in the database instance.

Usage: assertSchemaIsDown [-config <>] -installroot <> [-instance <>] [-password <>] [-schema <>] [-strategy <>] [-username <>]

Options

Option	Description
config	Database configuration file
installroot	path to database install
instance	Database server instance name
password	Schema user's password
schema	Database schema name
strategy	Database strategy name
username	Schema user name

assertSchemaIsUp

Confirm the schema is available in the database instance.

Usage: assertSchemaIsUp [-config <>] -installroot <> [-instance <>] [-password <>] [-schema <>] [-strategy <>] [-username <>]

Options

Option	Description
config	Database configuration file
installroot	path to database install
instance	Database server instance name
password	Schema user's password
schema	Database schema name
strategy	Database strategy name
username	Schema user name

runSqlScript

Run the sql script.

Usage: runSqlScript [-buildstamp <>] [-config <>] [-failonwarnings <>] -installroot <> [-instance <>] [-password <>] [-schema <>] [-sqlscript <>] [-strategy <>] [-username <>]

Options

Option	Description
buildstamp	build stamp
config	Database configuration file
failonwarnings	if arg true, fail if there are import warnings
installroot	path to database install
instance	Database server instance name
password	Schema user's password
schema	Database schema name
sqlscript	sql script to run
strategy	Database strategy name
username	Schema user name

Export

Export the schema to a file.

Usage: Export -buildstamp <> [-config <>] [-exportfile <${entity.attribute.rdbExportDir}/${context.name}-${opts.buildstamp}.dmp>] -installroot <> [-instance <>] [-password <>] [-schema <>] [-strategy <>] [-targetdir <>] [-username <>]

Options

Option	Description
buildstamp	build stamp
config	Database configuration file
exportfile	Schema export file
installroot	path to database install
instance	Database server instance name
password	Schema user's password
schema	Database schema name
strategy	Database strategy name
targetdir	target directory
username	Schema user name

runImport

Process the supplied exportfile and import it to the schema.

Usage: runImport -buildstamp <> [-config <>] [-export_user <>] [-exportfile <${entity.attribute.rdbDataPackageInstallroot}/${entity.attribute.rdbDataPackageFilename}>] [-failonwarnings <>] -installroot <> [-instance <>] [-password <>] [-schema <>] [-sqlscript <>] [-strategy <>] [-username <>]

Options

Option	Description
buildstamp	build stamp
config	Database configuration file
export_user	from user
exportfile	dump file to import
failonwarnings	if arg true, fail if there are import warnings
installroot	path to database install
instance	Database server instance name
password	Schema user's password
schema	Database schema name
sqlscript	sql script to run before import
strategy	Database strategy name
username	Schema user name

Deploy

Run the process to load a schema export file, executing the pre- and post-import Sql scripts.

Downloads the schema exportfile, runs a pre-import SQL script, loads the data from the exportfile, and then executes a post-import SQL script

Usage: Deploy -buildstamp <>

Workflow

Packages-Install
runPreImportSql
runImport
runPostImportSql

Options

Option	Description
buildstamp	Unique build identifier

runPreImportSql

Run sql script prior to import.

Usage: runPreImportSql -buildstamp <> [-command <runSqlScript>] [-sqlscript <>]

Workflow

runSqlScript

Options

Option	Description
buildstamp	Unique build identifier
command	Command to execute
sqlscript	Sql script to run

runPostImportSql

Run sql script post import.

Usage: runPostImportSql -buildstamp <> [-command <runSqlScript>] [-sqlscript <>]

Workflow

runSqlScript

Options

Option	Description
buildstamp	Unique build identifier
command	Command to execute
sqlscript	Sql script to run

Related Types

The following types are defined for use with RdbSchema.

RdbStrategy

Overview

RdbStrategy: A schema name

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
rdbStrategy	settingValue

RdbSchemaName

Overview

RdbSchemaName: A schema name

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
rdbSchemaName	settingValue

RdbSchemaUserName

Overview

RdbSchemaUserName: A user for a schema

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
rdbSchemaUserName	settingValue
schemaFromUser	settingType

RdbSchemaPassword

Overview

RdbSchemaPassword: A schema user's password

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Attributes

Exported Attributes

Name	Property
rdbSchema	settingType
rdbSchemaPassword	settingValue

RdbSchemaPreImportSqlScript

Overview

RdbSchemaPreImportSqlScript: Sql script to run before runImport

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Attributes

Exported Attributes

Name	Property
rdbSchemaPreImportSqlScript	settingValue

RdbSchemaPostImportSqlScript

Overview

RdbSchemaPostImportSqlScript: Sql script to run post runImport

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Attributes

Exported Attributes

Name	Property
rdbSchemaPostImportSqlScript	settingValue

RdbSchemaExportParams

Overview

RdbSchemaExportParams: Sql import parameters

Design

Super Type: RdbSchemaSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Attributes

Exported Attributes

Name	Property
rdbSchemaImportParams	settingValue

RdbSchemaSetting

Overview

RdbSchemaSetting: an RdbSchema setting

Design

Super Type: Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

RdbSchema