docs: add federated passthrough queries section#715
Merged
Conversation
Document the `TABLE(<connector>.system.query(query => '...'))` syntax for pushing native SQL directly to federated data sources. PyAthena supports this out of the box since the SQL is passed through to Athena unchanged. Refs #712
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.
WHAT
Add a new "Federated passthrough queries" section to
docs/usage.mdcovering theTABLE(<connector>.system.query(query => '...'))syntax for federated data sources, with a runnable example usingCursor.execute().WHY
Passthrough queries let users push native SQL directly to source systems (PostgreSQL, MySQL, Snowflake, etc.) instead of relying on Athena's planner translation. PyAthena already supports them — the SQL is passed through unchanged — but the feature is undocumented, so users may not realize it works out of the box.
Closes #712