RdbSchema
Represents a database schema
Overview
RdbSchema:
Represents a database schema
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
- RdbDataSourceName 1
- RdbInstallRoot1
- RdbMaxPoolSize 1
- RdbMaxWait 1
- RdbMinPoolSize 1
- RdbSchemaName 1
- RdbSchemaParam
- RdbSchemaPassword 1
- RdbSchemaType 1
- RdbSchemaUserName 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Rdb
Attributes
Defaults for Imported Attributes
| Name | Default |
|---|---|
| rdbDataSourceName | DefaultDS |
| rdbMaxPoolSize | 20 |
| rdbMaxWait | 5000 |
| rdbMinPoolSize | 5 |
| rdbSchemaPassword | |
| rdbSchemaUserName | sa |
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 <${Rdb.entity.attribute.rdbInstance}>] [-password <${entity.attribute.rdbSchemaPassword}>] [-rdb_home <>] [-schema <${entity.attribute.rdbSchemaName}>] [-username <${entity.attribute.rdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| buildstamp | build stamp |
| instance | Database server instance name |
| password | Schema user's password |
| rdb_home | path to database install |
| schema | Database schema name |
| username | Schema user name |
import
Imports the schema
- Usage
- import [-dmp_file <${entity.attribute.rdbSchemaType}-${opts.buildstamp}.dmp>] [-failonwarnings <>] [-from_user <>] [-instance <${Rdb.entity.attribute.rdbInstanceName}>] [-password <${entity.attribute.rdbSchemaPassword}>] [-rdb_home <>] [-schema <${entity.attribute.rdbSchemaName}>] [-username <${entity.attribute.rdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| dmp_file | dump file to import |
| failonwarnings | if arg true, fail if there are import warnings |
| from_user | from user |
| instance | Database server instance name |
| password | Schema user's password |
| rdb_home | path to database install |
| schema | Database schema name |
| username | Schema user name |
ImportDmp
Imports the dmp file
- Usage
- ImportDmp
Workflow
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 <RdbData>] [-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 <${Rdb.entity.attribute.rdbInstance}>] [-password <${entity.attribute.rdbSchemaPassword}>] [-schema <${entity.attribute.rdbSchemaName}>] [-username <${entity.attribute.rdbSchemaUserName}>]
Options
| Option | Description |
|---|---|
| instance | Database server instance name |
| password | Schema user's password |
| schema | Database schema name |
| username | Schema user name |
Related Types
The following types are defined for use with RdbSchema.
RdbSchemaType
Overview
RdbSchemaType:
A schema name
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaType | settingValue |
RdbSchemaParam
Overview
RdbSchemaParam:
A schema parameter
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
RdbSchemaName
Overview
RdbSchemaName:
A schema name
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaName | settingValue |
RdbDataSourceName
Overview
RdbDataSourceName:
JNDI data source name for connecting to the schema
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbDataSourceName | settingValue |
RdbSchemaUserName
Overview
RdbSchemaUserName:
A user for a schema
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaUserName | settingValue |
| schemaFromUser | settingType |
RdbSchemaPassword
Overview
RdbSchemaPassword:
A schema user's password
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchema | settingType |
| rdbSchemaPassword | settingValue |
RdbMinPoolSize
Overview
RdbMinPoolSize:
DataSource minimum connections
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbMinPoolSize | settingValue |
RdbMaxPoolSize
Overview
RdbMaxPoolSize:
DataSource maximum connections
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbMaxPoolSize | settingValue |
RdbMaxWait
Overview
RdbMaxWait:
DataSource maximum connections
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbMaxWait | settingValue |
RdbSchemaSetting
Overview
RdbSchemaSetting:
an RdbSchema setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |