> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Lineage Mixin

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L0")

# module `lineage_mixin`

Mixin class containing Lineage specific methods

To be used by OpenMetadata class

## **Global Variables**

* **LINEAGE\_PARSING\_TIMEOUT**

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L35")

## class `OMetaLineageMixin`

OpenMetadata API methods related to Lineage.

To be inherited by OpenMetadata

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L44")

### method `add_lineage`

```python theme={null}
add_lineage(data: AddLineageRequest) → Dict[str, Any]
```

Add lineage relationship between two entities and returns the entity information of the origin node

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L151")

### method `add_lineage_by_query`

```python theme={null}
add_lineage_by_query(
    database_service: DatabaseService,
    sql: str,
    database_name: str = None,
    schema_name: str = None,
    timeout: int = 10
) → None
```

Method parses the query and generated the lineage between source and target tables

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L138")

### method `delete_lineage_edge`

```python theme={null}
delete_lineage_edge(edge: EntitiesEdge) → None
```

Remove the given Edge

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L67")

### method `get_lineage_by_id`

```python theme={null}
get_lineage_by_id(
    entity: Union[Type[~T], str],
    entity_id: str,
    up_depth: int = 1,
    down_depth: int = 1
) → Optional[Dict[str, Any]]
```

Get lineage details for an entity `id`

**Args:**

`entity`: Type of the entity

`entity_id`: Entity ID

`up_depth`: Upstream depth of lineage (default=1, min=0, max=3)"

`down_depth`: Downstream depth of lineage (default=1, min=0, max=3)

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/lineage_mixin.py#L85")

### method `get_lineage_by_name`

```python theme={null}
get_lineage_by_name(
    entity: Union[Type[~T], str],
    fqn: str,
    up_depth: int = 1,
    down_depth: int = 1
) → Optional[Dict[str, Any]]
```

Get lineage details for an entity `id`

**Args:**

`entity`: Type of the entity

`fqn`: Entity FQN

`up_depth`: Upstream depth of lineage (default=1, min=0, max=3)"

`down_depth`: Downstream depth of lineage (default=1, min=0, max=3)

***