You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

List and show information about objects in a metadata repository

Available Sub Commands

exists

Determines whether or not an object exists in a metadata repository

Exists Arguments

Argument

Description

-h [ --help ]

Display this message

-n [ --name ] arg

The name of, potentially, an object

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.

export-all-ddl

Generates and exports all object's create DDL to a given directory

export-all-ddl Arguments

Argument

Description

-h [ --help ]

Display this message

-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 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.

export-ddl

Generates and exports an object's create DDL to a given directory

export-ddl Arguments

Argument

Description

-h [ --help ]

Display this message

-n [ --name ] arg

The name of an existing object

-d [ --directory-name ] arg

The directory name to export to. File name will be auto - generated from the object metadata.

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.

generate-indexes

Execute Command to Auto Generate Indexes

Generate Index Arguments

Argument

Description

-h [ --help ]

Display this message

-f [ --force ]

skip index validation and all other checks and recreate the indexes anyway

-O [ --index-owner-name ] arg

The name of the entity that owns the Index being generated

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.

generate-routine

Generates a routine for an object or source mapping

Generate Routine Arguments

Argument

Description

-h [ --help ]

Display this message

--routine-owner-type arg

The type of the entity that owns the routine being generated, either "object" or "source-mapping"; if not specified, uses the first of "object" and "source-mapping" such that an entity exists with the specified owner name

-O [ --routine-owner-name ] arg

The name of the entity that owns the routine being generated

--routine-operation arg

The operation of the routine being generated, either "update" or "custom" (or "load" or "post-load" for load tables) or "windows-action" or "unix-action"; if not specified, uses "update" (or "load")

--routine-type arg

The type of the routine being generated, either "procedure" or "script"; if not specified, uses the type associated with the template

--routine-name arg

The name of the routine being generated; if not specified, derives a name from the owner name using the global naming conventions of routines for the target object type and routine operation

--routine-purpose arg

The purpose of the new routine object; if not specified, uses the routine name

--routine-author arg

The author of the new routine object; if not specified, uses "auto created"

--routine-status arg

The status of the new routine object; if not specified, uses either "new procedure" or "new script"

-t [ --tem-name ] arg

The name of a template to link to and use for generating the routine; if not specified, uses a template linked for the operation of the routine owner if one exists; otherwise, a default template must exist for the target connection, target object type, and operation

--no-displace-existing-linked-routine

If specified, there must be no existing linked routine for the operation of the routine owner

-d [ --version-and-delete-existing-routine ]

If specified, an existing routine object will be versioned and deleted to make space for the new routine

-m [ --version-and-modify-existing-routine ]

If specified, an existing routine object of the type being generated will be versioned and modified; a different type of routine will be versioned and deleted to make space for the new routine

-u [ --red-user-name ] arg

The name of the Red user to be used when generating the routine; if not specified, then performs the operation as an unspecified user

list-all

List all objects


show

Show detailed information about an existing object


Object Arguments

Argument

Description

-h [ --help]Displays this message.

Common Arguments

The following arguments are used on most of the commands available in RedCli:
ArgumentDescription

 -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.

  • No labels