docs: add guide page for SQLAlchemyTableRetriever (#11791)#11814
Open
Aarkin7 wants to merge 1 commit into
Open
docs: add guide page for SQLAlchemyTableRetriever (#11791)#11814Aarkin7 wants to merge 1 commit into
Aarkin7 wants to merge 1 commit into
Conversation
|
@Aarkin7 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
Related Issues
SQLAlchemyTableRetrievercomponent #11791Proposed Changes:
Adds a guide page for SQLAlchemyTableRetriever, the backend-agnostic table retriever that runs a SQL query through any SQLAlchemy-supported driver (Postgres, MySQL, SQLite, MSSQL, …) and returns a Pandas DataFrame plus a Markdown table. The component was already covered by the auto-synced API reference but had no narrative entry point explaining how to wire up the connection, use init_script, or plug it into a pipeline.
How did you test it?
Notes for the reviewer
Content is modelled on snowflaketableretriever.mdx, its closest peer. SQLAlchemy-specific bits (driver names, init_script, the three-key output with error for failed queries) are fresh prose.
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.