Add documentation for native asyncio cursors#671
Merged
laughingman7743 merged 5 commits intomasterfrom Feb 21, 2026
Merged
Conversation
Add comprehensive documentation for the native asyncio cursor implementations added in PRs #666, #667, #668. This includes a new docs/aio.md overview page, AioCursor sections in each specialized cursor page, API reference for the aio module, and an async example in the README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the ### Async heading with a simple inline lead-in sentence to avoid an unbalanced section structure under Usage. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Explain why as_pandas/as_arrow/as_polars don't need await: the S3 download is wrapped in asyncio.to_thread inside execute(), so data is already in memory by the time fetch/as_* methods are called. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
When chunksize is set, execute() creates a lazy reader instead of loading all data. Subsequent iteration triggers blocking S3 reads not wrapped in asyncio.to_thread(). Document this limitation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
laughingman7743
force-pushed
the
docs/native-asyncio-cursors
branch
from
59bb39d to
ece3dda
Compare
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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.
Summary
docs/aio.mdpage documenting native asyncio cursors (AioCursor, AioDictCursor), theaconnect()function, async patterns (async with,async for), and a comparison table of sync vs AsyncCursor vs AioCursorpandas.md,arrow.md,polars.md,s3fs.md,spark.md)cursor.mdwith cross-references to all aio cursor sectionsaioto the Cursors toctree inindex.mddocs/api/aio.rstwith autodoc for all aio module classesapi.mdtoctree and quick reference sectionREADME.mdContext
PRs #666, #667, #668 added native asyncio cursors under
pyathena/aio/. The code is complete and merged, but there was no documentation for users to discover the aio API. This PR fills that gap.Test plan
make chkpasses (lint + mypy)cd docs && uv run sphinx-build -b html . _build/html🤖 Generated with Claude Code