Rdb
A relational database service
Overview
Rdb:
A relational database service
Design
- Super Type
-
SystemService
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
Attributes
Defaults for Imported Attributes
Name |
Default |
rdbConnection
|
jdbc:hsqldb:hsql://localhost:1701 |
rdbDriver
|
org.hsqldb.jdbcDriver |
rdbInstanceName
|
default |
rdbPassword
|
|
rdbPort
|
1701 |
rdbType
|
hsqldb |
rdbUserName
|
sa |
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.
Schemas-ExportDmp
Calls each RdbSchema resource to export its database schema to a dump package
- Usage
-
Schemas-ExportDmp -buildstamp <> [-command <ExportDmp>] [-resourcetype <.*RdbSchema>]
Workflow
- dispatchCmd
Options
Option
|
Description
|
buildstamp
|
Unique build identifier
|
command
|
Command to execute
|
resourcetype
|
Type of resource to dispatch
|
assertServiceIsUp
checks if the service is up
- Usage
-
assertServiceIsUp [-count <3>] [-rdbinstance <${entity.attribute.rdbInstanceName}>] [-rdbpassword <${entity.attribute.rdbPassword}>] [-rdbusername <${entity.attribute.rdbUserName}>]
Options
Option
|
Description
|
count
|
number of times to ping
|
rdbinstance
|
Instance name
|
rdbpassword
|
Database user's password
|
rdbusername
|
Database user name
|
Schemas-ImportDmp
Calls each RdbSchema resource to import its dump file package
- Usage
-
Schemas-ImportDmp [-command <ImportDmp>] [-resourcetype <.*RdbSchema>]
Workflow
- dispatchCmd
Options
Option
|
Description
|
command
|
Command to execute
|
resourcetype
|
Resource type to dispatch
|
Deploy
Runs the Rdb update process
- Usage
-
Deploy
Workflow
- Packages-Install
-
Schemas-ImportDmp
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
RdbDriver
Overview
RdbDriver:
Specifies the Database Driver
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbDriver
|
settingValue |
RdbConnection
Overview
RdbConnection:
Specifies the Database Connection
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbConnection
|
settingValue |
RdbPort
Overview
RdbPort:
Specifies the Database Connection Port
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbPort
|
settingValue |
RdbType
Overview
RdbType:
Specifies the unique key value identifying which type database type is in use (e.g. "mssql" or "oracle", etc)
Design
- Super Type
-
RdbSetting
Role |
Concrete. (Objects can be created.)
|
Instance Names |
Unique
|
Attributes
Exported Attributes
Name |
Property |
rdbType
|
settingValue |
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 |