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
- RdbSchemaAdditionalOptions 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 |
| rdbSchemaAdditionalOptions | Additional options for data source | |
| rdbSchemaPassword | default schema password | |
| rdbSchemaUserName | sa | default schema username |
Commands
View the available commands in the User Reference.
Related Types
The following types are defined for use with RdbSchema.
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. |
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 |
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 |
RdbSchemaAdditionalOptions
Overview
RdbSchemaAdditionalOptions: Additional options for data source
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
- AtgRdbSchema
- RdbSchema
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaAdditionalOptions | settingValue |
RdbSchemaName
Overview
RdbSchemaName: A schema name
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. |
RdbSchemaParam
Overview
RdbSchemaParam: A schema parameter
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
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. |
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
RdbSchemaType: A schema name
Design
- Super Type
- RdbSchemaSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rdbSchemaType | settingValue |
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 |