Import, export and list all templates
Available Sub Commands

export
Export an existing template to a file
Export ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing template | -f [ --file-name ] arg | The name of a file that the template will be written into | -d [ --directory-name ] arg | The directory name to export to. File name will be auto - generated from the object metadata. | --force | Overwrite the destination file if it already exists |
Metadata Repository Login ArgumentsArgument | 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. |
|
export-all
Exports all existing templates to a directory
Export ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -d [ --directory-name ] arg | The directory name to export to. File names will be auto - generated from the object metadata. | --force | Overwrite the destination file if it already exists |
Metadata Repository Login ArgumentsArgument | 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. |
|
import-directory
Import a template from a directory
Import ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -d [ --directory-name ] arg | The name of an existing directory that contains one or more templates | --tem-type arg | The type of the template to create. Use the list-types sub-command to see the list of available template types. If omitted the template will be searched for a tag containing its type. If not found then the default type of DDL will be used. | --db-type arg (=Custom) | The type of the target database all imported templates will be used with. One of Common, SqlServer, DB2, Teradata, Oracle, Netezza, Greenplum, Hive, PDW or Custom. Defaults to Custom. | --file-name-pattern arg | A regular expression to match file names within the directory. A whole word match is performed. Supported regex grammar is ECMAScript. If omitted the pattern ".+\.peb" will be used. | --overwrite-existing | Overwrite the destination template if it already exists and the existing template will be versioned | --overwrite-read-only | Overwrite the destination template if it's marked as read only and the existing template will be versioned |
Metadata Repository Login ArgumentsArgument | 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. |
|
import-file
Import a template from a file
Import ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -f [ --file-name ] arg | The name of an existing file that contains the template | --tem-type arg | The type of the template to create. Use the list-types sub-command to see the list of available template types. If omitted the template will be searched for a tag containing its type. If not found then the default type of DDL will be used. | --db-type arg (=Custom) | The type of the target database this template will be used with. One of Common, SqlServer, DB2, Teradata, Oracle, Netezza, Greenplum, Hive, PDW or Custom. Defaults to Custom. | -n [ --name ] arg | If supplied, the name to use for the new template. If omitted, then the name of the import file will be used | --overwrite-existing | Overwrite the destination template if it already exists and the existing template will be versioned | --overwrite-read-only | Overwrite the destination template if it's marked as read only and the existing template will be versioned |
Metadata Repository Login ArgumentsArgument | 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 templates
List All ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message |
Metadata Repository Login ArgumentsArgument | 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-types
List all template types
List All ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message |
Metadata Repository Login ArgumentsArgument | 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
Show the contents of an existing template
Show ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing template |
Metadata Repository Login ArgumentsArgument | 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. |
|
Template Arguments
Argument | Description |
|---|
| -h [ --help] | Displays This message |
Common Arguments
