diff options
author | trinity-1686a <trinity.pointard@gmail.com> | 2022-05-18 22:24:09 +0200 |
---|---|---|
committer | Alex <alex@adnab.me> | 2022-05-18 22:24:09 +0200 |
commit | 64c193e3dbb536d5d3c2881bc9aebbb3e4e6272e (patch) | |
tree | 40f2b00ecaa0f1b14a1e08fbc7883c5305fe9552 /src/k2v-client/README.md | |
parent | c692f55d5ce2c3ed08db7fbc4844debcc0aeb134 (diff) | |
download | garage-64c193e3dbb536d5d3c2881bc9aebbb3e4e6272e.tar.gz garage-64c193e3dbb536d5d3c2881bc9aebbb3e4e6272e.zip |
Add a K2V client library and CLI (#303)
lib.rs could use getting split in modules, but I'm not sure how exactly
Co-authored-by: trinity-1686a <trinity@deuxfleurs.fr>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/303
Co-authored-by: trinity-1686a <trinity.pointard@gmail.com>
Co-committed-by: trinity-1686a <trinity.pointard@gmail.com>
Diffstat (limited to 'src/k2v-client/README.md')
-rw-r--r-- | src/k2v-client/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/k2v-client/README.md b/src/k2v-client/README.md new file mode 100644 index 00000000..db454805 --- /dev/null +++ b/src/k2v-client/README.md @@ -0,0 +1,25 @@ +Example usage: +```sh +# all these values can be provided on the cli instead +export AWS_ACCESS_KEY_ID=GK123456 +export AWS_SECRET_ACCESS_KEY=0123..789 +export AWS_REGION=garage +export K2V_ENDPOINT=http://172.30.2.1:3903 +export K2V_BUCKET=my-bucket + +cargo run --features=cli -- read-range my-partition-key --all + +cargo run --features=cli -- insert my-partition-key my-sort-key --text "my string1" +cargo run --features=cli -- insert my-partition-key my-sort-key --text "my string2" +cargo run --features=cli -- insert my-partition-key my-sort-key2 --text "my string" + +cargo run --features=cli -- read-range my-partition-key --all + +causality=$(cargo run --features=cli -- read my-partition-key my-sort-key2 -b | head -n1) +cargo run --features=cli -- delete my-partition-key my-sort-key2 -c $causality + +causality=$(cargo run --features=cli -- read my-partition-key my-sort-key -b | head -n1) +cargo run --features=cli -- insert my-partition-key my-sort-key --text "my string3" -c $causality + +cargo run --features=cli -- read-range my-partition-key --all +``` |