Skip to content

Update documentation for cli prepare command for workspaces #2386

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update documentation for cli prepare command for workspaces #2386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions sqlx-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,11 @@ cargo sqlx prepare
```

Invoking `prepare` saves query metadata to `.sqlx` in the current directory.
For workspaces where several crates are using query macros, pass the `--workspace` flag
For workspaces where several crates are using query macros, pass the `--merged` flag
to generate a single `.sqlx` directory at the root of the workspace.

```bash
cargo sqlx prepare --workspace
cargo sqlx prepare --merged
```

Check this directory into version control and an active database connection will
Expand All @@ -134,7 +134,7 @@ no longer be needed to build your project.
```bash
cargo sqlx prepare --check
# OR
cargo sqlx prepare --check --workspace
cargo sqlx prepare --check --merged
```

Exits with a nonzero exit status if the data in `.sqlx` is out of date with the current
Expand Down