Manage all aspects of connections
Available Sub Commands
add
Add a new connection. You can use the following arguments.
General Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--name arg | The name of the connection |
--con-type arg | The type of the connection. Either database, hadoop, msas, odbc, unix or windows |
--odbc-source arg | The system DSN to use from the OS's ODBC settings |
--odbc-source-arch arg | The architecture of the system DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--method arg | The login method to use |
--host-id arg | The host ID of remote machine |
--db-link-id arg | The database link ID that identifies a database this connection will use |
--db-id arg | Source database ID or database name (Oracle SID, TNS Name, Teradata TDPID) |
--db-type arg | The type of database this connection represents, Either local, other, sqlserver, db2, teradata, oracle, netezza, greenplum, hive, msasmultidim, pdw, msastabular, postgresql, or custom |
--db-home arg | The database home directory if it is different than the standard home directory |
--extract-user-id arg | The user ID this connection will use when logging in as a non-admin |
--extract-pwd arg | The password this connection will use when logging in as a non-admin |
--admin-user-id arg | The user ID this connection will use when logging in as an admin |
--admin-pwd arg | The password this connection will use when logging in as an admin |
--work-dir arg | A path to a local writeable directory to store temporary files |
--pre-login-act arg | The action to run before logging into the remote host |
--post-login-act arg | The action to run after logging into the remote host |
--login-prompt arg | The login prompt to look for on the remote unix host |
--pwd-prompt arg | The password prompt to look for on the remote unix host |
--command-prompt arg | Unix command prompt or the tail-end of that prompt (typically $) |
--server arg | The name of the server to use |
--doc-1 arg | Documentation field 1 |
--doc-2 arg | Documentation field 2 |
--doc-3 arg | Documentation field 3 |
--doc-4 arg | Documentation field 4 |
--doc-5 arg | Documentation field 5 |
--doc-6 arg | Documentation field 6 |
--doc-7 arg | Documentation field 7 |
--doc-8 arg | Documentation field 8 |
--doc-9 arg | Documentation field 9 |
--doc-10 arg | Documentation field 10 |
--doc-11 arg | Documentation field 11 |
--doc-12 arg | Documentation field 12 |
--doc-13 arg | Documentation field 13 |
--doc-14 arg | Documentation field 14 |
--doc-15 arg | Documentation field 15 |
--doc-16 arg | Documentation field 16 |
--dtm-set-name arg | The data type mapping set this connection will use |
Telnet Arguments
Argument | Description |
|---|---|
--shell-type arg | The type of the unix shell. Either ssh or telnet |
--ssh-command arg | A command line that specifies how to run a local SSH program |
Attributes Arguments
Argument | Description |
|---|---|
--meta-repo | If specified, this connection will be considered the metadata repository connection |
--notes arg | Arbitrary notes associated with this connection |
--default-load-type arg | The default load that will be used for load tables created with this connection |
--default-load-script-connection arg | The default script connection that will be used for load tables created with this connection |
--default-load-script-template arg | The default template that will be used for load table scripts created with this connection |
--def-update-script-con arg | The default script connection that will be used for update scripts created with this connection |
--def-table-create-ddl-tem arg | The default template that will be used to create tables created that use this connection |
--def-win-action-tem arg | The default template that will be used to create the Windows Action Script for objects that use this connection |
--def-unix-action-tem arg | The default template that will be used to create the Linux Action Script for objects that use this connection |
--def-table-alter-ddl-tem arg | The default template that will be used to create views created that use this connection |
--def-view-create-ddl-tem arg | The default template that will be used to create views created that use this connection |
--def-index-create-ddl-tem arg | The default template that will be used to create indexes created that use this connection |
--def-index-drop-ddl-tem arg | The default template that will be used to drop indexes created that use this connection |
--def-index-validate-block-tem arg | The default template that will be used to validate indexes created that use this connection |
--def-pre-load-action arg | The default action to execute before loading data into a load table |
--display-data-sql arg | The generic syntax of a Display Data SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--row-count-sql arg | The generic syntax of a Row Count SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--row-count-sql-bulk arg | The SQL statement to return the table name, schema name and row count of all tables for the connection. Variable $DATABASE$ may be used. |
--table-exists-sql arg | The syntax to check if a table exists which accepts RED placeholder parameters. Default: SELECT 1 FROM $OBJECT$ WHERE 1=0 |
--drop-table-sql arg | The generic syntax of a Drop Table SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--drop-procedure-sql arg | The syntax to use for Drop Procedure SQL statements which accepts RED placeholder parameters. Example: DROP $PROC_TYPE$ $SCHEMA$.$PROC_NAME$; |
--drop-view-sql arg | The generic syntax of a Drop View SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--truncate-sql arg | The generic syntax of a Truncate Table SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--db-server arg | Database Host/Server that's used in the GPLoad specification, or in sqlcmd command lines |
--db-port arg | Database Port that's used in the GPLoad specification, or in sqlcmd command lines |
--function-set arg | Function Set that is selected by default in the Transformation dialogs |
--load-host-id arg | IP address or host name(s) that identifies the Loaders for unix connections |
--load-port-start arg | Port Range start for Loaders on unix connections |
--load-port-end arg | Port Range end for Loaders on unix connections |
--ssis-staging-db arg | The staging database to be used by either Microsoft SQL Server Integration Services (SSIS) or PDW file loads |
--ssis-use-col-name | Determines whether to use column names or column titles for SSIS loads. Teradata OLEDB driver by default returns titles |
--def-browser-schema arg | Default schema to use for browsing in RED's browser pane |
--script-shell arg | Path to the POSIX-compliant UNIX/Linux shell to use for generated scripts. Typically this will be /bin/ksh for UNIX hosts and /bin/sh for Linux hosts |
--tpt-hadoop-host arg | IP address or host name (and optional port number) that identifies the Hadoop host to a TPT load routine |
--tpt-odbc-source arg | The Teradata TPT compliant ODBC Data Source Name (DSN) that is to be used in the TPT Read Operator for TPT ODBC Loads |
--tpt-odbc-source-arch arg | The architecture of the Teradata TPT DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--msas-db-client-version arg | Microsoft Analysis Services client version available for connecting to the SSAS database |
--create-indexes | If specified, RED will create indexes when creating new objects on this connection |
--con-info-proc arg | The SQL Block Procedure used to query Table/Column information; should use RED placeholder parameters (e.g. $DATABASE$, $SCHEMA$, $OBJECT$) |
--def-pre-load-sql arg | The default Pre-Load Action to use for Load Tables created on targets of this connection. |
Connect String Arguments
Argument | Description |
|---|---|
--ssis-ole-db arg | The destination adapter to be used by Microsoft SQL Server Integration Services (SSIS) when connecting with OLE DB |
--ssis-sql-pdw arg | The destination adapter to be used by Microsoft SQL Server Integration Services (SSIS) when connecting with SQL PDW |
--ssas arg | Connection string to be used by Microsoft Analysis Services (MSAS) to connect to the data warehouse |
--jdbc-con-string arg | Connection string to be used by Big Data Adapter (BDA) |
--jdbc-driver-class arg | JDBC driver class to be used by Big Data Adapter (BDA) |
--con-string arg | ODBC connection string for the connection when using Advanced Connect.Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
Authentication Arguments
Argument | Description |
|---|---|
--td-wallet-user-id arg | User ID for Teradata Wallet usage with Teradata Client tools |
--td-wallet-string arg | Database Password to login as when using SQL Admin via the 'Connect using SQL Admin (as SQL Admin User)' context menu item |
--jdbc-user-id arg | User ID to login as when using JDBC via Big Data Adapter (BDA) |
--jdbc-pwd arg | Password to login with when using JDBC via Big Data Adapter (BDA) |
--def-odbc-user arg | The default credential method to use for browsing this connection. Either notset, extract or tdwallet |
--ext-user-sec-mode arg | Whether or not to encrypt the extract user name. Either encrypted or unencrypted |
--ext-pwd-sec-mode arg | Whether or not to encrypt the extract password. Either encrypted or unencrypted |
--admin-user-sec-mode arg | Whether or not to encrypt the admin user name. Either encrypted or unencrypted |
--admin-pwd-sec-mode arg | Whether or not to encrypt the admin password. Either encrypted or unencrypted |
--td-wallet-user-sec-mode arg | Whether or not to encrypt the TD wallet user name. Either encrypted or unencrypted |
--td-wallet-string-sec-mode arg | Whether or not to encrypt the TD wallet string. Either encrypted or unencrypted |
--jdbc-user-sec-mode arg | Whether or not to encrypt the JDBC user name. Either encrypted or unencrypted |
--jdbc-pwd-sec-mode arg | Whether or not to encrypt the JDBC password. Either encrypted or unencrypted |
Versioning Arguments
Argument | Description |
|---|---|
--disable-versioning | If specified, Versioning is on by default for Connection [Modify|Delete], use this option to disable it |
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. |
clear-default-template
Clear a default template for an existing connection. You can use the following arguments.
Set Default Template Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--connection-name arg | The name of an existing connection |
--obj-type arg | The type of object. Must be one of Agg, Custom1, Custom2, Dim, DimView, Export, Fact, FactKpi, Hub, Join, Link, Load, Normal, Ods, Retro, RetroCopy, Satellite, Stage or View. |
--obj-sub-type arg | Optional. The sub type of object |
--op-type arg | The type of operation. Must be one of CustomRoutine, ExportScript, LoadScript or UpdateRoutine. |
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. |
delete
Delete an existing connection. You can use the following arguments.
Delete Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-n [ --name ] arg | The name of an existing connection |
-f [ --force ] | Force the deletion of a meta connection, or a connection that's in use by one or more load tables |
--disable-versioning | If specified, Versioning is on by default for Connection [Modify|Delete], use this option to disable it |
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 connections. You can use the following arguments.
List All Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
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. |
modify
Modify an existing connection. You can use the following arguments.
General Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--name arg | The name of the connection |
--con-type arg | The type of the connection. Either database, hadoop, msas, odbc, unix or windows |
--odbc-source arg | The system DSN to use from the OS's ODBC settings |
--odbc-source-arch arg | The architecture of the system DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--method arg | The login method to use |
--host-id arg | The host ID of remote machine |
--db-link-id arg | The database link ID that identifies a database this connection will use |
--db-id arg | Source database ID or database name (Oracle SID, TNS Name, Teradata TDPID) |
--db-type arg | The type of database this connection represents, Either local, other, sqlserver, db2, teradata, oracle, netezza, greenplum, hive, msasmultidim, pdw, msastabular, postgresql, or custom |
--db-home arg | The database home directory if it is different than the standard home directory |
--extract-user-id arg | The user ID this connection will use when logging in as a non-admin |
--extract-pwd arg | The password this connection will use when logging in as a non-admin |
--admin-user-id arg | The user ID this connection will use when logging in as an admin |
--admin-pwd arg | The password this connection will use when logging in as an admin |
--work-dir arg | A path to a local writeable directory to store temporary files |
--pre-login-act arg | The action to run before logging into the remote host |
--post-login-act arg | The action to run after logging into the remote host |
--login-prompt arg | The login prompt to look for on the remote unix host |
--pwd-prompt arg | The password prompt to look for on the remote unix host |
--command-prompt arg | Unix command prompt or the tail-end of that prompt (typically $) |
--server arg | The name of the server to use |
--doc-1 arg | Documentation field 1 |
--doc-2 arg | Documentation field 2 |
--doc-3 arg | Documentation field 3 |
--doc-4 arg | Documentation field 4 |
--doc-5 arg | Documentation field 5 |
--doc-6 arg | Documentation field 6 |
--doc-7 arg | Documentation field 7 |
--doc-8 arg | Documentation field 8 |
--doc-9 arg | Documentation field 9 |
--doc-10 arg | Documentation field 10 |
--doc-11 arg | Documentation field 11 |
--doc-12 arg | Documentation field 12 |
--doc-13 arg | Documentation field 13 |
--doc-14 arg | Documentation field 14 |
--doc-15 arg | Documentation field 15 |
--doc-16 arg | Documentation field 16 |
--dtm-set-name arg | The data type mapping set this connection will use |
Telnet Arguments
Argument | Description |
|---|---|
--shell-type arg | The type of the unix shell. Either ssh or telnet |
--ssh-command arg | A command line that specifies how to run a local SSH program |
Attributes Arguments
Argument | Description |
|---|---|
--meta-repo | If specified, this connection will be considered the metadata repository connection |
--notes arg | Arbitrary notes associated with this connection |
--default-load-type arg | The default load that will be used for load tables created with this connection |
--default-load-script-connection arg | The default script connection that will be used for load tables created with this connection |
--default-load-script-template arg | The default template that will be used for load table scripts created with this connection |
--def-update-script-con arg | The default script connection that will be used for update scripts created with this connection |
--def-table-create-ddl-tem arg | The default template that will be used to create tables created that use this connection |
--def-win-action-tem arg | The default template that will be used to create the Windows Action Script for objects that use this connection |
--def-unix-action-tem arg | The default template that will be used to create the Linux Action Script for objects that use this connection |
--def-table-alter-ddl-tem arg | The default template that will be used to create views created that use this connection |
--def-view-create-ddl-tem arg | The default template that will be used to create views created that use this connection |
--def-index-create-ddl-tem arg | The default template that will be used to create indexes created that use this connection |
--def-index-drop-ddl-tem arg | The default template that will be used to drop indexes created that use this connection |
--def-index-validate-block-tem arg | The default template that will be used to validate indexes created that use this connection |
--def-pre-load-action arg | The default action to execute before loading data into a load table |
--display-data-sql arg | The generic syntax of a Display Data SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--row-count-sql arg | The generic syntax of a Row Count SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--row-count-sql-bulk arg | The SQL statement to return the table name, schema name and row count of all tables for the connection. Variable $DATABASE$ may be used. |
--table-exists-sql arg | The syntax to check if a table exists which accepts RED placeholder parameters. Default: SELECT 1 FROM $OBJECT$ WHERE 1=0 |
--drop-table-sql arg | The generic syntax of a Drop Table SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--drop-procedure-sql arg | The syntax to use for Drop Procedure SQL statements which accepts RED placeholder parameters. Example: DROP $PROC_TYPE$ $SCHEMA$.$PROC_NAME$; |
--drop-view-sql arg | The generic syntax of a Drop View SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--truncate-sql arg | The generic syntax of a Truncate Table SQL statement which should use RED placeholder parameters (e.g. $OBJECT$) |
--db-server arg | Database Host/Server that's used in the GPLoad specification, or in sqlcmd command lines |
--db-port arg | Database Port that's used in the GPLoad specification, or in sqlcmd command lines |
--function-set arg | Function Set that is selected by default in the Transformation dialogs |
--load-host-id arg | IP address or host name(s) that identifies the Loaders for unix connections |
--load-port-start arg | Port Range start for Loaders on unix connections |
--load-port-end arg | Port Range end for Loaders on unix connections |
--ssis-staging-db arg | The staging database to be used by either Microsoft SQL Server Integration Services (SSIS) or PDW file loads |
--ssis-use-col-name | Determines whether to use column names or column titles for SSIS loads. Teradata OLEDB driver by default returns titles |
--def-browser-schema arg | Default schema to use for browsing in RED's browser pane |
--script-shell arg | Path to the POSIX-compliant UNIX/Linux shell to use for generated scripts. Typically this will be /bin/ksh for UNIX hosts and /bin/sh for Linux hosts |
--tpt-hadoop-host arg | IP address or host name (and optional port number) that identifies the Hadoop host to a TPT load routine |
--tpt-odbc-source arg | The Teradata TPT compliant ODBC Data Source Name (DSN) that is to be used in the TPT Read Operator for TPT ODBC Loads |
--tpt-odbc-source-arch arg | The architecture of the Teradata TPT DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--msas-db-client-version arg | Microsoft Analysis Services client version available for connecting to the SSAS database |
--create-indexes | If specified, RED will create indexes when creating new objects on this connection |
--con-info-proc arg | The SQL Block Procedure used to query Table/Column information; should use RED placeholder parameters (e.g. $DATABASE$, $SCHEMA$, $OBJECT$) |
--def-pre-load-sql arg | The default Pre-Load Action to use for Load Tables created on targets of this connection. |
Connect String Arguments
Argument | Description |
|---|---|
--ssis-ole-db arg | The destination adapter to be used by Microsoft SQL Server Integration Services (SSIS) when connecting with OLE DB |
--ssis-sql-pdw arg | The destination adapter to be used by Microsoft SQL Server Integration Services (SSIS) when connecting with SQL PDW |
--ssas arg | Connection string to be used by Microsoft Analysis Services (MSAS) to connect to the data warehouse |
--jdbc-con-string arg | Connection string to be used by Big Data Adapter (BDA) |
--jdbc-driver-class arg | JDBC driver class to be used by Big Data Adapter (BDA) |
--con-string arg | ODBC connection string for the connection when using Advanced Connect. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
Authentication Arguments
Argument | Description |
|---|---|
--td-wallet-user-id arg | User ID for Teradata Wallet usage with Teradata Client tools |
--td-wallet-string arg | Database Password to login as when using SQL Admin via the 'Connect using SQL Admin (as SQL Admin User)' context menu item |
--jdbc-user-id arg | User ID to login as when using JDBC via Big Data Adapter (BDA) |
--jdbc-pwd arg | Password to login with when using JDBC via Big Data Adapter (BDA) |
--def-odbc-user arg | The default credential method to use for browsing this connection. Either notset, extract or tdwallet |
--ext-user-sec-mode arg | Whether or not to encrypt the extract user name. Either encrypted or unencrypted |
--ext-pwd-sec-mode arg | Whether or not to encrypt the extract password. Either encrypted or unencrypted |
--admin-user-sec-mode arg | Whether or not to encrypt the admin user name. Either encrypted or unencrypted |
--admin-pwd-sec-mode arg | Whether or not to encrypt the admin password. Either encrypted or unencrypted |
--td-wallet-user-sec-mode arg | Whether or not to encrypt the TD wallet user name. Either encrypted or unencrypted |
--td-wallet-string-sec-mode arg | Whether or not to encrypt the TD wallet string. Either encrypted or unencrypted |
--jdbc-user-sec-mode arg | Whether or not to encrypt the JDBC user name. Either encrypted or unencrypted |
--jdbc-pwd-sec-mode arg | Whether or not to encrypt the JDBC password. Either encrypted or unencrypted |
Versioning Arguments
Argument | Description |
|---|---|
--disable-versioning | If specified, Versioning is on by default for Connection [Modify|Delete], use this option to disable it |
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. |
rename
Rename an existing connection. You can use the following arguments.
Rename Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--old-name arg | The name of an existing connection |
--new-name arg | The name to rename the connection to |
-f [ --force ] | Force the deletion of a meta connection, or a connection that's in use by one or more load tables |
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. |
set-default-template
Set a default template for an existing connection. You can use the following arguments.
Set Default Template Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
--connection-name arg | The name of an existing connection |
--obj-type arg | The type of object. Must be one of Agg, Custom1, Custom2, Dim, DimView, Export, Fact, FactKpi, Hub, Join, Link, Load, Normal, Ods, Retro, RetroCopy, Satellite, Stage or View. |
--obj-sub-type arg | Optional. The sub type of object. |
--op-type arg | The type of operation. Must be one of CustomRoutine, ExportScript, LoadScript or UpdateRoutine. |
--tem-name arg | The name of an existing template |
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
Show the contents of an existing connection. You can use the following arguments.
Show Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-n [ --name ] arg | The name of an existing connection |
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. |
Connection 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. |