-
Notifications
You must be signed in to change notification settings - Fork 1
Conecta: Add index page #342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
(conecta)= | ||
# Conecta | ||
|
||
:::{rubric} About | ||
::: | ||
|
||
[Conecta] is a library designed to load data from SQL databases into Arrow | ||
with maximum speed and memory efficiency by leveraging zero-copy and true | ||
concurrency in Python. | ||
|
||
Conecta integrates natively with the arrow ecosystem by supporting several | ||
arrow libraries: [pyarrow], [arro3] and [nanoarrow]. Additionally, the | ||
database results can easily be converted to Polars or pandas. | ||
|
||
:::{rubric} Features | ||
::: | ||
|
||
* Connection pooling | ||
* Real multithreading | ||
* Client-based query partitioning | ||
* Utilities like: SQL bind parameters | ||
|
||
:::{rubric} Install | ||
::: | ||
|
||
```shell | ||
uv pip install --upgrade conecta polars pyarrow | ||
``` | ||
|
||
:::{rubric} Usage | ||
::: | ||
|
||
```python | ||
from pprint import pprint | ||
from conecta import read_sql | ||
|
||
table = read_sql( | ||
"postgres://crate:crate@localhost:5432/doc", | ||
queries=["SELECT country, region, mountain, height, latitude(coordinates), longitude(coordinates) FROM sys.summits ORDER BY height DESC LIMIT 3"], | ||
) | ||
|
||
# Display in Python format. | ||
pprint(table.to_pylist()) | ||
|
||
# Optionally convert to pandas dataframe. | ||
print(table.to_pandas()) | ||
|
||
# Optionally convert to Polars dataframe. | ||
import polars as pl | ||
print(pl.from_arrow(table)) | ||
``` | ||
|
||
```python | ||
[{'country': 'FR/IT', | ||
'height': 4808, | ||
'latitude': 45.8325, | ||
'longitude': 6.86444, | ||
'mountain': 'Mont Blanc', | ||
'region': 'Mont Blanc massif'}, | ||
{'country': 'CH', | ||
'height': 4634, | ||
'latitude': 45.93694, | ||
'longitude': 7.86694, | ||
'mountain': 'Monte Rosa', | ||
'region': 'Monte Rosa Alps'}, | ||
{'country': 'CH', | ||
'height': 4545, | ||
'latitude': 46.09389, | ||
'longitude': 7.85889, | ||
'mountain': 'Dom', | ||
'region': 'Mischabel'}] | ||
``` | ||
|
||
|
||
[arro3]: https://pypi.org/project/arro3-core/ | ||
[Conecta]: https://pypi.org/project/conecta/ | ||
[nanoarrow]: https://pypi.org/project/nanoarrow/ | ||
[pyarrow]: https://pypi.org/project/pyarrow/ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is a little flat and should better elaborate about Conecta's advanced features, right? Do you think it's still good enough for a start?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it encompasses well what it is, if you want , add a feature list like we have in the readme:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Added list with d8793d9.