core-lightning/doc/lightning-batching.7.md
Rusty Russell b2148d0eab docs: handle "added": "version" and "deprecated": "version" from schemas.
This means we will document deprecations and additions, rather than just
pretending they've always been that way!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-11 12:51:18 +10:30

1.3 KiB

lightning-batching -- Command to allow database batching.

SYNOPSIS

batching enable

DESCRIPTION

The batching RPC command allows (but does not guarantee!) database commitments to be deferred when multiple commands are issued on this RPC connection. This is only useful if many commands are being given at once, in which case it can offer a performance improvement (the cost being that if there is a crash, it's unclear how many of the commands will have been persisted).

enable is true to enable batching, false to disable it (the default).

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "batching",
  "params": {
    "enable": true
  }
}

RETURN VALUE

On success, an empty object is returned.

On failure, one of the following error codes may be returned:

  • -32602: Error in given parameters.

AUTHOR

Rusty Russell <rusty@blockstream.com> wrote the initial version of this man page.

RESOURCES

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