KCDIRMGR(1)

💖 KCDIRMGR(1) — Kyoto Cabinet's directory hash database wrangler 💖

okay bestie, welcome to kcdirmgr from the Kyoto Cabinet manual (section 1, the user commands, obviously 💅). this is your command-line bestie for managing the directory hash database. let's get into it 🫶

🌸 NAME 🌸

kcdirmgr — literally the command line interface to manage the directory hash database. that's it, that's the vibe. no cap.

✨ DESCRIPTION ✨

so here's the tea ☕: the command kcdirmgr is a utility for test and debugging of the directory hash database and its applications. it's giving developer-tools energy, fr fr.

before we go any further, let's meet the squad of arguments you'll be passing around:

• path — specifies the path of a database file. this is the main character of every single subcommand.
• key — specifies the key of a record.
• value — specifies the value of a record.
• file — specifies the input/output file.

got it? iconic. now the subcommands 👑

🎀 the subcommands (aka the whole menu) 🎀

• kcdirmgr create [-otr] [-onl|-otl|-onr] [-tc] path — creates a database file. brand new db, fresh out the box ✨
• kcdirmgr inform [-onl|-otl|-onr] [-st] path — prints status information. the gossip report on your database 💅
• kcdirmgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx] path key value — stores a record. put it in, bestie.
• kcdirmgr remove [-onl|-otl|-onr] [-sx] path key — removes a record. bye girl 👋
• kcdirmgr get [-onl|-otl|-onr] [-rm] [-sx] [-px] [-pz] path key — prints the value of a record. fetch, but make it unix.
• kcdirmgr list [-onl|-otl|-onr] [-max num] [-rm] [-sx] [-pv] [-px] path [key] — prints keys of all records, separated by line feeds.
• kcdirmgr clear [-onl|-otl|-onr] path — removes all records of a database. scorched earth, but consensual 💀
• kcdirmgr import [-onl|-otl|-onr] [-sx] path [file] — imports records from a TSV file.
• kcdirmgr copy [-onl|-otl|-onr] path file — copies the whole database. clone her 💖
• kcdirmgr dump [-onl|-otl|-onr] path [file] — dumps records into a snapshot file.
• kcdirmgr load [-otr] [-onl|-otl|-onr] path [file] — loads records from a snapshot file.
• kcdirmgr defrag [-onl|-otl|-onr] path — performs defragmentation. glow-up for your storage 🧖
• kcdirmgr setbulk [-onl|-otl|-onr] path key value ... — store records at once. speedrun edition 🔥
• kcdirmgr removebulk [-onl|-otl|-onr] [-sx] path key ... — remove records at once.
• kcdirmgr getbulk [-onl|-otl|-onr] [-sx] [-px] path key ... — retrieve records at once.
• kcdirmgr check [-onl|-otl|-onr] path — checks consistency. vibe check, but for your data 🌈

💅 OPTIONS 💅

here's where it gets juicy. options feature the following, and you're gonna want to screenshot this:

• -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.
• -tc — tunes the database with the compression option.
• -st — prints miscellaneous information.
• -add — performs adding operation.
• -app — performs appending operation.
• -rep — performs replacing operation.
• -inci — performs integer increment operation.
• -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.
• -max num — specifies the maximum number of shown records.
• -pv — prints values of records also.

⚠️ heads up bestie: -onl, -otl and -onr are mutually exclusive-ish in the synopses — you pick one from that little group, not all three at once. read the synopsis, trust the synopsis 🙈

🌟 exit status 🌟

This command returns 0 on success, another on failure. so if you get a 0, she ate. anything else? not her day 😭

🦋 SEE ALSO 🦋

• kcdirtest(1) — go say hi to her cousin 💜

and that's the whole page, bestie! this one's from the Kyoto Cabinet manual, dated 2012-05-24, and the footer said Man Page with KCDIRMGR(1) as the title — so if you ever need to cite her, that's the receipt. now go forth and manage that directory hash database like the main character you are. periodt. 💅✨👑