List, deploy and show the contents of deployment applications
Available Sub Commands
deploy
Deploy an application into a Data Warehouse
Application Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--app-number arg | The application number that's contained within the application ID file |
--app-version arg | The application version that's contained within the application ID file |
--app-directory arg | The path on the local system that contains the set of application files |
--xml-file-name arg | The path on the local system to an XML file exported from WhereScape 3D |
File System
Argument | Description |
|---|---|
--options-location arg | Where to look for the deployment options. Either registry, xml or defaults. |
--options-file-name arg | If options-location is xml then this must be the path to the XML options file |
--ddl-file-name arg | The path to a file to save the generated DDL into |
--resolved-missing-data-file-name arg | The path to a file where resolved missing data is stored |
Destination Meta Repo
Argument | Description |
|---|---|
--abort-if-table-space-not-found | Abort the deployment if the application contains a table space name that is absent from the destination meta repo |
--dest-table-space arg | The table space name to use in the destination meta repo when the table space name used by the application is absent |
--abort-if-duplicate-sm-name | Abort the deployment if the application contains a source mapping name, or short name, that's already in use in the destination meta repo |
--dest-sm-name arg | The source mapping name to use in the destination meta repo when there's a duplicate name used by the application |
--dest-sm-short-name arg | The source mapping short name to use in the destination meta repo when there's a duplicate short name used by the application |
--abort-if-db-name-not-found | Abort the deployment if the application contains a database name that is absent from the destination meta repo |
--dest-db-name arg | The database name to use in the destination meta repo when the database name used by the application is absent |
--abort-if-schema-name-not-found | Abort the deployment if the application contains a schema name that is absent from the destination meta repo |
--dest-schema-name arg | The schema name to use in the destination meta repo when the schema name used by the application is absent |
--abort-if-connection-name-not-found | Abort the deployment if the application contains a connection name that is absent from the destination meta repo |
--dest-connection-name arg | When deployment requires the name of an existing connection it will use the name supplied by this argument |
--abort-if-target-name-not-found | Abort the deployment if the application contains a target name that is absent from the destination meta repo |
--dest-target-name arg | The target name to use in the destination meta repo when the target name used by the application is absent |
--abort-if-scheduler-name-not-found | Abort the deployment if the application contains a scheduler name that is absent from the destination meta repo |
--dest-scheduler-name arg | The scheduler name to use in the destination meta repo when the scheduler name used by the application |
Options
Argument | Description |
|---|---|
--continue-ver-mismatch | Continue with the deployment even if the meta repo versions differ between application and the destination repo |
--continue-checked-out | Continue with the deployment even if one or more items are checked out |
--continue-clear-connection | Continue with the deployment if an object's connection is absent from the deployment files. The object's connection will be set to 0. |
--use-oracle-procs | Use a work around for an Oracle procedure compile limitation on the lengths of strings. |
--def-load-type arg | The default load type to use for load tables. One of External, DbLink, Odbc, NativeOdbc, Ssis, Tpt, TptScript, WinFile, WinFileScript, WinFileXml, UnixFile, UnixFileScript, NativeSsh, Sqoop or HostScript. |
--default-load-script-connection arg | The name of the connection to default to for load scripts. |
--default-load-script-template arg | The name of the template to default to for load scripts. |
--red-user-name arg | The RED user name to insert into version records. |
--assign-jobs-to-user arg | The name of the owner to default to for jobs. |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
list-all
List all deployment applications in a file system path
List All Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--path-name arg | The file system path whose contents are to be listed |
show
Show what changes would occur during a deployment
Show Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--app-number arg | The application number that's contained within the application ID file |
--app-version arg | The application version that's contained within the application ID file |
--app-directory arg | The path on the local system that contains the set of application files |
--xml-file-name arg | The path on the local system to an XML file exported from WhereScape 3D |
--continue-ver-mismatch | Continue with the deployment even if the meta repo versions differ between application and the destination repo |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
show-missing
Show which connections and targets would be missing during a deployment
Application
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--app-number arg | The application number that's contained within the application ID file |
--app-version arg | The application version that's contained within the application ID file |
--app-directory arg | The path on the local system that contains the set of application files |
--xml-file-name arg | The path on the local system to an XML file exported from WhereScape 3D |
File System
Argument | Description |
|---|---|
--options-location arg | Where to look for the deployment options. Either registry, xml or defaults. |
--options-file-name arg | If options-location is xml then this must be the path to the XML options file |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
DeploymentApp Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
Common Arguments
| Argument | Description |
|---|---|
-c [ --config-file ] <arg> | A configuration file that contains program options (format is INI file) |
| -o [ --output-mode ] <arg> | Either human, json or xml. |
| -l [ --log-level ] <arg> | Log level, 0-5 inclusive. 0=only fatal errors, 5=all logging messages. |