From b72d969ab84998ad3a8f91e37f83eaaf8e4fd8b5 Mon Sep 17 00:00:00 2001 From: dormando Date: Mon, 27 Feb 2023 21:38:46 -0800 Subject: crawler: mgdump documentation --- doc/protocol.txt | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/protocol.txt b/doc/protocol.txt index 9714bd9..a92089a 100644 --- a/doc/protocol.txt +++ b/doc/protocol.txt @@ -1130,6 +1130,31 @@ The response line could be one of: - "BADCLASS [message]" to indicate an invalid class was specified. +lru_crawler mgdump + +- Similar in function to the above "lru_crawler crawl" command, this function + outputs one line for every valid item found in the matching slab classes. + + If "hash" is specified instead of a classid or "all", the crawler will dump + items by directly walking the hash table instead of the LRU's. This makes it + more likely all items will be visited once as LRU reordering and locking can + cause frequently accessed items to be missed. + + Lines are in a basic metaget format, like: "mg key\r\n". If a key is in + binary format: "mg base64encodedkey b\r\n" + A user may then take each line, append any flags they want, and run those + commands against the server to fetch exactly what they want to know. + +The response line could be one of: + +- "OK" to indicate successful launch. + +- "BUSY [message]" to indicate the crawler is already processing a request. + +- "BADCLASS [message]" to indicate an invalid class was specified. + + + Watchers -------- -- cgit v1.2.1