Rdb
A relational database service
Overview
Rdb:
A relational database service
Design
- Super Type
- Service
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Notification |
false
|
Template Directory |
|
Data View |
Children,
proximity:
1
|
Logger Name
|
|
Constraints
Allowed Child Dependencies
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
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.
assertServiceIsDown
Confirm the Rdb service is down.
- Usage
-
assertServiceIsDown -installroot <> [-instance <>] [-rdbpassword <>] [-rdbusername <>] [-strategy <>]
Options
Option
|
Description
|
installroot
|
path to database install
|
instance
|
Instance name
|
rdbpassword
|
Database user's password
|
rdbusername
|
Database user name
|
strategy
|
Database strategy name
|
assertServiceIsUp
Confirm the Rdb service is process is running.
- Usage
-
assertServiceIsUp -installroot <> [-instance <>] [-rdbpassword <>] [-rdbusername <>] [-strategy <>]
Options
Option
|
Description
|
installroot
|
path to database install
|
instance
|
Instance name
|
rdbpassword
|
Database user's password
|
rdbusername
|
Database user name
|
strategy
|
Database strategy name
|
dispatchCmd
Dispatch the command to selected child dependency.
- Usage
-
dispatchCmd [-buildstamp <>] -command <> [-keepgoing] [-resourcename <.*>] [-resourceorder <[^.]*>] [-resourcetype <[^.]*>] [-sortorder <ascending>] [-targetdir <>]
Options
Option
|
Description
|
buildstamp
|
Unique build and deployment identifier
|
command
|
command to dispatch
|
keepgoing
|
If true, all iterations of the called workflow will be executed, even if a task in one or more of them fails.
|
resourcename
|
resource name pattern
|
resourceorder
|
resource order name
|
resourcetype
|
resource type name
|
sortorder
|
order to sort resources
|
targetdir
|
target directory
|
Export
Call each RdbSchema dependency to dump its database schema to a package.
- Usage
-
Export -buildstamp <> [-command <Export>] [-resourcetype <RdbSchema>] [-targetdir <>]
Workflow
-
dispatchCmd
Options
Option
|
Description
|
buildstamp
|
Unique build identifier
|
command
|
Command to execute
|
resourcetype
|
Type of resource to dispatch
|
targetdir
|
target directory
|
deployRdbSchemas
Call each RdbSchema dependency to import its exportfile.
- Usage
-
deployRdbSchemas -buildstamp <> [-command <Deploy>] [-resourcetype <RdbSchema>]
Workflow
-
dispatchCmd
Options
Option
|
Description
|
buildstamp
|
Unique build identifier
|
command
|
Command to execute
|
resourcetype
|
Resource type to dispatch
|
Deploy
Call each RdbSchema dependency to run their Deploy cycle.
- Usage
-
Deploy [-buildstamp <>]
Workflow
-
deployRdbSchemas
Options
Option
|
Description
|
buildstamp
|
Unique build identifier
|
Related Types
The following types are defined for use with Rdb.
RdbSetting
Overview
RdbSetting:
an Rdb setting
Design
- Super Type
- Setting
Role |
Abstract. (Objects cannot be created.)
|
Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
RdbUserName
Overview
RdbUserName:
A user for a schema
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbUserName
|
settingValue |
RdbPassword
Overview
RdbPassword:
A schema user's password
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Constraints
Attributes
Exported Attributes
Name |
Property |
rdbPassword
|
settingValue |
RdbInstanceName
Overview
RdbInstanceName:
Stores the value of the database instance name
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbInstanceName
|
settingValue |
RdbInstallRoot
Overview
RdbInstallRoot:
Database installation root
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbInstallRoot
|
settingValue |
RdbExportDir
Overview
RdbExportDir:
Directory where database export files are written
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbExportDir
|
settingValue |
RdbConfigFile
Overview
RdbConfigFile:
Database configuration file
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbConfigFile
|
settingValue |
RdbStrategyModule
Overview
RdbStrategyModule:
Adapter to database
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbStrategy
|
settingValue |