docs(cli): fix incorrect config class and parameter in example - #776
Merged
hasansezertasan merged 2 commits intoJul 22, 2026
Merged
Conversation
`SQLAlchemyConfig` does not exist; use `SQLAlchemySyncConfig`. The parameter is `connection_string`, not `connection_url`. Also removed an unused `create_engine` import. Closes litestar-org#728
github-actions
Bot
added
area/docs
size: small
type/docs
pr/external
Triage Required 🏥
labels
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #776 +/- ##
=======================================
Coverage ? 82.45%
=======================================
Files ? 105
Lines ? 9039
Branches ? 1219
=======================================
Hits ? 7453
Misses ? 1260
Partials ? 326 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The --config option description referenced the non-existent SQLAlchemyConfig class. Replace with the actual exported types SQLAlchemySyncConfig and SQLAlchemyAsyncConfig for consistency with the corrected code example.
hasansezertasan
enabled auto-merge (squash)
July 22, 2026 09:59
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
3 participants
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
The CLI documentation example in
docs/usage/cli.rstwould fail if copy-pasted:SQLAlchemyConfigis not a real export — replaced withSQLAlchemySyncConfigconnection_urlis not a valid parameter — replaced withconnection_stringfrom sqlalchemy import create_engineimportAlso fixed the matching prose in the Global Options table, which described
--configas "an instance ofSQLAlchemyConfig(sync or async)" — replaced with the real exported typesSQLAlchemySyncConfigorSQLAlchemyAsyncConfigso the whole page is consistent.Verified against source:
advanced_alchemy/config/__init__.pyexports onlySQLAlchemySyncConfig/SQLAlchemyAsyncConfig, and the field is defined asconnection_stringinadvanced_alchemy/config/common.py.Closes #728
📚 Documentation preview: https://litestar-org.github.io/advanced-alchemy-docs-preview/776