KCTREETEST(1)

💖 KCTREETEST 💖 (the manual, but make it make sense)

okay so hi bestie 🫶 this is the manual page for kctreetest, living in section 1 (yes, the command-line section, the one you actually type) of the Kyoto Cabinet docs. it's a whole mood, it's a whole utility, and by the end of this you're gonna understand every single flag. no cap. let's get into it. 💅

✨ NAME ✨

kctreetest — the command line interface to test the file tree database.

that's it. that's the name. short, sweet, iconic. 👑

🌸 DESCRIPTION 🌸

so <hotpink>kctreetest</hotpink> is a utility for facility test and performance test of the file tree database. it's giving "I benchmark things for a living." 🧚

this command gets used in the following formats. quick vocab check first:

• path — specifies the path of a database file. that's where your db lives, bestie. 🏠
• rnum — specifies the number of iterations. how many times we're doing the thing.

🦋 the formats 🦋

order — in-order tests

kctreetest order [-th num] [-rnd] [-set|-get|-getw|-rem|-etc]
[-tran] [-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts]
[-tl] [-tc] [-bnum num] [-psiz num] [-msiz num] [-dfunit num]
[-pccap num] [-rcd|-rcld|-rcdd] [-lv] path rnum

performs in-order tests. very demure, very mindful, everything in the order it's supposed to be in. ✨

queue — queuing operations

kctreetest queue [-th num] [-it num] [-rnd]
[-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl]
[-tc] [-bnum num] [-psiz num] [-msiz num] [-dfunit num] [-pccap
num] [-rcd|-rcld|-rcdd] [-lv] path rnum

performs queuing operations. line up, babes, we're doing this in order. 🎀

wicked — mixed operations, selected at random

kctreetest wicked [-th num] [-it num] [-oat|-onl|-onl|-otl|-onr]
[-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-psiz num]
[-msiz num] [-dfunit num] [-pccap num] [-rcd|-rcld|-rcdd] [-lv]
path rnum

performs mixed operations selected at random. it's called wicked for a reason 😭 chaos mode, main character energy, anything could happen.

tran — transaction test

kctreetest tran [-th num] [-it num] [-hard]
[-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl]
[-tc] [-bnum num] [-psiz num] [-msiz num] [-dfunit num] [-pccap
num] [-rcd|-rcld|-rcdd] [-lv] path rnum

performs test of transaction. atomicity girlies, rise. 🔥

🎯 the options, in their own words

options feature the following. every single one, we're not skipping anybody:

• -th num — specifies the number of worker threads. more threads = more friends helping out. 🫶
• -rnd — performs random test. spin the wheel bestie.
• -set — performs setting operation only. just setting. nothing else. focus. 💅
• -get — performs getting operation only. just getting.
• -getw — performs getting with a buffer operation only.
• -rem — performs removing operation only. bye bye data 👋
• -etc — performs miscellaneous operations. the grab bag. the random drawer in the kitchen.
• -tran — performs transaction.
• -oat — opens the database with the auto transaction option.
• -oas — opens the database with the auto synchronization 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.
• -msiz num — specifies the size of the memory-mapped region.
• -dfunit num — specifies the unit step number of auto defragmentation.
• -pccap num — specifies the capacity size of the page cache.
• -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.
• -lv — reports all errors. loud and proud, we want ALL the tea. 🍵
• -it num — specifies the number of repetition.
• -hard — performs physical synchronization.

heads up bestie: the synopsis lines are copy-pasted exactly as the docs have them, so yes, -onl really does show up twice in that -oat|-onl|-onl|-otl|-onr cluster. that's not me being clumsy, that's the original. and -oas is in the options list even though it's not in the synopsis. iykyk. 🙈

🚦 exit status

this command returns 0 on success, another on failure. zero = we ate. anything else = we did not. 😭

👀 SEE ALSO 👀

• kctreemgr(1)

go read that one next, bestie, it's the manager and it's lowkey iconic too.

and that's the whole page!! slay, periodt, no notes 💖 this was the KCTREETEST(1) page, it comes from the Kyoto Cabinet manual, dated 2012-05-24, and it was formatted as a man page. mwah. 🎀✨