ControlTier Inc. > Open.ControlTier > ModuleForge.ControlTier
 
 
PDF -icon
PDF
Font size:      

AtgRdbSchema

Represents a database schema

Overview

Open in Workbench 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

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Attributes

Defaults for Imported Attributes

Name Default
atgRdbInstallRoot C:\intuit

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}>] [-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 -buildstamp <> [-dmp_file <${entity.attribute.atgRdbSchemaType}-${opts.buildstamp}.dmp>] [-failonwarnings <>] [-from_user <>] [-instance <${AtgRdb.entity.attribute.atgRdbInstanceName}>] [-password <${entity.attribute.atgRdbSchemaPassword}>] [-rdb_home <>] [-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
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 -buildstamp <>

Workflow

  1. import

Options

Option Description
buildstamp Unique build identifier

Status

Gets the status of the service

Usage
Status

Workflow

  1. upSchema

ExportDmp

exports and uploads a dump

Usage
ExportDmp -buildstamp <>

Workflow

  1. export
  2. registerDmp

Error Handler

Notify
Email
${framework.admin.email}
Subject
File

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

Related Types

The following types are defined for use with AtgRdbSchema.

AtgRdbSchemaType

Overview

Open in Workbench AtgRdbSchemaType: A schema name

Design

Super Type
AtgRdbSchemaSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
atgRdbSchemaType settingValue

AtgRdbSchemaName

Overview

Open in Workbench AtgRdbSchemaName: A schema name

Design

Super Type
AtgRdbSchemaSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
atgRdbSchemaName settingValue

AtgRdbSchemaUserName

Overview

Open in Workbench AtgRdbSchemaUserName: A user for a schema

Design

Super Type
AtgRdbSchemaSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
atgRdbSchemaUserName settingValue
schemaFromUser settingType

AtgRdbSchemaPassword

Overview

Open in Workbench 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

AtgRdbSchemaSetting

Overview

Open in Workbench AtgRdbSchemaSetting: an AtgRdbSchema setting

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies