core-lightning/doc/lightning-listdatastore.7.md

lightning-listdatastore -- Command for listing (plugin) data
============================================================

SYNOPSIS
--------

**listdatastore** [*key*]

DESCRIPTION
-----------

The **listdatastore** RPC command allows plugins to fetch data which was
stored in the Core Lightning database.

All immediate children of the *key* (or root children) are returned:
a *key* with children won't have a *hex* or *generation* entry.

RETURN VALUE
------------

[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **datastore** is returned.  It is an array of objects, where each object contains:
- **key** (array of strings):
  - Part of the key added to the datastore
- **generation** (u64, optional): The number of times this has been updated
- **hex** (hex, optional): The hex data from the datastore
- **string** (string, optional): The data as a string, if it's valid utf-8

[comment]: # (GENERATE-FROM-SCHEMA-END)

The following error codes may occur:
- -32602: invalid parameters.

AUTHOR
------

Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.

SEE ALSO
--------

lightning-datastore(7), lightning-deldatastore(7)

RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

[comment]: # ( SHA256STAMP:1e5d31c36f5aa2d2cb6bedb07a94b18880ba95529885c104b177d91bf251d420)
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00			`lightning-listdatastore -- Command for listing (plugin) data`
			`============================================================`

			`SYNOPSIS`
			`--------`

Remove useless \ 2022-01-26 18:18:49 +01:00			`listdatastore [key]`
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00
			`DESCRIPTION`
			`-----------`

			`The listdatastore RPC command allows plugins to fetch data which was`
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-04-06 07:09:48 +02:00			`stored in the Core Lightning database.`
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00
datastore: turn keys into arrays After some discussion with @shesek, and my own usage, we agreed that a more comprehensive interface, which explicitly supports grouping, is desirable. Thus keys are now arrays, with the semantic that a key is either a parent or has a value, never both. For convenience in the JSON schema, we always return them as arrays, though we accept simple strings as arguments. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:51:34 +02:00			`All immediate children of the key (or root children) are returned:`
			`a key with children won't have a hex or generation entry.`
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00
			`RETURN VALUE`
			`------------`

			`[comment]: # (GENERATE-FROM-SCHEMA-START)`
			`On success, an object containing datastore is returned. It is an array of objects, where each object contains:`
datastore: turn keys into arrays After some discussion with @shesek, and my own usage, we agreed that a more comprehensive interface, which explicitly supports grouping, is desirable. Thus keys are now arrays, with the semantic that a key is either a parent or has a value, never both. For convenience in the JSON schema, we always return them as arrays, though we accept simple strings as arguments. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:51:34 +02:00			`- key (array of strings):`
			`- Part of the key added to the datastore`
			`- generation (u64, optional): The number of times this has been updated`
			`- hex (hex, optional): The hex data from the datastore`
datastore: allow strings. It's common, and the simplest case. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:13 +02:00			`- string (string, optional): The data as a string, if it's valid utf-8`
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-09-03 12:07:59 +02:00
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00			`[comment]: # (GENERATE-FROM-SCHEMA-END)`

			`The following error codes may occur:`
			`- -32602: invalid parameters.`

			`AUTHOR`
			`------`

			`Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.`

			`SEE ALSO`
			`--------`

			`lightning-datastore(7), lightning-deldatastore(7)`

			`RESOURCES`
			`---------`

			`Main web site: <https://github.com/ElementsProject/lightning>`

jsonschema: Formatting json schema and regenerate docs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 2021-11-04 15:15:51 +01:00			`[comment]: # ( SHA256STAMP:1e5d31c36f5aa2d2cb6bedb07a94b18880ba95529885c104b177d91bf251d420)`