AtgRdbSchema
Represents a database schema
Overview
AtgRdbSchema:
Represents a database schema
Design
- Super Type
- Deployment
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- AtgRdbDataSourceName 1
- AtgRdbInstallRoot1
- AtgRdbSchemaName 1
- AtgRdbSchemaPassword 1
- AtgRdbSchemaTransactionIsolation 1
- AtgRdbSchemaType 1
- AtgRdbSchemaUserName 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- AtgRdb
- Node
Attributes
Defaults for Imported Attributes
| Name | Default |
|---|---|
| atgRdbInstallRoot | ${user.home}/dumps |
| atgRdbSchemaName | catalog |
| atgRdbSchemaTransactionIsolation | TRANSACTION_READ_COMMITTED |
| atgRdbSchemaType | catalog |
| rdbMaxPoolSize | 30 |
| rdbMinPoolSize | 5 |
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.
export
Exports the schema
- Usage
- export -buildstamp <> [-instance <${AtgRdb.entity.attribute.atgRdbInstance}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-rdbhome <>] [-schema <${entity.attribute.atgRdbSchemaName}>] [-username <${entity.attribute.atgRdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| buildstamp | build stamp |
| instance | Database server instance name |
| password | Schema user's password |
| rdbhome | path to database install |
| schema | Database schema name |
| username | Schema user name |
import
Imports the schema
- Usage
- import -buildstamp <> [-dmp_file <${entity.attribute.atgRdbSchemaType}-${opts.buildstamp}.dmp>] [-failonwarnings <>] [-fromuser <${entity.attribute.atgRdbSchemaFromUser}>] -installroot <> [-instance <${AtgRdb.entity.attribute.atgRdbInstanceName}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-rdbhome <>] [-schema <${entity.attribute.atgRdbSchemaName}>] [-username <${entity.attribute.atgRdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| buildstamp | build stamp |
| dmp_file | dump file to import |
| failonwarnings | if arg true, fail if there are import warnings |
| fromuser | Schema user name from which to import |
| installroot | installroot of dmp package |
| instance | Database server instance name |
| password | Schema user's password |
| rdbhome | path to database install |
| schema | Database schema name |
| username | Schema user name into which to import |
ImportDmp
Imports the dmp file
- Usage
- ImportDmp -buildstamp <> -installroot <> [-schema <>]
Workflow
Options
| Option | Description |
|---|---|
| buildstamp | Unique build identifier |
| installroot | installroot of dmp package |
| schema | optional schema name |
Status
Gets the status of the service
- Usage
- Status
Workflow
ExportDmp
exports and uploads a dump
- Usage
- ExportDmp -buildstamp <>
Workflow
Error Handler
| Notify |
|
Options
| Option | Description |
|---|---|
| buildstamp | buildstamp |
registerDmp
registers the dump file as an object
- Usage
- registerDmp [-buildstamp <>] [-dmp_file <>] [-packagetype <AtgRdbData>] [-release <>] [-tstampformat <yyyymmddhhmm>] [-version <>]
Options
| Option | Description |
|---|---|
| buildstamp | package build timestamp |
| dmp_file | dumpfile |
| packagetype | type name |
| release | version release |
| tstampformat | build timestamp format |
| version | package version |
upSchema
Checks schema is available in the designated instance
- Usage
- upSchema [-instance <${AtgRdb.entity.attribute.atgRdbInstance}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-schema <${entity.attribute.atgRdbSchemaName}>] [-username <${entity.attribute.atgRdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| instance | Database server instance name |
| password | Schema user's password |
| schema | Database schema name |
| username | Schema user name |
appendDatasourceContentXml
generate the datasource content XML and append to a file
- Usage
- appendDatasourceContentXml -file <> -rdbConnection <> -rdbDataSourceName <> -rdbDriver <> [-rdbMaxPoolSize <>] [-rdbMinPoolSize <>] -rdbSchemaPassword <> -rdbSchemaUserName <> -rdbType <>
Options
| Option | Description |
|---|---|
| file | file to append content to |
| rdbConnection | name for the db |
| rdbDataSourceName | name for the db |
| rdbDriver | name for the db |
| rdbMaxPoolSize | maximum number of pool connections |
| rdbMinPoolSize | minimum number of pool connections |
| rdbSchemaPassword | name for the db |
| rdbSchemaUserName | name for the db |
| rdbType | type of db |
Related Types
The following types are defined for use with AtgRdbSchema.
AtgRdbSchemaType
Overview
AtgRdbSchemaType:
A schema name
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgRdbSchemaType | settingValue |
AtgRdbSchemaTransactionIsolation
Overview
AtgRdbSchemaTransactionIsolation:
Schema Transaction Isolation value
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaTransactionIsolation | settingValue |
AtgRdbSchemaName
Overview
AtgRdbSchemaName:
A schema name
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgRdbSchemaName | settingValue |
AtgRdbDataSourceName
Overview
AtgRdbDataSourceName:
JNDI data source name for connecting to the schema
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgRdbDataSourceName | settingValue |
AtgRdbSchemaUserName
Overview
AtgRdbSchemaUserName:
A user for a schema
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgRdbSchemaFromUser | settingType |
| atgRdbSchemaUserName | settingValue |
AtgRdbSchemaPassword
Overview
AtgRdbSchemaPassword:
A schema user's password
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgRdbSchemaPassword | settingValue |
| rdbSchema | settingType |
AtgRdbSchemaEncryptedPassword
Overview
AtgRdbSchemaEncryptedPassword:
An encrypted schema user's password
Design
- Super Type
- AtgRdbSchemaPassword
| 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 |
|---|---|
| atgRdbSchemaPassword | settingValue |
| rdbSchema | settingType |
AtgRdbMinPoolSize
Overview
AtgRdbMinPoolSize:
DataSource minimum connections
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbMinPoolSize | settingValue |
AtgRdbMaxPoolSize
Overview
AtgRdbMaxPoolSize:
DataSource maximum connections
Design
- Super Type
- AtgRdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbMaxPoolSize | settingValue |
AtgRdbSchemaSetting
Overview
AtgRdbSchemaSetting:
an AtgRdbSchema setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |