History

Sergio Benitez 02011a1307 Clean up codebase: fix reasonable clippy warnings. This commit is a codebase-wide cleanup driven by clippy warnings. In addition to fixing every reasonable warning, the following new functionality was introduced: * `Accept::new()` now takes any `T: Into<QMediaType>` iterator. * `TempFile::is_empty()` was added. * `HeaderMap` now implements `IntoIterator`. This commit makes the following breaking changes: * The `IntoCollection` trait is gone. Generics previously bound by the trait are now bound by `IntoIterator`. This affects: - `Accept::new()` - `ContentType::with_params()` - `Permission::{allow, allowed}()` * `MediaType`, `QMediaType`, and `Allow` implement `IntoIterator`, enabling most existing code to continue working without change. * The inherent `HeaderMap::into_iter()` method was removed. * The `Ok` variant in ErrorKind::Liftoff` is now `Box<Rocket<Orbit>>`.		2024-03-20 00:47:38 -07:00
..
.sqlx	Update 'databases' example README.	2023-08-25 15:19:15 -07:00
db	Add support for 'diesel-async' to 'db_pools'.	2023-06-09 16:47:06 -07:00
src	Clean up codebase: fix reasonable clippy warnings.	2024-03-20 00:47:38 -07:00
Cargo.toml	Update 'databases' example README.	2023-08-25 15:19:15 -07:00
README.md	Update 'databases' example README.	2023-08-25 15:19:15 -07:00
Rocket.toml	Add support for 'diesel-async' to 'db_pools'.	2023-06-09 16:47:06 -07:00

README.md

Databases Example

This example makes use of SQLite and MySQL. You'll need sqlite3 and a MySQL client installed:

macOS: brew install sqlite mysql-client
Debian, Ubuntu: apt-get install libsqlite3-dev libmysqlclient-dev
Arch: pacman -S sqlite libmysqlclient

API Implementation

This example implements a JSON-based HTTP API for a "blog" using several database drivers:

sqlx (/sqlx, sqlx.rs)
rusqlite (/rusqlite, rusqlite.rs)
diesel (sqlite) (/diesel, diesel_sqlite.rs)
diesel-async (mysql) (/diesel-async, diesel_mysql.rs)

The exposed API is succinctly described as follows, with httpie CLI examples:

POST /driver: create post via JSON with title and text; returns new post JSON with new id

http http://127.0.0.1:8000/sqlx title="Title" text="Hello, world."
> { "id": 2128, "text": "Hello, world.", "title": "Title" }

GET /driver: returns JSON array of IDs for blog posts

http http://127.0.0.1:8000/sqlx
> [ 2128, 2129, 2130, 2131 ]

GET /driver/<id>: returns a JSON object for the post with id <id>

http http://127.0.0.1:8000/sqlx/2128
> { "id": 2128, "text": "Hello, world.", "title": "Title" }

DELETE /driver: delete all posts
```
http delete http://127.0.0.1:8000/sqlx
```
DELETE /driver/<id>: delete post with id <id>
```
http delete http://127.0.0.1:8000/sqlx/4
```

Migrations

Database migrations are stored in the respective db/${driver} directory.

`diesel`

Diesel migrations are found in db/diesel/migrations. They are run automatically. They can be run manually as well:

cargo install diesel_cli --no-default-features --features sqlite
DATABASE_URL="db/diesel/db.sqlite" diesel migration --migration-dir db/diesel/migrations redo

`sqlx`

sqlx migrations are found in db/sqlx/migrations. They are run automatically.

Query metadata for offline checking was prepared with the following commands:

cargo install sqlx-cli --no-default-features --features sqlite
DATABASE_URL="sqlite:$(pwd)/db/sqlx/db.sqlite" cargo sqlx prepare