> ## 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.

# Ingestion Pipeline 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/ingestion_pipeline_mixin.py#L0")

# module `ingestion_pipeline_mixin`

Mixin class containing ingestion pipeline specific methods

To be used by OpenMetadata class

***

[<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/ingestion_pipeline_mixin.py#L29")

## class `OMetaIngestionPipelineMixin`

OpenMetadata API methods related to ingestion pipeline.

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/ingestion_pipeline_mixin.py#L38")

### method `create_or_update_pipeline_status`

```python theme={null}
create_or_update_pipeline_status(
    ingestion_pipeline_fqn: str,
    pipeline_status: PipelineStatus
) → None
```

PUT create or update pipeline status

**Args:**

`ingestion_pipeline_fqn`: Ingestion Pipeline FQN

`pipeline_status`: Pipeline Status data to add

***

[<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/ingestion_pipeline_mixin.py#L109")

### method `get_ingestion_pipeline_by_name`

```python theme={null}
get_ingestion_pipeline_by_name(
    fields: Optional[List[str]] = None,
    params: Optional[Dict[str, str]] = None
) → Optional[IngestionPipeline]
```

Get ingestion pipeline statues based on name

**Args:**

* `name` (str):  Ingestion Pipeline Name
* `fields` (List\[str]):  List of all the fields

***

[<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/ingestion_pipeline_mixin.py#L56")

### method `get_pipeline_status`

```python theme={null}
get_pipeline_status(
    ingestion_pipeline_fqn: str,
    pipeline_status_run_id: str
) → Optional[PipelineStatus]
```

GET pipeline status

**Args:**

`ingestion_pipeline_fqn`: Ingestion Pipeline FQN

`pipeline_status_run_id`: Pipeline Status run id

***

[<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/ingestion_pipeline_mixin.py#L84")

### method `get_pipeline_status_between_ts`

```python theme={null}
get_pipeline_status_between_ts(
    ingestion_pipeline_fqn: str,
    start_ts: int,
    end_ts: int
) → Optional[List[PipelineStatus]]
```

Get pipeline status between timestamp

**Args:**

* `ingestion_pipeline_fqn` (str):  pipeline fqn
* `start_ts` (int):  start\_ts
* `end_ts` (int):  end\_ts

***

[<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/ingestion_pipeline_mixin.py#L72")

### method `run_pipeline`

```python theme={null}
run_pipeline(ingestion_pipeline_id: str) → IngestionPipeline
```

Run ingestion pipeline workflow

**Args:**

* `ingestion_pipeline_id` (str):  ingestion pipeline uuid

***