sqlxgentools/docs/tutorials/quick_start.md
2026-01-13 21:41:03 +01:00

39 lines
831 B
Markdown

# Quick start with sqlxgentools
Steps:
- Install the crate
- Declare your models
- Generate migrations
- Generate repositories
- Use repositories in your code
### CLI installation
The [sqlxgentools_cli crate](https://crates.io/crates/sqlxgentools_cli) provides the CLI,
it can be installed globally on your machine (or at least your user).
cargo install sqlxgentools_cli
### Project installation
Install the `sqlxgentools_attrs` crate
### Declare your models
TODO
### Generate migrations
Change directory into your project root.
sqlx-generator -m path/to/models_module gen-migrations -o path/to/migrations/all.sql
### Generate repositories
Change directory into your project root.
sqlx-generator -m path/to/models_module gen-repositories -o path/to/repositories_module
### Use the repositories
TODO