Manage all aspects of targets
Available Sub Commands
add
Add a new target on a connection
General ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The name of the connection | --name arg | The name of the target | --database arg | The name of a database for the target to use | --schema arg | The name of a schema for the target to use | --work-url arg | A URL for the target to use | --work-dir arg | The path to a folder to store working files |
Attributes ArgumentsArgument | Description |
|---|
--owner arg | The owner of the target | --db-encap arg | The encapsulation characters to use for DB schema/table/column names e.g. " " or [ ] | --temp-db arg | The name of a temp database for the target to use | --tree-colour arg | The colour to draw members of this target when presented in a GUI. Expected format is #RRGGBB. For example: --tree-colour #0A1F56 |
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. |
|
delete
Delete an existing target on a connection
Delete ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The connection whose target to delete | -n [ --name ] arg | The name of an existing target | -f [ --force ] | Force the deletion of a target that's a default target location, or a target that's in use by one or more objects |
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 targets on a connection
List All ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The connection whose targets to list |
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. |
|
modify
Modify an existing target on a connection
General ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The name of the connection | --name arg | The name of the target | --database arg | The name of a database for the target to use | --schema arg | The name of a schema for the target to use | --work-url arg | A URL for the target to use | --work-dir arg | The path to a folder to store working files |
Attributes ArgumentsArgument | Description |
|---|
--owner arg | The owner of the target | --db-encap arg | The encapsulation characters to use for DB schema/table/column names e.g. " " or [ ] | --temp-db arg | The name of a temp database for the target to use | --tree-colour arg | The colour to draw members of this target when presented in a GUI. Expected format is #RRGGBB. For example: --tree-colour #0A1F56 |
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. |
|
rename
Rename an existing target on a connection
Rename ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The connection whose target to rename | --old-name arg | The name of an existing target | --new-name arg | The name to rename the target to | -f [ --force ] | Force the deletion of a target that's a default target location, or a target that's in use by one or more objects |
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 target on a connection
Show ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | --connection-name arg | The name of an existing connection | -n [ --name ] arg | The name of an existing target |
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. |
|
Target Arguments
Argument | Description |
|---|
| -h [ --help] | Displays This message |
Common Arguments
