airbytehq / airbytehq/PyAirbyte

💡 Feature Proposal: Add a way to clean up after a lazy `Source.get_records()` generator is abandoned

Open
#442 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
344
Forks
77
Avg merge
1d 11h
Merged PRs (30d)
35

Description

Today, the `Source.get_records()` method returns a `LazyDataset` that can be iterated upon to get records.

Given a source declared like this:

```python
import airbyte as ab

source = ab.get_source(...)
```

You can iterate over records lazily like this:

```python
max_records = 10

dataset: ab.LazyDataset = source.get_records("my_stream")
for record, x in enumerate(dataset):
if x > max_records:
break
print(record)
```

This approach uses the dataset as an iterator and then aborts after the necessary count of records is found.

However, the connector process itself is not shut down when we stop iterating from it.

## Improvement Proposal

Ideally, we'd add a callback to close the connection on the lazy dataset - _and/or_ we'd operate like a context manager and auto-clean up the process when the context manager exits.

In practice, this has not caused any problems for our use cases - but it would be good to improve handling here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.