Skip to content

docs: add guide page for SQLAlchemyTableRetriever (#11791)#11814

Open
Aarkin7 wants to merge 1 commit into
deepset-ai:mainfrom
Aarkin7:docs/sqlalchemy-table-retriever
Open

docs: add guide page for SQLAlchemyTableRetriever (#11791)#11814
Aarkin7 wants to merge 1 commit into
deepset-ai:mainfrom
Aarkin7:docs/sqlalchemy-table-retriever

Conversation

@Aarkin7

@Aarkin7 Aarkin7 commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Related Issues

Proposed 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?

  • npm run start in docs-website/ : page renders, key-value table looks right, sidebar shows the new entry in the expected slot.
  • npm run build, no broken links or MDX errors.
  • Manually clicked through every internal link in the page (PromptBuilder, Secret, sibling SnowflakeTableRetriever, /reference/integrations-sqlalchemy).

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

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@Aarkin7 Aarkin7 requested a review from a team as a code owner June 29, 2026 13:43
@Aarkin7 Aarkin7 requested review from sjrl and removed request for a team June 29, 2026 13:43
@vercel

vercel Bot commented Jun 29, 2026

Copy link
Copy Markdown

@Aarkin7 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Jun 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 29, 2026 1:48pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs page for SQLAlchemyTableRetriever component

1 participant