KCTREEMGR(1)

💖 KCTREEMGR — the Kyoto Cabinet file tree database manager, bestie edition 💖

okay so real quick, this is kctreemgr from the Kyoto Cabinet manual, section 1 (general commands, we love a general command 👑). She's a command line interface to manage the file tree database, and she is so underrated.

🌸 NAME 🌸

kctreemgr — the command line interface that lets you manage the file tree database. no cap. 🦋

✨ DESCRIPTION ✨

so like. kctreemgr is a utility for test and debugging of the file tree database and its applications. she's the girl you call when you need to poke at things. 💅

before we go anywhere, let's define our little vocabulary, bestie:

• path — specifies the path of a database file.
• key — specifies the key of a record.
• value — specifies the value of a record.
• file — specifies the input/output file.

got it? got it. 🫶 now here's the whole menu of subcommands, verbatim, no edits, because we respect her:

kctreemgr create [-otr] [-onl|-otl|-onr] [-apow num] [-fpow num]
[-ts] [-tl] [-tc] [-bnum num] [-psiz num] [-rcd|-rcld|-rcdd] path
       Creates a database file.
kctreemgr inform [-onl|-otl|-onr] [-st] path
       Prints status information.
kctreemgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx]
path key value
       Stores a record.
kctreemgr remove [-onl|-otl|-onr] [-sx] path key
       Removes a record.
kctreemgr get [-onl|-otl|-onr] [-rm] [-sx] [-px] [-pz] path key
       Prints the value of a record.
kctreemgr list [-onl|-otl|-onr] [-des] [-max num] [-rm] [-sx]
[-pv] [-px] path [key]
       Prints keys of all records, separated by line feeds.
kctreemgr clear [-onl|-otl|-onr] path
       Removes all records of a database.
kctreemgr import [-onl|-otl|-onr] [-sx] path [file]
       Imports records from a TSV file.
kctreemgr copy [-onl|-otl|-onr] path file
       Copies the whole database.
kctreemgr dump [-onl|-otl|-onr] path [file]
       Dumps records into a snapshot file.
kctreemgr load [-otr] [-onl|-otl|-onr] path [file]
       Loads records from a snapshot file.
kctreemgr defrag [-onl|-otl|-onr] path
       Performs defragmentation.
kctreemgr setbulk [-onl|-otl|-onr] path key value ...
       Store records at once.
kctreemgr removebulk [-onl|-otl|-onr] [-sx] path key ...
       Remove records at once.
kctreemgr getbulk [-onl|-otl|-onr] [-sx] [-px] path key ...
       Retrieve records at once.
kctreemgr check [-onl|-otl|-onr] path
       Checks consistency.

okay let's translate the tea ☕ for each one, because that wall of text is giving syllabus energy:

• create — creates a database file. birth. 🎀
• inform — prints status information. she's telling you how she's doing, emotionally and also technically.
• set — stores a record. put the thing in the thing.
• remove — removes a record. bye girl 💀
• get — prints the value of a record. the payoff, the reveal, the main character moment.
• list — prints keys of all records, separated by line feeds. a whole scroll of keys, it's giving receipts.
• clear — removes all records of a database. scorched earth, but make it cute 🌈
• import — imports records from a TSV file.
• copy — copies the whole database.
• dump — dumps records into a snapshot file.
• load — loads records from a snapshot file.
• defrag — performs defragmentation. self care for your database ✨
• setbulk — store records at once. efficiency icon.
• removebulk — remove records at once. mass exit.
• getbulk — retrieve records at once.
• check — checks consistency. the vibe check, literally.

💅 OPTIONS 💅

these are the flags, and yes they work across the subcommands like a shared group chat. here's every single one, no skips, no skimming:

• -otr — opens the database with the truncation option.
• -onl — opens the database with the no locking option.
• -otl — opens the database with the try locking option.
• -onr — opens the database with the no auto repair option.
• -apow num — specifies the power of the alignment of record size.
• -fpow num — specifies the power of the capacity of the free block pool.
• -ts — tunes the database with the small option.
• -tl — tunes the database with the linear option.
• -tc — tunes the database with the compression option.
• -bnum num — specifies the number of buckets of the hash table.
• -psiz num — specifies the size of each page.
• -rcd — use the decimal comparator instead of the lexical one.
• -rcld — use the lexical descending comparator instead of the ascending one.
• -rcdd — use the decimal descending comparator instead of the lexical one.
• -st — prints miscellaneous information. the extras, the lore 🍓
• -add — performs adding operation.
• -app — performs appending operation.
• -rep — performs replacing operation.
• -inci — performs integer increment operation. math but make it cunty 🔥
• -incd — performs real number increment operation.
• -sx — the input data is evaluated as a hexadecimal data string.
• -rm — removes the record.
• -px — the output data is converted into a hexadecimal data string.
• -pz — does not append line feed at the end of the output.
• -des — visits records in descending order. backwards, but on purpose.
• -max num — specifies the maximum number of shown records.
• -pv — prints values of records also.

🫶 EXIT STATUS 🫶

this command returns 0 on success, another on failure. that's it. that's the whole energy.

👑 SEE ALSO 👑

kctreetest(1)

man page · 2012-05-24 · Kyoto Cabinet · kctreemgr(1)

so yeah, that's the whole page bestie 💖 written by the Kyoto Cabinet girlies, dated 2012-05-24, filed under KCTREEMGR(1) in section 1. she ate and left no crumbs. periodt. ✨🎀🦋