Skip to content

Commit

Permalink
Add Python syntax highlighting to readme (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
janosh authored Apr 9, 2024
1 parent 54248fb commit 214978a
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,49 @@
# mongo-arrow

Tools for using Apache Arrow with MongoDB

## Apache Arrow
We utilize Apache Arrow to offer fast and easy conversion of MongoDB query result sets to multiple numerical data formats popular among developers including NumPy ndarrays, Pandas DataFrames, parquet files, csv, and more.

We utilize Apache Arrow to offer fast and easy conversion of MongoDB query result sets to multiple numerical data formats popular among developers including NumPy arrays, Pandas DataFrames, parquet files, CSV, and more.

We chose Arrow for this because of its unique set of characteristics:

- language-independent
- columnar memory format for flat and hierarchical data,
- organized for efficient analytic operations on modern hardware like CPUs and GPUs
- zero-copy reads for lightning-fast data access without serialization overhead
- it was simple and fast, and from our perspective Apache Arrow is ideal for processing and transport of large datasets in high-performance applications.
- it was simple and fast, and from our perspective, Apache Arrow is ideal for processing and transporting of large datasets in high-performance applications.

As reference points for our implementation, we also took a look at BigQuery’s Pandas integration, pandas methods to handle JSON/semi-structured data, the Snowflake Python connector, and Dask.DataFrame.


## How it Works

Our implementation relies upon a user-specified data schema to marshall query result sets into tabular form.
Example
```

```py
from pymongoarrow.api import Schema
schema = Schema({'_id': int, 'amount': float, 'last_updated': datetime})

schema = Schema({"_id": int, "amount": float, "last_updated": datetime})
```

You can install PyMongoArrow on your local machine using Pip:
`$ python -m pip install pymongoarrow`

You can export data from MongoDB to a pandas dataframe easily using something like:
```
df = production.invoices.find_pandas_all({'amount': {'$gt': 100.00}}, schema=invoices)

```py
df = production.invoices.find_pandas_all({"amount": {"$gt": 100.00}}, schema=invoices)
```

Since PyMongoArrow can automatically infer the schema from the first batch of data, this can be
further simplified to:

```
df = production.invoices.find_pandas_all({'amount': {'$gt': 100.00}})
```py
df = production.invoices.find_pandas_all({"amount": {"$gt": 100.00}})
```

## Final Thoughts

This library is in the early stages of development, and so it's possible the API may change in the future -
we definitely want to continue expanding it. We welcome your feedback as we continue to explore and build this tool.

0 comments on commit 214978a

Please sign in to comment.