docs: add guide page for SQLAlchemyTableRetriever (#11791)

[Aarkin7]

Related Issues

• fixes Add docs page for SQLAlchemyTableRetriever component #11791

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.

[vercel]

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

A member of the Team first needs to authorize it.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
haystack-docs	Error		Jul 28, 2026 11:39am

[sjrl]

Hey @Aarkin7 sorry for the delay!

While I'm giving this a more in-depth review could you also copy over the docs pages to the 3.0.0 versioned docs folder?

[sjrl]

Hey @Aarkin7 soft ping on this!

[CLAassistant]

All committers have signed the CLA.

[github-actions]

Coverage report

Warning

The diff for this PR is too large to be retrieved from GitHub's API (maximum 300 files). Diff coverage is not available for this PR.

This PR does not seem to contain any modification to coverable code.

[Aarkin7]

Sorry for the delay, I’ve copied the SQLAlchemyTableRetriever docs into the version-3.0 docs and updated the related index/sidebar entries.

[sjrl]

Hey @Aarkin7 thanks for updating! Could I also ask you to remove the versions added to the 2.30 docs or also add it to the 2.31 docs. Otherwise it looks a bit odd that this component "disappears" between the two versions. Thanks!

[Aarkin7]

Thanks @sjrl for pointing it out. I have added the SQLAlchemyTableRetriever docs to the version-2.31 docs as well so the page is consistent across the versioned docs.

[sjrl]

Hey @Aarkin7 this file has a trailing whitespace in its name which is why the docs build is failing. Could you fix that?