Driver: Improve section about Python #403
Open
+472
−221
Conversation
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
amotl
added
the
cross linking
WalkthroughReplaces the single Changes
Sequence Diagram(s)Documentation-only changes; no runtime control-flow changes, so no sequence diagram included. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
force-pushed
the
python
branch
2 times, most recently
from
e00bae2 to
b5fd235
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
changed the title
micropython-cratedb, and turbodbc
amotl
added
new content
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
amotl
commented
Oct 23, 2025
Comment on lines
+1
to
+30
| (crate-python)= | ||
| # crate-python | ||
|
|
||
| :::{div} .float-right .text-right | ||
| [](https://github.com/crate/cratedb-examples/actions/workflows/lang-python-dbapi.yml) | ||
| ::: | ||
| :::{div} .clearfix | ||
| ::: | ||
|
|
||
| The `crate` Python package offers a database client implementation compatible | ||
| with the Python Database API 2.0 specification, and also includes the CrateDB | ||
| SQLAlchemy dialect. See the full documentation {ref}`here <crate-python:index>`. | ||
| The package can be installed using `pip install crate`. | ||
|
|
||
| ```python | ||
| from crate import client | ||
|
|
||
| conn = client.connect("https://<name-of-your-cluster>.cratedb.net:4200", username="admin", password="<PASSWORD>", verify_ssl_cert=True) | ||
|
|
||
| with conn: | ||
| cursor = conn.cursor() | ||
| cursor.execute("SELECT * FROM sys.summits") | ||
| result = cursor.fetchone() | ||
| print(result) | ||
| ``` | ||
|
|
||
| - [Connect to CrateDB using the Python DB API] | ||
|
|
||
|
|
||
| [Connect to CrateDB using the Python DB API]: https://github.com/crate/cratedb-examples/tree/main/by-language/python-dbapi |
There was a problem hiding this comment.
Provide a runnable example for each item, e.g. by adding inline dependencies (PEP 723) implemented by uv, or by just adding a simple pip install ... incantation to the docs, followed up by an incantation how to invoke the program.
This has been conducted for all the other clients, so the Python area should not be left behind.
Comment on lines
+64
to
+119
| (python-dataframe)= | ||
| (df)= | ||
| (dataframe)= | ||
| (dataframes)= | ||
| (dataframe-examples)= | ||
| ## Dataframe libraries | ||
|
|
||
| Use CrateDB together with popular open-source dataframe libraries. | ||
| Each of them is using the CrateDB SQLAlchemy dialect for database | ||
| communications. | ||
|
|
||
| :::::{grid} 2 3 4 4 | ||
| :gutter: 3 3 4 5 | ||
| :padding: 0 | ||
|
|
||
| ::::{grid-item-card} Dask | ||
| :link: dask | ||
| :link-type: ref | ||
| :link-alt: Connect to CrateDB using Dask | ||
| :text-align: center | ||
| :class-card: sd-pt-3 | ||
| :class-body: sd-fs-1 | ||
| :class-title: sd-fs-6 | ||
| {height=40px} | ||
| :::: | ||
|
|
||
| ::::{grid-item-card} pandas | ||
| :link: pandas | ||
| :link-type: ref | ||
| :link-alt: Connect to CrateDB using pandas | ||
| :text-align: center | ||
| :class-card: sd-pt-3 | ||
| :class-body: sd-fs-1 | ||
| :class-title: sd-fs-6 | ||
| {height=40px} | ||
| :::: | ||
|
|
||
| ::::{grid-item-card} Polars | ||
| :link: polars | ||
| :link-type: ref | ||
| :link-alt: Connect to CrateDB using Polars | ||
| :text-align: center | ||
| :class-card: sd-pt-3 | ||
| :class-body: sd-fs-1 | ||
| :class-title: sd-fs-6 | ||
| {height=40px} | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::{tip} | ||
| The `insert_bulk` utility function from `sqlalchemy-cratedb` unlocks | ||
| a performance path, see also {ref}`sqlalchemy-cratedb:support-insert-bulk`. | ||
| About optimally configuring pandas and Dask for efficient insert operations, | ||
| see also {ref}`sqlalchemy-cratedb:dataframe`. | ||
| ::: |
There was a problem hiding this comment.
A few requests here.
- Expand dataframe libraries into individual pages.
- Absorb content from "integrations" section.
- Absorb content from SQLAlchemy dialect's DataFrame operations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
About
Preview
https://cratedb-guide--403.org.readthedocs.build/connect/python/
/cc @matriv, @seut