Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove reference to DatabaseMiddleware in the documentation #1845

Merged
merged 2 commits into from Sep 6, 2022
Merged

Remove reference to DatabaseMiddleware in the documentation #1845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f97b8
Remove reference to `DatabaseMiddleware` in the documentation
Kludex Sep 5, 2022
b105975
Merge branch 'master' into remove-database-middleware-reference
Kludex Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/config.md
View file
Open in desktop
Expand Up @@ -224,9 +224,6 @@ def client():
"""
# Our fixture is created within a context manager. This ensures that
# application startup and shutdown run for every test case.
#
# Because we've configured the DatabaseMiddleware with `rollback_on_shutdown`
# we'll get a complete rollback to the initial state after each test case runs.
with TestClient(app) as test_client:
yield test_client
```
Expand Down
4 changes: 0 additions & 4 deletions docs/database.md
View file
Open in desktop
Expand Up @@ -6,10 +6,6 @@ or use regular non-async endpoints, and integrate with [SQLAlchemy](https://www.
In this documentation we'll demonstrate how to integrate against [the `databases` package](https://github.com/encode/databases),
which provides SQLAlchemy core support against a range of different database drivers.

**Note**: Previous versions of Starlette included a built-in `DatabaseMiddleware`.
This option is currently still available but should be considered as pending deprecation.
It will be removed in a future release. The legacy documentation [is available here](https://github.com/encode/starlette/blob/0.10.2/docs/database.md).

Here's a complete example, that includes table definitions, configuring a `database.Database`
instance, and a couple of endpoints that interact with the database.

Expand Down