Skip to content

Commit

Permalink
cli readme update (#521)
Browse files Browse the repository at this point in the history
### What

Update the ndc-postgres-cli readme with the new commands.
  • Loading branch information
Gil Mizrahi authored Jul 15, 2024
1 parent b6ede41 commit 58ec61f
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions crates/cli/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,31 @@ Create a configuration in a new directory using the following commands:
```sh
CONNECTION_URI='<postgres-connection-string>' cargo run --bin ndc-postgres-cli -- --context='<directory>' update
```

## Upgrade a configuration

An older configuration version (e.g. "v3") can be upgraded to a newer one using the `upgrade` command.

```sh
cargo run --bin ndc-postgres-cli -- upgrade --dir-from <DIR_FROM> --dir-to <DIR_TO>
```

## Native Operations

Native Operations can be listed, added, and deleted using ndc-postgres-cli:

```sh
$ CONNECTION_URI='<postgres-connection-string>' cargo run --bin ndc-postgres-cli -- --context='<directory>' native-operation --help
Commands on Native Operations

Usage: hasura-ndc-postgres native-operation <COMMAND>

Commands:
list List the existing Native Operations
create Create a new Native Operation from a SQL file
delete Delete an existing Native Operation from the configuration
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
```

0 comments on commit 58ec61f

Please sign in to comment.