Generate Lineage Documentation Tool
Generate Lineage Documentation Tool
Section titled “Generate Lineage Documentation Tool”This tool analyzes the lineage of a table and produces a written summary of how its data is built and consumed. It traces upstream to find source tables and column transformations, and downstream to find the tables and BI objects that use the table. The result can be returned as data, or written directly into a catalog document.
It backs the documentation capability of the out-of-the-box Lineage Agent.
When to use it
Section titled “When to use it”Add this tool to an agent that should not just answer lineage questions but record the answer as governed documentation: a “how is this table built” write-up attached to the catalog.
Parameters
Section titled “Parameters”| Parameter | Required | Type | Suggested scope | What it does |
|---|---|---|---|---|
table_id | Yes | integer | User input | The table to document. |
max_depth | No | integer (default 10) | Fixed | How far upstream to trace. |
folder_id | No | integer | Fixed or User input | Folder to create the document in. |
document_hub_id | No | integer | Fixed or User input | Document hub for the new document. |
template_id | No | integer | Fixed | Template the document should use. |
field_mapping | No | object | Fixed | Maps the analysis results (source tables, column transformations, downstream consumers, and so on) to template field IDs. |
See Configuring tool parameters for what the scope column means.
Output
Section titled “Output”Either a JSON analysis of the table’s lineage, or — when the document parameters are supplied — the ID of the catalog document it created. The analysis covers source tables, downstream tables and BI consumers, column transformations, pass-through columns, columns with unknown lineage, and data quality notes.