MysqlRdb
A MySQL database instance
Overview
Design
- Super Type
- Rdb
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Notification | false |
Template Directory | |
Data View | Children, proximity: 1 |
Logger Name | MysqlRdb |
Constraints
Allowed Child Dependencies
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Deployment
- Node
- Site
Attributes
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.
Docs-Generate
generates all defined docs
- Usage
- Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-pass <ctierpass>] [-port <3316>] [-user <ctier>]
Options
Option | Description |
---|---|
archivedir | dir to store current output docs |
pass | db pass |
port | listen port |
user | dbuser |
assertServiceIsDown
checks if the service is down
- Usage
- assertServiceIsDown
assertServiceIsUp
checks if the service is running
- Usage
- assertServiceIsUp
installDb
installs the database
- Usage
- installDb
startService
starts the service
- Usage
- startService
stopService
stops the service
- Usage
- stopService
Prepare
creates the db and prepares it for use
- Usage
- Prepare
Workflow
- Install
- Stop
- Configure
- installDb
- Start
- Schemas-Prepare
Related Types
The following types are defined for use with MysqlRdb.
MysqlSetting
Overview
MysqlSetting: A MySQL configuration setting
Design
- Super Type
- Setting
Role | Abstract. (Objects cannot be created.) |
Instance Names | Unique |
Constraints
Allowed Parent Dependencies
MysqlBasedir
Overview
MysqlBasedir: The MySQL installation directory
Design
- Super Type
- MysqlSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
mysqlBasedir | settingValue |
MysqlDatadir
Overview
MysqlDatadir: The MySQL data directory
Design
- Super Type
- MysqlSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
mysqlDatadir | settingValue |
MysqlNode
Overview
MysqlNode: The node hosting the MySQL instance
Design
- Super Type
- MysqlSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
mysqlNode | settingValue |
MysqlPort
Overview
Design
- Super Type
- Port
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
mysqlPort | settingValue |
MysqlLoadScript
Overview
MysqlLoadScript: Schema load script used by MySQL
Design
- Super Type
- MysqlSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
mysqlLoadScript | settingValue |
MysqlPassword
Overview
MysqlPassword: A MySQL schema username and password
Design
- Super Type
- MysqlSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property |
---|---|
pass | settingValue |
user | settingType |