AtgRdb
A relational database service
Overview
AtgRdb:
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
- AtgCatalogSchema 1
- AtgRdbData
- AtgRdbInstanceName 1
- AtgRdbPassword 1
- AtgRdbSchema
- AtgRdbSchema
- AtgRdbType 1
- AtgRdbUserName 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- AtgCatalogBuilder
- AtgDataBuilder
- AtgSite
- Node
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 |
Packages-Install
installs all the package dependencies
- Usage
- Packages-Install [-buildstamp <>] [-packagetype <[^.]*>] [-resourcetype <AtgRdbSchema>]
Options
| Option | Description |
|---|---|
| buildstamp | Unique build and deployment identifier (ignored) |
| packagetype | type of packages to install |
| resourcetype | Optional schema resource type |
Schemas-ExportDmp
Calls each AtgRdbSchema resource to export its database schema to a dump package
- Usage
- Schemas-ExportDmp -buildstamp <> [-command <ExportDmp>] [-resourcetype <AtgRdbSchema>]
Workflow
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 |
Update
Runs the AtgRdb update process
- Usage
- Update -buildstamp <> [-resourcetype <AtgRdbSchema>]
Workflow
Options
| Option | Description |
|---|---|
| buildstamp | Unique build identifier |
| resourcetype | Optional schema resource type |
Schemas-ImportDmp
Calls each AtgRdbSchema resource to import its dump file package
- Usage
- Schemas-ImportDmp -buildstamp <> [-command <ImportDmp>] [-resourcetype <AtgRdbSchema>]
Workflow
Options
| Option | Description |
|---|---|
| buildstamp | Unique build identifier |
| command | Command to execute |
| resourcetype | Resource type to dispatch |
dispatchCmd
Dispatches a command to selected resources
- Usage
- dispatchCmd [-buildstamp <>] -command <> [-keepgoing] [-resourcename <.*>] [-resourceorder <[^.]*>] [-resourcetype <[^.]*>] [-sortorder <ascending>]
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 |
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
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 |
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 |