AtgRdb
A relational database service
Overview
AtgRdb:
A relational database service
Design
- Super Type
-
AtgService
| 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 |
|
atgRdbType
|
oracle |
|
dispatchOptions
|
installroot,buildstamp |
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.
switchSchemaBinding
updates the model with specified schema object
- Usage
-
switchSchemaBinding [-fromschema <>] -schematype <> -toschema <>
Options
|
Option
|
Description
|
|
fromschema
|
name of schema to switch from
|
|
schematype
|
type name
|
|
toschema
|
name of schema to switch to
|
Schemas-ExportDmp
Calls each AtgRdbSchema 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.atgRdbInstanceName}>] [-rdbpassword <${entity.attribute.atgRdbPassword}>] [-rdbusername <${entity.attribute.atgRdbUserName}>]
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 AtgRdbSchema resource to import its dump file package
- Usage
-
Schemas-ImportDmp -buildstamp <> [-command <ImportDmp>] [-installroot <>] [-resourcetype <.*RdbSchema>] [-schema <>]
Workflow
- dispatchCmd
Options
|
Option
|
Description
|
|
buildstamp
|
|
|
command
|
Command to execute
|
|
installroot
|
installroot of dmp package
|
|
resourcetype
|
Resource type to dispatch
|
|
schema
|
optional schema name
|
generateDSXml
generates a datasource xml file
- Usage
-
generateDSXml -path <> [-rdbConnection <>] [-rdbDriver <>] [-resourcename <.*>] [-resourcetype <[^.]*Schema>]
Options
|
Option
|
Description
|
|
path
|
path to file to generate
|
|
rdbConnection
|
rdb connection string
|
|
rdbDriver
|
rdb connection string
|
|
resourcename
|
regex of name of schema resources to apply to
|
|
resourcetype
|
type name regex for schema types to apply command to
|
Related Types
The following types are defined for use with AtgRdb.
AtgRdbSetting
Overview
AtgRdbSetting:
an AtgRdb setting
Design
- Super Type
- Setting
| Role |
Abstract. (Objects cannot be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
AtgRdbDriver
Overview
AtgRdbDriver:
Specifies the Database Driver
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbDriver
|
settingValue |
AtgRdbConnection
Overview
AtgRdbConnection:
Specifies the Database Connection
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbConnection
|
settingValue |
AtgRdbPort
Overview
AtgRdbPort:
Specifies the Database Connection Port
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbPort
|
settingValue |
AtgRdbType
Overview
AtgRdbType:
Specifies the unique key value identifying which type database type is in use (e.g. "mssql" or "oracle", etc)
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbType
|
settingValue |
AtgRdbUserName
Overview
AtgRdbUserName:
A user for a schema
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbUserName
|
settingValue |
AtgRdbPassword
Overview
AtgRdbPassword:
A schema user's password
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbPassword
|
settingValue |
AtgRdbEncryptedPassword
Overview
AtgRdbEncryptedPassword:
An encrypted rdb user's password
Design
- Super Type
-
AtgRdbPassword
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValueEncrypted |
|
|
true |
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbPassword
|
settingValue |
AtgRdbInstanceName
Overview
AtgRdbInstanceName:
Stores the value of the database instance name
Design
- Super Type
-
AtgRdbSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
atgRdbInstanceName
|
settingValue |
