CouncilDataProject / CouncilDataProject/cdp-data

Add a `dump_to_sqlite` function to the library

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Jupyter Notebook
Stars
5
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Feature Description

Add a function to dump all data stored in a CDP Firestore database to a local `sqlite` file.

### Use Case

A lot more people know how to use SQL than our weird combination of Firestore + ORM in Python. And for tabular data (related to voting, legislation, people info, etc.), SQL is likely the best choice for quick and easy processing. There are also visualization engines that can read sqlite I believe??

### Solution

Add a function to the library (prototype fine for now) that takes in the CDP Instance name the user wants to create a CDP sqlite file for and the filepath / filename for where to dump the data to something like:

```python
def dump_to_sqlite(instance: str, path: Union[str, Path]):
```

That takes iteratively goes through each collection and requests data in batches from Firestore and writes in batches to the sqlite file.

### Notes

I assume the database models themselves should stay the same: [schema-diagram](https://councildataproject.org/cdp-backend/database_schema.html) & [model-docs](https://councildataproject.org/cdp-backend/cdp_backend.database.html#module-cdp_backend.database.models)

Since we use `FireO` for our "Firestore ORM" -- their docs on querying data (including batched) are likely important: https://octabyte.io/FireO/querying-data

An example of using the FireO models can be seen in [this notebook](https://github.com/CouncilDataProject/cdp-data/blob/main/notebooks/historical_vote_proportions.ipynb) or in our [source code](https://github.com/CouncilDataProject/cdp-data/blob/main/cdp_data/datasets.py#L338)

I say just use the [sqlite3](https://docs.python.org/3/library/sqlite3.html) library that ships with Python?

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.