mirror of
https://github.com/actix/actix-website
synced 2024-12-18 01:43:59 +01:00
2aacdf2f70
* chore: add VS Code extension recommendations * Update image URLs in README and documentation files * chore: disable no-inline-html rule * chore: use standard md/mdx syntax, and use .jsx for react components * chore: fix email links in Code of Conduct The commit message suggests fixing the email links in the Code of Conduct file to use the correct `mailto:` syntax. * chore: update actix-web error helper links Update the links to the `actix-web` error helper traits in the `databases.md` and `errors.md` files to use the correct URLs. * chore: restore unused actix-web error helper links * Update src/pages/community/coc.md Co-authored-by: Rob Ede <robjtede@icloud.com> * Update docs/getting-started.md Co-authored-by: Rob Ede <robjtede@icloud.com> --------- Co-authored-by: Rob Ede <robjtede@icloud.com>
37 lines
2.0 KiB
Markdown
37 lines
2.0 KiB
Markdown
---
|
|
title: Databases
|
|
---
|
|
|
|
import CodeBlock from "@site/src/components/code_block";
|
|
|
|
# Async Options
|
|
|
|
We have several example projects showing use of async database adapters:
|
|
|
|
- [Postgres](https://github.com/actix/examples/tree/master/databases/postgres)
|
|
- [SQLite](https://github.com/actix/examples/tree/master/databases/sqlite)
|
|
- [MongoDB](https://github.com/actix/examples/tree/master/databases/mongodb)
|
|
|
|
# Diesel
|
|
|
|
The current versions of Diesel (v1/v2) does not support asynchronous operations, so it is important to use the [`web::block`][web-block] function to offload your database operations to the Actix runtime thread-pool.
|
|
|
|
You can create action functions that correspond to all the operations your app will perform on the database.
|
|
|
|
<CodeBlock example="databases" file="main.rs" section="handler" />
|
|
|
|
Now you should set up the database pool using a crate such as `r2d2`, which makes many DB connections available to your app. This means that multiple handlers can manipulate the DB at the same time, and still accept new connections. Simply, the pool in your app state. (In this case, it's beneficial not to use a state wrapper struct because the pool handles shared access for you.)
|
|
|
|
<CodeBlock example="databases" file="main.rs" section="main" />
|
|
|
|
Now, in a request handler, use the `Data<T>` extractor to get the pool from app state and get a connection from it. This provides an owned database connection that can be passed into a [`web::block`][web-block] closure. Then just call the action function with the necessary arguments and `.await` the result.
|
|
|
|
This example also maps the error to an `HttpResponse` before using the `?` operator but this is not necessary if your return error type implements [`ResponseError`][response-error].
|
|
|
|
<CodeBlock example="databases" file="main.rs" section="index" />
|
|
|
|
That's it! See the full example [here](https://github.com/actix/examples/tree/master/databases/diesel).
|
|
|
|
[web-block]: https://docs.rs/actix-web/4/actix_web/web/fn.block.html
|
|
[response-error]: https://docs.rs/actix-web/4/actix_web/error/trait.ResponseError.html
|