aboutsummaryrefslogtreecommitdiff
path: root/doc/book/build/rust.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2022-11-13 16:48:23 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2022-11-13 16:48:52 +0100
commitcf23aee1831e464b2a445a1ffb302086f32dd6e5 (patch)
tree68b88c0bd9246e1ccee834fecbbc174793f863b7 /doc/book/build/rust.md
parent74ea449f4be28d4f73d9c8edaf4a427b32c4602e (diff)
downloadgarage-cf23aee1831e464b2a445a1ffb302086f32dd6e5.tar.gz
garage-cf23aee1831e464b2a445a1ffb302086f32dd6e5.zip
Add a "build" section, doc for SDKecosystem/openapi
Diffstat (limited to 'doc/book/build/rust.md')
-rw-r--r--doc/book/build/rust.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/book/build/rust.md b/doc/book/build/rust.md
new file mode 100644
index 00000000..7101ba6e
--- /dev/null
+++ b/doc/book/build/rust.md
@@ -0,0 +1,47 @@
++++
+title = "Rust"
+weight = 40
++++
+
+## S3
+
+*Coming soon*
+
+Some refs:
+ - Amazon aws-rust-sdk
+ - [Github](https://github.com/awslabs/aws-sdk-rust)
+
+## K2V
+
+*Coming soon*
+
+Some refs: https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/k2v-client
+
+```bash
+# 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
+```
+
+## Admin API
+
+*Coming soon*