Added Documentation for usage with async tools. Fixes #626 #633
Conversation
This file contains 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
|
📝 Docs preview for commit a5fe1d1 at: https://ececea1e.sqlmodel.pages.dev |
1 task
|
📝 Docs preview for commit b0081f5 at: https://049f644f.sqlmodel.pages.dev |
peidrao
suggested changes
Nov 19, 2023
| ``` | ||
|
|
||
| ## Final code | ||
| ``` |
Comment on lines
+15
to
+17
| ``` | ||
| pip install sqlmodel asyncpg fastapi uvicorn | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ``` | |
| pip install sqlmodel asyncpg fastapi uvicorn | |
| ``` | |
| ```bash | |
| pip install sqlmodel asyncpg fastapi uvicorn |
| ) | ||
|
|
||
|
|
||
| # Ayschronous Context manager for handling database sessions |
There was a problem hiding this comment.
Suggested change
| # Ayschronous Context manager for handling database sessions | |
| # Asynchronous Context manager for handling database sessions |
|
@tiangolo , are you merging this in this century or next? |
|
@tiangolo Why don't you add the contribution? |
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.
I have spent a good amount of time to figure out async implementation with SQLModel & FastAPI in one of our projects and thought this would be a helpful guide for anyone who is looking to do the same in their projects.
A simple working project is available here to test. Running the docker-compose will start the postgres with the required database: https://github.com/deshetti/sqlmodel-async-example