NAME

lightning-sql -- Command to do complex queries on list commands

SYNOPSIS

sql query

DESCRIPTION

Command added in v23.02.

The sql RPC command runs the given query across a sqlite3 database created from various list commands.

When tables are accessed, it calls the below commands, so it's no faster than any other local access (though it goes to great length to cache listnodes and listchannels) which then processes the results.

It is, however faster for remote access if the result of the query is much smaller than the list commands would be.

Note that you may need to use -o if you use queries which contain = (which make $ lightning-cli(1) default to keyword style)

•

query (string): The standard sqlite3 query to run. Note that queries like "SELECT *" are fragile, as columns will change across releases; see lightning-listsqlschemas(7).

PERMITTED SQLITE3 FUNCTIONS

Writing to the database is not permitted, and limits are placed on various other query parameters.

Additionally, only the following functions are allowed:

• abs

• avg

• coalesce

• count

• date

• datetime

• julianday

• hex

• quote

• length

• like

• lower

• upper

• min

• max

• strftime

• sum

• time

• timediff

• total

• unixepoch

TREATMENT OF TYPES

The following types are supported in schemas, and this shows how they are presented in the database. This matters: a JSON boolean is represented as an integer in the database, so a query will return 0 or 1, not true or false.

•

hex. A hex string.

• hash/secret/pubkey/txid: just like hex.
• msat/integer/u64/u32/u16/u8. Normal numbers.

•

boolean. True or false.

•

number. A floating point number (used for times in some places).

•

string. Text.

•

short_channel_id. A short-channel-id of form 1x2x3.

TABLES

Note that the first column of every table is a unique integer called rowid: this is used for related tables to refer to specific rows in their parent. sqlite3 usually has this as an implicit column, but we make it explicit as the implicit version is not allowed to be used as a foreign key.

The following tables are currently supported: - bkpr_accountevents (see lightning-bkpr-listaccountevents(7)) - account (type string, sqltype TEXT) - type (type string, sqltype TEXT) - tag (type string, sqltype TEXT) - credit_msat (type msat, sqltype INTEGER) - debit_msat (type msat, sqltype INTEGER) - currency (type string, sqltype TEXT) - timestamp (type u32, sqltype INTEGER) - description (type string, sqltype TEXT) - outpoint (type string, sqltype TEXT) - blockheight (type u32, sqltype INTEGER) - origin (type string, sqltype TEXT) - payment_id (type hex, sqltype BLOB) - txid (type txid, sqltype BLOB) - fees_msat (type msat, sqltype INTEGER) - is_rebalance (type boolean, sqltype INTEGER) - part_id (type u32, sqltype INTEGER)

•

bkpr_income (see lightning-bkpr-listincome(7))

•

channels indexed by short_channel_id (see lightning-listchannels(7))

•

closedchannels (see lightning-listclosedchannels(7))

•

forwards indexed by in_channel and in_htlc_id (see lightning-listforwards(7))

•

htlcs indexed by short_channel_id and id (see lightning-listhtlcs(7))

•

invoices indexed by payment_hash (see lightning-listinvoices(7))

•

nodes indexed by nodeid (see lightning-listnodes(7))

•

offers indexed by offer_id (see lightning-listoffers(7))

•

peerchannels indexed by peer_id (see lightning-listpeerchannels(7))

•

peers indexed by id (see lightning-listpeers(7))

•

sendpays indexed by payment_hash (see lightning-listsendpays(7))

•

transactions indexed by hash (see lightning-listtransactions(7))

RETURN VALUE

On success, an object containing rows is returned. It is an array. Each array entry contains an array of values, each an integer, real number, string or null, depending on the sqlite3 type.

The object may contain warning_db_failure if the database fails partway through its operation. On success, an object is returned, containing:

•

rows (array of arrays):

The following warnings may also be returned:

•

warning_db_failure: A message if the database encounters an error partway through.

ERRORS

On failure, an error is returned.

AUTHOR

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

SEE ALSO

lightning-listtransactions(7), lightning-listchannels(7), lightning-listpeers(7), lightning-listnodes(7), lightning-listforwards(7)

RESOURCES

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

EXAMPLES

Example 1: A simple peers selection query:

Request:

$ lightning-cli sql -k "query"="SELECT id FROM peers"

{


  "id": "example:sql#1",


  "method": "sql",


  "params": {


    "query": "SELECT id FROM peers"


  }
}

Response:

{


  "rows": [


    [


      "nodeid020202020202020202020202020202020202020202020202020202020202"


    ]


  ]
}

Example 2: A statement containing = needs -o in shell:

Request:

$ lightning-cli sql -o "SELECT label, description, status FROM invoices WHERE label='label inv_l12'"

{


  "id": "example:sql#2",


  "method": "sql",


  "params": [


    "SELECT label, description, status FROM invoices WHERE label='label inv_l12'"


  ]
}

Response:

{


  "rows": [


    [


      "label inv_l12",


      "description inv_l12",


      "unpaid"


    ]


  ]
}

Example 3: If you want to get specific nodeid values from the nodes table:

Request:

$ lightning-cli sql -o "SELECT nodeid FROM nodes WHERE nodeid != x'nodeid030303030303030303030303030303030303030303030303030303030303'"

{


  "id": "example:sql#3",


  "method": "sql",


  "params": [


    "SELECT nodeid FROM nodes WHERE nodeid != x'nodeid030303030303030303030303030303030303030303030303030303030303'"


  ]
}

Response:

{


  "rows": [


    [


      "nodeid020202020202020202020202020202020202020202020202020202020202"


    ],


    [


      "nodeid010101010101010101010101010101010101010101010101010101010101"


    ],


    [


      "nodeid040404040404040404040404040404040404040404040404040404040404"


    ]


  ]
}

Example 4: If you want to compare a BLOB column, x'hex' or X'hex' are needed:

Request:

$ lightning-cli sql "SELECT nodeid FROM nodes WHERE nodeid IN (x'nodeid010101010101010101010101010101010101010101010101010101010101', x'nodeid030303030303030303030303030303030303030303030303030303030303')"

{


  "id": "example:sql#4",


  "method": "sql",


  "params": [


    "SELECT nodeid FROM nodes WHERE nodeid IN (x'nodeid010101010101010101010101010101010101010101010101010101010101', x'nodeid030303030303030303030303030303030303030303030303030303030303')"


  ]
}

Response:

{


  "rows": [


    [


      "nodeid010101010101010101010101010101010101010101010101010101010101"


    ],


    [


      "nodeid030303030303030303030303030303030303030303030303030303030303"


    ]


  ]
}

Example 5: Related tables are usually referenced by JOIN:

Request:

$ lightning-cli sql -o 'SELECT peer_id, to_us_msat, total_msat, peerchannels_status.status FROM peerchannels INNER JOIN peerchannels_status ON peerchannels_status.row = peerchannels.rowid'

{


  "id": "example:sql#5",


  "method": "sql",


  "params": [


    "SELECT peer_id, to_us_msat, total_msat, peerchannels_status.status FROM peerchannels INNER JOIN peerchannels_status ON peerchannels_status.row = peerchannels.rowid"


  ]
}

Response:

{


  "rows": [


    [


      "nodeid020202020202020202020202020202020202020202020202020202020202",


      490493792,


      1000000000,


      "CHANNELD_NORMAL:Channel ready for use."


    ]


  ]
}

Example 6: Simple function usage, in this case COUNT. Strings inside arrays need ", and ' to protect them from the shell:

Request:

$ lightning-cli sql "SELECT COUNT(*) FROM forwards"

{


  "id": "example:sql#6",


  "method": "sql",


  "params": [


    "SELECT COUNT(*) FROM forwards"


  ]
}

Response:

{


  "rows": [


    [


      9


    ]


  ]
}

Example 7:

Request:

$ lightning-cli sql "SELECT * from peerchannels_features"

{


  "id": "example:sql#7",


  "method": "sql",


  "params": [


    "SELECT * from peerchannels_features"


  ]
}

Response:

{


  "rows": [


    [


      28,


      23,


      0,


      "option_static_remotekey"


    ],


    [


      29,


      23,


      1,


      "option_anchors_zero_fee_htlc_tx"


    ],


    [


      30,


      23,


      2,


      "option_anchors"


    ]


  ]
}