3.1. redlinctl CLI Reference

The redlinctl command-line interface is the primary entry point for the RED Lineage tool. It is executed as a bash script to harvest metadata, manage configurations, and trigger the lineage generation process.

3.1.1. Synopsis

redlinctl [--enable-consolelog] <command> [args...]

3.1.2. Global Options

These options can be applied globally before the subcommand.

--enable-consolelog

Enables logging output directly to the console. By default, standard output is suppressed and written to the file logger (unless the version command is used).

3.1.3. Commands

3.1.3.1. push

Push the actual data lineage to target systems e.g. data governance tools. The target pushing pipeline is custom specific and has to be configured in red_params.conf.

Usage:

redlinctl push [target] [options]

-l | --list

lists all available target systems

--dry-run

Pushes the lineage to target system with dry-run option if available.

3.1.3.2. version

Displays the current version of the RED Lineage module.

Usage:

redlinctl version

3.1.3.3. generate

The core command used to harvest Exasol and MicroStrategy metadata, parse SQL, and generate the end-to-end data lineage.

Usage:

redlinctl generate [OPTIONS]

Options:

--type <type>

Specifies the type of lineage to generate. Defaults to all.

--version-id <timestamp>

Assigns a specific timestamp or unique identifier to the generated lineage run. Defaults to the current system time in YYYY-MM-DD HH:MM:SS format.

--dry-run

Executes the lineage generation process without persisting the results to the target database. Highly recommended for testing and validation.

--num-processes <number>

Defines the number of parallel processes to use during execution to improve performance.

--max-task-per-child <number>

Sets the maximum number of tasks a single child process can execute before it is recycled, helping to prevent memory leaks in large runs.

--instance <name>

Specifies the target instance identifier for the lineage run.

--mstr-projects <projects>

Defines specific MicroStrategy projects to be harvested (e.g., as a comma-separated list or specific string expected by the backend).

--mstr-system <name>

Sets the internal system name for the MicroStrategy environment.

--mstr-connection <name>

Specifies the Exasol connection name used by the tool to interface with MicroStrategy.

--exasol-system <name>

Sets the internal system name for the Exasol data warehouse environment.

--ignore-invalidViews

Instructs the parser to bypass invalid or broken views during extraction instead of halting the entire harvesting process.