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

lightning-deldatastore -- Command for removing (plugin) data
============================================================

SYNOPSIS
--------

**deldatastore** *key* \[*generation*\]

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

The **deldatastore** RPC command allows plugins to delete data it has
stored in the c-lightning database.

The command fails if the *key* isn't present, or if *generation*
is specified and the generation of the data does not exactly match.

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

[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **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 which has removed 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:
- 1200: the key does not exist
- 1201: the key does exist, but the generation is wrong
- -32602: invalid parameters

AUTHOR
------

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

SEE ALSO
--------

lightning-listdatastore(7), lightning-datastore(7)

RESOURCES
---------

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

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

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

Remove some formatting inconsistencies I've tried automatically parsing the docs, and these inconsistencies made it harder to do that. (I tried to do that for a project which I can't share yet, I'm not sure if it'll even work). 2022-01-23 18:23:26 +01:00			`deldatastore key \[generation\]`
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 deldatastore RPC command allows plugins to delete data it has`
			`stored in the c-lightning database.`

datastore: add generation, simple atomicity. We add a generation counter, and allow update or del conditional on a given generation. Formalizes error codes, too, since we have more now. Suggested-by: @shesek Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:51:04 +02:00			`The command fails if the key isn't present, or if generation`
			`is specified and the generation of the data does not exactly match.`
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 is returned, containing:`
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 which has removed 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:`
datastore: add generation, simple atomicity. We add a generation counter, and allow update or del conditional on a given generation. Formalizes error codes, too, since we have more now. Suggested-by: @shesek Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:51:04 +02:00			`- 1200: the key does not exist`
			`- 1201: the key does exist, but the generation is wrong`
			`- -32602: invalid parameters`
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-08-25 04:50:12 +02:00
			`AUTHOR`
			`------`

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

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

			`lightning-listdatastore(7), lightning-datastore(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:ac7468cf6eadc8ab85216b4d5ecb55a32f3d0bc84180f477151c3748901824de)`