Skip to main content

tw lineage

Explore data lineage records. Lineage must be enabled for the workspace.

tw lineage resolve​

Resolve a pipeline run or a file path to its lineage record identifier (LID)

tw lineage resolve [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-w, --workspaceWorkspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable)Yes
--file-pathAbsolute path of a file produced by a pipeline runYes
--session-idNextflow session ID of the runYes
--run-nameNextflow run nameYes

tw lineage view​

View a lineage record

tw lineage view [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-w, --workspaceWorkspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable)Yes
-i, --idLineage record identifier (LID), e.g. lid://<hash>/<path>Yes
--summaryShow only the record summary (name, path or run, and labels), read from the lineage index instead of the full record.No

Search lineage records across all the workspaces you can access

tw lineage search [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-q, --querySearch query. Combines free text and the qualifiers: type, workflow, task, pipeline, pipelineId, label, and workspace (org/name) or workspaceId to narrow the scope. Whitespace means AND, a comma inside a qualifier means OR. Example: -q 'type:FileOutput workspace:acme/dev multiqc'.No
--maxMaximum number of records per page (capped by the server)No
--page-tokenToken of the page to show, as printed by a previous search with the same queryNo

tw lineage upstream​

List the records one hop upstream of a task or file record. By default, the task that produced a file, or the input files of a task.

tw lineage upstream [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-w, --workspaceWorkspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable)Yes
-i, --idLineage record identifier (LID), e.g. lid://<hash>/<path>Yes
-t, --typeShow only records of this type (FileOutput, TaskRun)No

tw lineage downstream​

List the records one hop downstream of a task or file record. By default, the tasks that consumed a file, or the output files of a task.

tw lineage downstream [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-w, --workspaceWorkspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable)Yes
-i, --idLineage record identifier (LID), e.g. lid://<hash>/<path>Yes
-t, --typeShow only records of this type (FileOutput, TaskRun)No