get-lineage-by-name
Retrieve upstream and downstream lineage for a data entity using its fully qualified name. Specify entity type and lineage depth.
Instructions
Get upstream and downstream lineage for an entity by FQN
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes | Entity type | |
| fqn | Yes | Entity fully qualified name | |
| upstreamDepth | No | ||
| downstreamDepth | No |
Implementation Reference
- src/index.ts:32-34 (registration)Import of getLineageByNameSchema and getLineageByName from the lineage module
getLineageSchema, getLineage, getLineageByNameSchema, getLineageByName, addLineageSchema, addLineage, deleteLineageSchema, deleteLineage, } from "./tools/lineage.js"; - src/index.ts:204-204 (registration)Tool registration for 'get-lineage-by-name' using the schema and handler
tool("get-lineage-by-name", "Get upstream and downstream lineage for an entity by FQN", getLineageByNameSchema.shape, wrapToolHandler(getLineageByName)); - src/tools/lineage.ts:23-28 (schema)Zod schema for getLineageByName: validates entity (enum), fqn (string), upstreamDepth, downstreamDepth
export const getLineageByNameSchema = z.object({ entity: entityTypeEnum, fqn: z.string().describe("Entity fully qualified name"), upstreamDepth: z.coerce.number().optional().default(1), downstreamDepth: z.coerce.number().optional().default(1), }); - src/tools/lineage.ts:30-33 (handler)Handler function getLineageByName: destructures params, calls omClient.get(`/lineage/${entity}/name/${encodeURIComponent(fqn)}`) with query params
export async function getLineageByName(params: z.infer<typeof getLineageByNameSchema>) { const { entity, fqn, ...query } = params; return omClient.get(`/lineage/${entity}/name/${encodeURIComponent(fqn)}`, query); }