Merge branch 'main' into admin-api
This commit is contained in:
commit
86a3fe8ec5
3 changed files with 137 additions and 9 deletions
|
@ -195,6 +195,10 @@ TO UNDERSTAND IN ORDER TO USE IT CORRECTLY.**
|
||||||
|
|
||||||
## API Endpoints
|
## API Endpoints
|
||||||
|
|
||||||
|
**Remark.** Example queries and responses here are given in JSON5 format
|
||||||
|
for clarity. However the actual K2V API uses basic JSON so all examples
|
||||||
|
and responses need to be translated.
|
||||||
|
|
||||||
### Operations on single items
|
### Operations on single items
|
||||||
|
|
||||||
**ReadItem: `GET /<bucket>/<partition key>?sort_key=<sort key>`**
|
**ReadItem: `GET /<bucket>/<partition key>?sort_key=<sort key>`**
|
||||||
|
@ -370,8 +374,11 @@ HTTP/1.1 204 NO CONTENT
|
||||||
**ReadIndex: `GET /<bucket>?start=<start>&end=<end>&limit=<limit>`**
|
**ReadIndex: `GET /<bucket>?start=<start>&end=<end>&limit=<limit>`**
|
||||||
|
|
||||||
Lists all partition keys in the bucket for which some triplets exist, and gives
|
Lists all partition keys in the bucket for which some triplets exist, and gives
|
||||||
for each the number of triplets (or an approximation thereof, this value is
|
for each the number of triplets, total number of values (which might be bigger
|
||||||
asynchronously updated, and thus eventually consistent).
|
than the number of triplets in case of conflicts), total number of bytes of
|
||||||
|
these values, and number of triplets that are in a state of conflict.
|
||||||
|
The values returned are an approximation of the true counts in the bucket,
|
||||||
|
as these values are asynchronously updated, and thus eventually consistent.
|
||||||
|
|
||||||
Query parameters:
|
Query parameters:
|
||||||
|
|
||||||
|
@ -426,11 +433,41 @@ HTTP/1.1 200 OK
|
||||||
limit: null,
|
limit: null,
|
||||||
reverse: false,
|
reverse: false,
|
||||||
partitionKeys: [
|
partitionKeys: [
|
||||||
{ pk: "keys", n: 3043 },
|
{
|
||||||
{ pk: "mailbox:INBOX", n: 42 },
|
pk: "keys",
|
||||||
{ pk: "mailbox:Junk", n: 2991 },
|
entries: 3043,
|
||||||
{ pk: "mailbox:Trash", n: 10 },
|
conflicts: 0,
|
||||||
{ pk: "mailboxes", n: 3 },
|
values: 3043,
|
||||||
|
bytes: 121720,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
pk: "mailbox:INBOX",
|
||||||
|
entries: 42,
|
||||||
|
conflicts: 1,
|
||||||
|
values: 43,
|
||||||
|
bytes: 142029,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
pk: "mailbox:Junk",
|
||||||
|
entries: 2991
|
||||||
|
conflicts: 0,
|
||||||
|
values: 2991,
|
||||||
|
bytes: 12019322,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
pk: "mailbox:Trash",
|
||||||
|
entries: 10,
|
||||||
|
conflicts: 0,
|
||||||
|
values: 10,
|
||||||
|
bytes: 32401,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
pk: "mailboxes",
|
||||||
|
entries: 3,
|
||||||
|
conflicts: 0,
|
||||||
|
values: 3,
|
||||||
|
bytes: 3019,
|
||||||
|
},
|
||||||
],
|
],
|
||||||
more: false,
|
more: false,
|
||||||
nextStart: null,
|
nextStart: null,
|
||||||
|
|
|
@ -74,7 +74,11 @@ where
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if let Some(e) = end {
|
if let Some(e) = end {
|
||||||
if entry.sort_key() == e {
|
let is_finished = match enumeration_order {
|
||||||
|
EnumerationOrder::Forward => entry.sort_key() >= e,
|
||||||
|
EnumerationOrder::Reverse => entry.sort_key() <= e,
|
||||||
|
};
|
||||||
|
if is_finished {
|
||||||
return Ok((entries, false, None));
|
return Ok((entries, false, None));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -92,7 +92,9 @@ async fn test_batch() {
|
||||||
br#"[
|
br#"[
|
||||||
{"partitionKey": "root"},
|
{"partitionKey": "root"},
|
||||||
{"partitionKey": "root", "start": "c"},
|
{"partitionKey": "root", "start": "c"},
|
||||||
|
{"partitionKey": "root", "start": "c", "end": "dynamite"},
|
||||||
{"partitionKey": "root", "start": "c", "reverse": true, "end": "a"},
|
{"partitionKey": "root", "start": "c", "reverse": true, "end": "a"},
|
||||||
|
{"partitionKey": "root", "start": "c", "reverse": true, "end": "azerty"},
|
||||||
{"partitionKey": "root", "limit": 1},
|
{"partitionKey": "root", "limit": 1},
|
||||||
{"partitionKey": "root", "prefix": "d"}
|
{"partitionKey": "root", "prefix": "d"}
|
||||||
]"#
|
]"#
|
||||||
|
@ -147,6 +149,24 @@ async fn test_batch() {
|
||||||
"more": false,
|
"more": false,
|
||||||
"nextStart": null,
|
"nextStart": null,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"partitionKey": "root",
|
||||||
|
"prefix": null,
|
||||||
|
"start": "c",
|
||||||
|
"end": "dynamite",
|
||||||
|
"limit": null,
|
||||||
|
"reverse": false,
|
||||||
|
"conflictsOnly": false,
|
||||||
|
"tombstones": false,
|
||||||
|
"singleItem": false,
|
||||||
|
"items": [
|
||||||
|
{"sk": "c", "ct": ct.get("c").unwrap(), "v": [base64::encode(values.get("c").unwrap())]},
|
||||||
|
{"sk": "d.1", "ct": ct.get("d.1").unwrap(), "v": [base64::encode(values.get("d.1").unwrap())]},
|
||||||
|
{"sk": "d.2", "ct": ct.get("d.2").unwrap(), "v": [base64::encode(values.get("d.2").unwrap())]},
|
||||||
|
],
|
||||||
|
"more": false,
|
||||||
|
"nextStart": null,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"partitionKey": "root",
|
"partitionKey": "root",
|
||||||
"prefix": null,
|
"prefix": null,
|
||||||
|
@ -164,6 +184,23 @@ async fn test_batch() {
|
||||||
"more": false,
|
"more": false,
|
||||||
"nextStart": null,
|
"nextStart": null,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"partitionKey": "root",
|
||||||
|
"prefix": null,
|
||||||
|
"start": "c",
|
||||||
|
"end": "azerty",
|
||||||
|
"limit": null,
|
||||||
|
"reverse": true,
|
||||||
|
"conflictsOnly": false,
|
||||||
|
"tombstones": false,
|
||||||
|
"singleItem": false,
|
||||||
|
"items": [
|
||||||
|
{"sk": "c", "ct": ct.get("c").unwrap(), "v": [base64::encode(values.get("c").unwrap())]},
|
||||||
|
{"sk": "b", "ct": ct.get("b").unwrap(), "v": [base64::encode(values.get("b").unwrap())]},
|
||||||
|
],
|
||||||
|
"more": false,
|
||||||
|
"nextStart": null,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"partitionKey": "root",
|
"partitionKey": "root",
|
||||||
"prefix": null,
|
"prefix": null,
|
||||||
|
@ -465,6 +502,34 @@ async fn test_batch() {
|
||||||
])
|
])
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// update our known tombstones
|
||||||
|
for sk in ["a", "b", "d.1", "d.2"] {
|
||||||
|
let res = ctx
|
||||||
|
.k2v
|
||||||
|
.request
|
||||||
|
.builder(bucket.clone())
|
||||||
|
.path("root")
|
||||||
|
.query_param("sort_key", Some(sk))
|
||||||
|
.signed_header("accept", "application/octet-stream")
|
||||||
|
.send()
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(res.status(), 204);
|
||||||
|
assert_eq!(
|
||||||
|
res.headers().get("content-type").unwrap().to_str().unwrap(),
|
||||||
|
"application/octet-stream"
|
||||||
|
);
|
||||||
|
ct.insert(
|
||||||
|
sk,
|
||||||
|
res.headers()
|
||||||
|
.get("x-garage-causality-token")
|
||||||
|
.unwrap()
|
||||||
|
.to_str()
|
||||||
|
.unwrap()
|
||||||
|
.to_string(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
let res = ctx
|
let res = ctx
|
||||||
.k2v
|
.k2v
|
||||||
.request
|
.request
|
||||||
|
@ -473,7 +538,8 @@ async fn test_batch() {
|
||||||
.body(
|
.body(
|
||||||
br#"[
|
br#"[
|
||||||
{"partitionKey": "root"},
|
{"partitionKey": "root"},
|
||||||
{"partitionKey": "root", "reverse": true}
|
{"partitionKey": "root", "reverse": true},
|
||||||
|
{"partitionKey": "root", "tombstones": true}
|
||||||
]"#
|
]"#
|
||||||
.to_vec(),
|
.to_vec(),
|
||||||
)
|
)
|
||||||
|
@ -520,6 +586,27 @@ async fn test_batch() {
|
||||||
"more": false,
|
"more": false,
|
||||||
"nextStart": null,
|
"nextStart": null,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"partitionKey": "root",
|
||||||
|
"prefix": null,
|
||||||
|
"start": null,
|
||||||
|
"end": null,
|
||||||
|
"limit": null,
|
||||||
|
"reverse": false,
|
||||||
|
"conflictsOnly": false,
|
||||||
|
"tombstones": true,
|
||||||
|
"singleItem": false,
|
||||||
|
"items": [
|
||||||
|
{"sk": "a", "ct": ct.get("a").unwrap(), "v": [null]},
|
||||||
|
{"sk": "b", "ct": ct.get("b").unwrap(), "v": [null]},
|
||||||
|
{"sk": "c", "ct": ct.get("c").unwrap(), "v": [base64::encode(values.get("c").unwrap()), base64::encode(values.get("c'").unwrap())]},
|
||||||
|
{"sk": "d.1", "ct": ct.get("d.1").unwrap(), "v": [null]},
|
||||||
|
{"sk": "d.2", "ct": ct.get("d.2").unwrap(), "v": [null]},
|
||||||
|
{"sk": "e", "ct": ct.get("e").unwrap(), "v": [base64::encode(values.get("e").unwrap())]},
|
||||||
|
],
|
||||||
|
"more": false,
|
||||||
|
"nextStart": null,
|
||||||
|
},
|
||||||
])
|
])
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue