RdbSchema
Represents a database schema
Overview
RdbSchema: Represents a database schema
Intent
The RdbSchema object is a deployment representing a database schema which is typically a dependency of an Rdb (database service) object. Schemas are modeled so that there are the following tiers:
- AppServer such as a JBossServer object depending on:
- Database Server such an Rdb object depending on:
- RdbSchema objects
Typically these objects are accessible from the application server in order to generate its datasource configuration.
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
Limit this object to be referred to by Node and Rdb objects only.
Attributes
Defaults for Imported Attributes
Name | Default | Description |
---|---|---|
rdbDataSourceName | DefaultDS | default jndi datasource name |
rdbMaxPoolSize | 20 | default maximum pool size |
rdbMaxWait | 5000 | default maximum wait for databasae connection in milliseconds |
rdbMinPoolSize | 5 | default minimum pool size |
rdbSchemaPassword | default schema password | |
rdbSchemaUserName | sa | default schema username |
Commands
export
Exports the schema
exports the database schema as a versioned package subject to import into the controltier package repository.
- 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
Identifies the database instance name, by default this instance name is derived from the referring database server object. |
password |
Schema user's password
password to access database schema, defaults to the rdbSchemaPassword attribute. |
rdb_home | path to database install |
schema |
Database schema name
name of the database schema, defaults to the rdbSchemaName attribute. |
username |
Schema user name
username to access database schema, defaults to the rdbSchemaUserName attribute. |
import
Imports the schema
concrete import implementation of the schema import.
- 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
Identifies the database instance name, by default this instance name is derived from the referring database server object. |
password |
Schema user's password
password to access database schema, defaults to the rdbSchemaPassword attribute. |
rdb_home | path to database install |
schema |
Database schema name
name of the database schema, defaults to the rdbSchemaName attribute. |
username |
Schema user name
username to access database schema, defaults to the rdbSchemaUserName attribute. |
ImportDmp
Imports the dmp file
Workflow wrapping the schema import process
- Usage
- ImportDmp
Workflow
Status
Gets the status of the service
Checks if the configured schema is available
- Usage
- Status
Workflow
ExportDmp
exports and uploads a dump
Workflow wrapping the schema export and package registration process
- Usage
- ExportDmp -buildstamp <>
Workflow
Error Handler
Notify |
|
Options
Option | Description |
---|---|
buildstamp |
buildstamp
Identifies the buildstamp to be assiged as the version of the data package. |
registerDmp
registers the dump file as an object
registers an exported schema as a package in the ControlTier package repository.
- Usage
- registerDmp [-buildstamp <>] [-dmp_file <>] [-packagetype <RdbData>] [-release <>] [-tstampformat <yyyymmddhhmm>] [-version <>]
Options
Option | Description |
---|---|
buildstamp |
package build timestamp
Identifies the buildstamp to be assiged as the version of the data package. |
dmp_file |
dumpfile
Identifies the dmp file to be created when schema is exported. |
packagetype |
type name
Idenifies which data package type the package will be registered as, defaults to RdbData. |
release | version release |
tstampformat | build timestamp format |
version | package version |
upSchema
Checks schema is available in the designated instance
Checks if the configured schema is available
- 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
Identifies the database instance name, by default this instance name is derived from the referring database server object. |
password |
Schema user's password
password to access database schema, defaults to the rdbSchemaPassword attribute. |
schema |
Database schema name
name of the database schema, defaults to the rdbSchemaName attribute. |
username |
Schema user name
username to access database schema, defaults to the rdbSchemaUserName attribute. |
Related Types
The following types are defined for use with RdbSchema.
RdbSchemaSetting
Overview
RdbSchemaSetting: an RdbSchema setting
Intent
Supertype to encapsulate related subtypes to support RdbSchema deployments.
Design
- Super Type
- Setting
Role | Abstract. (Objects cannot be created.) |
Instance Names | Unique |
Constraints
Allowed Parent Dependencies
-
RdbSchema
RdbSchema settings shall only be referred to by RdbSchema objects.
RdbSchemaType
Overview
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
Intent
Specifies the name of the database schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbSchemaName | settingValue | attribute setting representing a database schema name. |
RdbDataSourceName
Overview
RdbDataSourceName: JNDI data source name for connecting to the schema
Intent
The jndi datasource name that the application uses to reference this schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbDataSourceName | settingValue | attribute setting representing the jndi datasource name. |
RdbSchemaUserName
Overview
RdbSchemaUserName: A user for a schema
Intent
The username used to access the database schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbSchemaUserName | settingValue | attribute setting containing the username required for database schema access |
schemaFromUser | settingType |
RdbSchemaPassword
Overview
RdbSchemaPassword: A schema user's password
Intent
The password used to access the database schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbSchema | settingType | |
rdbSchemaPassword | settingValue | attribute setting containing the password required for database schema access Typically accessed by a referring application server for datasource generation. |
RdbMinPoolSize
Overview
RdbMinPoolSize: DataSource minimum connections
Intent
The specified minimum pool size for referring entities that connect to this schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbMinPoolSize | settingValue | attribute setting containing the minimum pool size |
RdbMaxPoolSize
Overview
RdbMaxPoolSize: DataSource maximum connections
Intent
The specified maximum pool size for referring entities that connect to this schema. Typically accessed by a referring application server for datasource generation.
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Attributes
Exported Attributes
Name | Property | Description |
---|---|---|
rdbMaxPoolSize | settingValue | attribute setting containing the maximum pool size |
RdbMaxWait
Overview
RdbMaxWait: DataSource maxwait parameter
Design
- Super Type
- RdbSchemaSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Attributes
Exported Attributes
Name | Property |
---|---|
rdbMaxWait | settingValue |