PostgresRdb
PostgreSQL server system service module
Overview
PostgresRdb:
PostgreSQL server system service module
Design
- Super Type
- Rdb
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | PostgresRdb |
Constraints
Allowed Child Dependencies
- PostgresRdbPgData 1
- PostgresRdbPgEngine 1
- PostgresRdbSchema
- RdbConnection1
- RdbDriver1
- RdbInstanceName1
- RdbPassword1
- RdbPort1
- RdbType1
- RdbUserName1
- SystemServiceScript1
- SystemServiceUseSudo1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Service
- Site
Attributes
Defaults for Imported Attributes
| Name | Default |
|---|---|
| pgData | /var/lib/pgsql/data |
| pgEngine | /usr/bin |
| rdbConnection | localhost |
| rdbDriver | org.postgresql.Driver |
| rdbInstanceName | postgres |
| rdbPassword | postgres |
| rdbPort | 5432 |
| rdbType | postgresql |
| rdbUserName | postgres |
| systemServiceScript | postgresql |
Commands
Deploy
Run the service deployment cycle, stopping installing package dependencies, configuring and the starting it.
- Usage
- Deploy
Workflow
- Stop
- Packages-Install
- Configure
- Start
assertServiceIsUp
Check whether the specified system service is up
- Usage
- assertServiceIsUp [-script <>] [-usesudo <>]
Options
| Option | Description |
|---|---|
| script | System service script |
| usesudo | Whether or not to use sudo |
Configure
Run the configuration cycle for the deployment.
- Usage
- Configure
Workflow
InitDb
Invoke the PostgreSQL server database initialization program (initdb)
- Usage
- InitDb [-buildstamp <>] [-pgdata <>] [-pgengine <>]
Options
| Option | Description |
|---|---|
| buildstamp | build identifer. currently ignored |
| pgdata | PGDATA directory |
| pgengine | PGENGINE directory |
Docs-Generate
Generate the PostgreSQL server configuration files
- Usage
- Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-buildstamp <>] [-pgdata <>]
Options
| Option | Description |
|---|---|
| archivedir | dir to store current output docs |
| buildstamp | build identifer. currently ignored |
| pgdata | PGDATA directory |
Related Types
The following types are defined for use with PostgresRdb.
PostgresRdbSetting
Overview
PostgresRdbSetting:
PostgreSQL server configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
PostgresRdbPgEngine
Overview
PostgresRdbPgEngine:
PostgreSQL program installation directory
Design
- Super Type
- PostgresRdbSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| pgEngine | settingValue |
PostgresRdbPgData
Overview
PostgresRdbPgData:
PostgreSQL server data directory
Design
- Super Type
- PostgresRdbSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| pgData | settingValue |