AtgSolidRdbSchema
Represents a Solid database schema
Overview
AtgSolidRdbSchema:
Represents a Solid database schema
Design
- Super Type
- AtgRdbSchema
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- AtgRdbDataSourceName1
- AtgRdbInstallRoot1
- AtgRdbSchemaName1
- AtgRdbSchemaPassword1
- AtgRdbSchemaType1
- AtgRdbSchemaUserName1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- AtgSolidRdb
- Node
Attributes
Defaults for Imported Attributes
| Name | Default |
|---|---|
| atgRdbInstallRoot | ${AtgSolidRdb.entity.instance.dir}/var |
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 <${AtgSolidRdb.entity.attribute.atgRdbInstance}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-rdb_home <>] [-schema <${entity.attribute.atgRdbSchemaName}>] [-username <${entity.attribute.atgRdbSchemaUserName}>]
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.atgRdbSchemaType}-${opts.buildstamp}.dmp>] [-failonwarnings <>] [-from_user <>] [-instance <${AtgSolidRdb.entity.attribute.atgRdbInstanceName}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-rdb_home <>] [-schema <${entity.attribute.atgRdbSchemaName}>] [-username <${entity.attribute.atgRdbSchemaUserName}>]
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 |
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 <${AtgSolidRdb.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 |