doc: Add datastoreusage command to the docs

Signed-off-by: Peter Neuroth <[email protected]>

doc/Makefile

@@ -32,6 +32,7 @@ MANPAGES := doc/lightning-cli.1 \
 	doc/lightning-createinvoice.7 \
 	doc/lightning-createrune.7 \
 	doc/lightning-datastore.7 \
+	doc/lightning-datastoreusage.7 \
 	doc/lightning-decodepay.7 \
 	doc/lightning-decode.7 \
 	doc/lightning-deldatastore.7 \

doc/index.rst

@@ -55,6 +55,7 @@ Core Lightning Documentation
    lightning-createonion <lightning-createonion.7.md>
    lightning-createrune <lightning-createrune.7.md>
    lightning-datastore <lightning-datastore.7.md>
+   lightning-datastoreusage <lightning-datastoreusage.7.md>
    lightning-decode <lightning-decode.7.md>
    lightning-decodepay <lightning-decodepay.7.md>
    lightning-deldatastore <lightning-deldatastore.7.md>

doc/lightning-datastore.7.md

@@ -59,7 +59,7 @@ Rusty Russell <<[email protected]>> is mainly responsible.
 SEE ALSO
 --------
 
-lightning-listdatastore(7), lightning-deldatastore(7)
+lightning-listdatastore(7), lightning-deldatastore(7), lightning-datastoreusage(7)
 
 RESOURCES
 ---------

doc/lightning-datastoreusage.7.md

@@ -0,0 +1,43 @@
+lightning-datastoreusage -- Command for listing datastore usage info
+============================================================
+
+SYNOPSIS
+--------
+
+**datastoreusage**
+
+DESCRIPTION
+-----------
+
+The **datastoreusage** RPC command allows the caller to fetch the 
+total bytes that are stored under a certain *key* (or from the root),
+including the size of the *key*.
+
+All descendants of the *key* (or root) are taken into account.
+RETURN VALUE
+------------
+
+[comment]: # (GENERATE-FROM-SCHEMA-START)
+On success, an object containing **datastoreusage** is returned.  It is an object containing:
+
+- **key** (string): The key from which the database was traversed.
+- **total\_bytes** (u64): The total bytes that are stored under the *key*, including the all descendants data and the size of the keys themselves.
+
+[comment]: # (GENERATE-FROM-SCHEMA-END)
+
+AUTHOR
+------
+
+Peter Neuroth <<[email protected]>> is mainly responsible.
+
+SEE ALSO
+--------
+
+lightning-datastore(7), lightning-deldatastore(7), lightning-listdatastore(7)
+
+RESOURCES
+---------
+
+Main web site: <https://github.com/ElementsProject/lightning>
+
+[comment]: # ( SHA256STAMP:743b3308974872f191362fcd0b1af647ea1efd28ae30ea04f6deb22418871a17)

doc/lightning-deldatastore.7.md

@@ -42,7 +42,7 @@ Rusty Russell <<[email protected]>> is mainly responsible.
 SEE ALSO
 --------
 
-lightning-listdatastore(7), lightning-datastore(7)
+lightning-listdatastore(7), lightning-datastore(7), lightning-datastoreusage(7)
 
 RESOURCES
 ---------

doc/lightning-listdatastore.7.md

@@ -40,7 +40,7 @@ Rusty Russell <<[email protected]>> is mainly responsible.
 SEE ALSO
 --------
 
-lightning-datastore(7), lightning-deldatastore(7)
+lightning-datastore(7), lightning-deldatastore(7), lightning-datastoreusage(7)
 
 RESOURCES
 ---------

doc/schemas/datastoreusage.request.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [],
+  "added": "v23.08",
+  "properties": {
+    "key": {
+      "oneOf": [
+        {
+          "type": "array",
+          "description": "key is an array of values (though a single value is treated as a one-element array). Used as the staring point to traverse the datastore.",
+          "items": {
+            "type": "string"
+          }
+        },
+        {
+          "type": "string"
+        }
+      ]
+    }
+  }
+}

doc/schemas/datastoreusage.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "datastoreusage"
+  ],
+  "properties": {
+    "datastoreusage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "total_bytes"
+      ],
+      "properties": {
+        "key": {
+          "type": "string",
+          "description": "The key from which the database was traversed."
+        },
+        "total_bytes": {
+          "type": "u64",
+          "description": "The total bytes that are stored under the *key*, including the all descendants data and the size of the keys themselves."
+        }
+      }
+    }
+  }
+}