Specificatoins of Command Line Utilities of Kyoto Cabinet
Copyright (C) 2009-2011 FAL Labs
Last Update: Sun, 02 Jan 2011 22:21:53 +0900
This document describes how to use command line utilities. They are useful to manage database contents and to test the library and its applications.
- kcutiltest : to test the utility functions.
- kcutilmgr : miscellaneous utilities.
- kcprototest : to test the prototype database.
- kcstashtest : to test the stash database.
- kccachetest : to test the cache hash database.
- kcgrasstest : to test the cache tree database.
- kchashtest : to test the file hash database.
- kchashmgr : to manage the file hash database.
- kctreetest : to test the file tree database.
- kctreemgr : to manage the file tree database.
- kcdirtest : to test the directory hash database.
- kcdirmgr : to manage the directory hash database.
- kcforesttest : to test the directory tree database.
- kcforestmgr : to manage the directory tree database.
- kcpolytest : to test the polymorphic database.
- kcpolymgr : to manage the polymorphic database.
- kclangctest : to test the C language binding.
kcutiltest
The command `kcutiltest' is a utility for facility test and performance test of the utility functions. This command is used in the following format. `rnum' specifies the number of iterations. `path' specifies the path of a file.
kcutiltest mutex [-th num] [-iv num] rnum- Performs test of lock primitives.
kcutiltest para [-th num] [-iv num] rnum- Performs test of parallel processing.
kcutiltest file [-th num] [-rnd] [-msiz num] path rnum- Performs test of the file system abstraction.
kcutiltest thmap [-rnd] [-bnum num] rnum- Performs test of memory-saving hash map.
kcutiltest lhmap [-rnd] [-bnum num] rnum- Performs test of doubly-linked hash map.
kcutiltest misc rnum- Performs test of miscellaneous mechanisms.
Options feature the following.
-th num : specifies the number of worker threads.-iv num : specifies the interval between iterations.-rnd : performs random test.-msiz num : specifies the size of the memory-mapped region.-bnum num : specifies the number of buckets of the hash table.
This command returns 0 on success, another on failure.
kcutilmgr
The command `kcutilmgr' is a tool of miscellaneous utilities, and to show the configuration. This command is used in the following format. `file' specifies a input file. If it is omitted, the standard input is read. If it begins with "@", the trailing substring is treated as the input. `pattern' specifies an matching pattern.
kcutilmgr hex [-d] [file]- Performs hexadecimal encoding and its decoding.
kcutilmgr enc [-hex|-url|-quote] [-d] [file]- Performs Base64 encoding and its decoding.
kcutilmgr ciph [-key str] [file]- Performs Arcfour cipher and its decipher.
kcutilmgr comp [-def|-gz|-lzo|-lzma] [-d] [file]- Performs ZLIB encoding and its decoding. By default, use the raw format.
kcutilmgr hash [-fnv|-path|-crc] [file]- Calculates the hash value. By default, use MurMur hashing.
kcutilmgr regex [-alt str] [-ic] pattern [file]- Prints lines matching a regular expression.
kcutilmgr conf [-v|-i|-l|-p]- Shows the configuration of Kyoto Cabinet.
kcutilmgr version- Shows the version information of Kyoto Cabinet.
Options feature the following.
-d : perform decoding (unescaping), not encoding (escaping).-hex : use hexadecimal encoding.-url : use URL encoding.-quote : use Quoted-printable encoding.-key str : set the cipher key.-def : use the deflate format.-gz : use the gzip format.-lzo : use LZO encoding.-lzma : use LZMA encoding.-fnv : use FNV hashing.-path : use the path hashing of the directory database.-crc : calculate the CRC32 checksum.-alt str : replaces matching substring with the alternative string.-ic : ignores difference between upper and lower cases.-v : show the version number of Kyoto Cabinet.-i : show options to include the headers of Tokyo Cabinet.-l : show options to link the library of Tokyo Cabinet.-p : show the directory path of the commands.
This command returns 0 on success, another on failure.
kcprototest
The command `kcprototest' is a utility for facility test and performance test of the prototype database. This command is used in the following format. `rnum' specifies the number of iterations.
kcprototest order [-tree] [-th num] [-rnd] [-etc] [-tran] rnum- Performs in-order tests.
kcprototest queue [-tree] [-th num] [-it num] [-rnd] rnum- Performs queuing operations.
kcprototest wicked [-tree] [-th num] [-it num] rnum- Performs mixed operations selected at random.
kcprototest tran [-tree] [-th num] [-it num] rnum- Performs test of transaction.
Options feature the following.
-tree : test the prototype tree database instead of the prototype hash database.-th num : specifies the number of worker threads.-rnd : performs random test.-etc : performs miscellaneous operations.-tran : performs transaction.-it num : specifies the number of repetition.
This command returns 0 on success, another on failure.
kcstashtest
The command `kcstashtest' is a utility for facility test and performance test of the stash database. This command is used in the following format. `rnum' specifies the number of iterations.
kccachetest order [-th num] [-rnd] [-etc] [-tran] [-bnum num] [-lv] rnum- Performs in-order tests.
kccachetest queue [-th num] [-it num] [-rnd] [-bnum num] [-lv] rnum- Performs queuing operations.
kccachetest wicked [-th num] [-it num] [-bnum num] [-lv] rnum- Performs mixed operations selected at random.
kccachetest tran [-th num] [-it num] [-bnum num] [-lv] rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-etc : performs miscellaneous operations.-tran : performs transaction.-bnum num : specifies the number of buckets of the hash table.-lv : reports all errors.-it num : specifies the number of repetition.
This command returns 0 on success, another on failure.
kccachetest
The command `kccachetest' is a utility for facility test and performance test of the cache hash database. This command is used in the following format. `rnum' specifies the number of iterations.
kccachetest order [-th num] [-rnd] [-etc] [-tran] [-tc] [-bnum num] [-capcnt num] [-capsiz num] [-lv] rnum- Performs in-order tests.
kccachetest queue [-th num] [-it num] [-rnd] [-tc] [-bnum num] [-capcnt num] [-capsiz num] [-lv] rnum- Performs queuing operations.
kccachetest wicked [-th num] [-it num] [-tc] [-bnum num] [-capcnt num] [-capsiz num] [-lv] rnum- Performs mixed operations selected at random.
kccachetest tran [-th num] [-it num] [-tc] [-bnum num] [-capcnt num] [-capsiz num] [-lv] rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-etc : performs miscellaneous operations.-tran : performs transaction.-tc : tunes the database with the compression option.-bnum num : specifies the number of buckets of the hash table.-capcnt num : specifies the maximum number of records.-capsiz num : specifies the maximum size of memory usage.-lv : reports all errors.-it num : specifies the number of repetition.
This command returns 0 on success, another on failure.
kcgrasstest
The command `kcgrasstest' is a utility for facility test and performance test of the cache tree database. This command is used in the following format. `rnum' specifies the number of iterations.
kcgrasstest order [-th num] [-rnd] [-etc] [-tran] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] rnum- Performs in-order tests.
kcgrasstest queue [-th num] [-it num] [-rnd] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] rnum- Performs queuing operations.
kcgrasstest wicked [-th num] [-it num] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] rnum- Performs mixed operations selected at random.
kcgrasstest tran [-th num] [-it num] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-etc : performs miscellaneous operations.-tran : performs transaction.-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.-pccap num : specifies the capacity size of the page cache.-rcd : use the decimal comparator instead of the lexical one.-lv : reports all errors.-it num : specifies the number of repetition.
This command returns 0 on success, another on failure.
kchashtest
The command `kchashtest' is a utility for facility test and performance test of the file hash database. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
kchashtest order [-th num] [-rnd] [-set|-get|-getw|-rem|-etc] [-tran] [-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-msiz num] [-dfunit num] [-lv] path rnum- Performs in-order tests.
kchashtest queue [-th num] [-it num] [-rnd] [-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-msiz num] [-dfunit num] [-lv] path rnum- Performs queuing operations.
kchashtest wicked [-th num] [-it num] [-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-msiz num] [-dfunit num] [-lv] path rnum- Performs mixed operations selected at random.
kchashtest tran [-th num] [-it num] [-hard] [-oat|-onl|-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-msiz num] [-dfunit num] [-lv] path rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-set : performs setting operation only.-get : performs getting operation only.-getw : performs getting with a buffer operation only.-rem : performs removing operation only.-etc : performs miscellaneous operations.-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.-msiz num : specifies the size of the memory-mapped region.-dfunit num : specifies the unit step number of auto defragmentation.-lv : reports all errors.-it num : specifies the number of repetition.-hard : performs physical synchronization.
This command returns 0 on success, another on failure.
kchashmgr
The command `kchashmgr' is a utility for test and debugging of the file hash database and its applications. `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.
kchashmgr create [-otr] [-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] path- Creates a database file.
kchashmgr inform [-onl|-otl|-onr] [-st] path- Prints status information.
kchashmgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx] path key value- Stores a record.
kchashmgr remove [-onl|-otl|-onr] [-sx] path key- Removes a record.
kchashmgr get [-onl|-otl|-onr] [-sx] [-px] [-pz] path key- Prints the value of a record.
kchashmgr list [-onl|-otl|-onr] [-max num] [-sx] [-pv] [-px] path [key]- Prints keys of all records, separated by line feeds.
kchashmgr clear [-onl|-otl|-onr] path- Removes all records of a database.
kchashmgr import [-onl|-otl|-onr] [-sx] path [file]- Imports records from a TSV file.
kchashmgr copy [-onl|-otl|-onr] path file- Copies the whole database.
kchashmgr dump [-onl|-otl|-onr] path [file]- Dumps records into a snapshot file.
kchashmgr load [-otr] [-onl|-otl|-onr] path [file]- Loads records from a snapshot file.
kchashmgr defrag [-onl|-otl|-onr] path- Performs defragmentation.
kchashmgr setbulk [-onl|-otl|-onr] path key value ...- Store records at once.
kchashmgr removebulk [-onl|-otl|-onr] [-sx] path key ...- Remove records at once.
kchashmgr getbulk [-onl|-otl|-onr] [-sx] [-px] path key ...- Retrieve records at once.
kchashmgr check [-onl|-otl|-onr] path- Checks consistency.
Options feature the following.
-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.-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.-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.
This command returns 0 on success, another on failure.
kctreetest
The command `kctreetest' is a utility for facility test and performance test of the file tree database. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
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] [-lv] path rnum- Performs in-order tests.
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] [-lv] path rnum- Performs queuing operations.
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] [-lv] path rnum- Performs mixed operations selected at random.
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] [-lv] path rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-set : performs setting operation only.-get : performs getting operation only.-getw : performs getting with a buffer operation only.-rem : performs removing operation only.-etc : performs miscellaneous operations.-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.-lv : reports all errors.-it num : specifies the number of repetition.-hard : performs physical synchronization.
This command returns 0 on success, another on failure.
kctreemgr
The command `kctreemgr' is a utility for test and debugging of the file tree database and its applications. `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.
kctreemgr create [-otr] [-onl|-otl|-onr] [-apow num] [-fpow num] [-ts] [-tl] [-tc] [-bnum num] [-psiz num] [-rcd] 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] [-sx] [-px] [-pz] path key- Prints the value of a record.
kctreemgr list [-onl|-otl|-onr] [-des] [-max num] [-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.
Options feature the following.
-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.-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.-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.-max num : specifies the maximum number of shown records.-pv : prints values of records also.
This command returns 0 on success, another on failure.
kcdirtest
The command `kcdirtest' is a utility for facility test and performance test of the directory hash database. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
kcdirtest order [-th num] [-rnd] [-set|-get|-getw|-rem|-etc] [-tran] [-oat|-onl|-onl|-otl|-onr] [-tc] [-lv] path rnum- Performs in-order tests.
kcdirtest queue [-th num] [-it num] [-rnd] [-oat|-onl|-onl|-otl|-onr] [-tc] [-lv] path rnum- Performs queuing operations.
kcdirtest wicked [-th num] [-it num] [-oat|-onl|-onl|-otl|-onr] [-tc] [-lv] path rnum- Performs mixed operations selected at random.
kcdirtest tran [-th num] [-it num] [-hard] [-oat|-onl|-onl|-otl|-onr] [-tc] [-lv] path rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-set : performs setting operation only.-get : performs getting operation only.-getw : performs getting with a buffer operation only.-rem : performs removing operation only.-etc : performs miscellaneous operations.-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.-tc : tunes the database with the compression option.-lv : reports all errors.-it num : specifies the number of repetition.-hard : performs physical synchronization.
This command returns 0 on success, another on failure.
kcdirmgr
The command `kcdirmgr' is a utility for test and debugging of the directory hash database and its applications. `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.
kcdirmgr create [-otr] [-onl|-otl|-onr] [-tc] path- Creates a database file.
kcdirmgr inform [-onl|-otl|-onr] [-st] path- Prints status information.
kcdirmgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx] path key value- Stores a record.
kcdirmgr remove [-onl|-otl|-onr] [-sx] path key- Removes a record.
kcdirmgr get [-onl|-otl|-onr] [-sx] [-px] [-pz] path key- Prints the value of a record.
kcdirmgr list [-onl|-otl|-onr] [-max num] [-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.
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.
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.
kcdirmgr setbulk [-onl|-otl|-onr] path key value ...- Store records at once.
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.
Options feature the following.
-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.-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.
This command returns 0 on success, another on failure.
kcforesttest
The command `kcforesttest' is a utility for facility test and performance test of the directory tree database. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
kcforesttest order [-th num] [-rnd] [-set|-get|-getw|-rem|-etc] [-tran] [-oat|-onl|-onl|-otl|-onr] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] path rnum- Performs in-order tests.
kcforesttest queue [-th num] [-it num] [-rnd] [-oat|-onl|-onl|-otl|-onr] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] path rnum- Performs queuing operations.
kcforesttest wicked [-th num] [-it num] [-oat|-onl|-onl|-otl|-onr] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] path rnum- Performs mixed operations selected at random.
kcforesttest tran [-th num] [-it num] [-hard] [-oat|-onl|-onl|-otl|-onr] [-tc] [-bnum num] [-psiz num] [-pccap num] [-rcd] [-lv] path rnum- Performs test of transaction.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-set : performs setting operation only.-get : performs getting operation only.-getw : performs getting with a buffer operation only.-rem : performs removing operation only.-etc : performs miscellaneous operations.-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.-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.-pccap num : specifies the capacity size of the page cache.-rcd : use the decimal comparator instead of the lexical one.-lv : reports all errors.-it num : specifies the number of repetition.-hard : performs physical synchronization.
This command returns 0 on success, another on failure.
kcforestmgr
The command `kcforestmgr' is a utility for test and debugging of the file tree database and its applications. `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.
kcforestmgr create [-otr] [-onl|-otl|-onr] [-tc] [-bnum num] [-psiz num] [-rcd] path- Creates a database file.
kcforestmgr inform [-onl|-otl|-onr] [-st] path- Prints status information.
kcforestmgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx] path key value- Stores a record.
kcforestmgr remove [-onl|-otl|-onr] [-sx] path key- Removes a record.
kcforestmgr get [-onl|-otl|-onr] [-sx] [-px] [-pz] path key- Prints the value of a record.
kcforestmgr list [-onl|-otl|-onr] [-des] [-max num] [-sx] [-pv] [-px] path [key]- Prints keys of all records, separated by line feeds.
kcforestmgr clear [-onl|-otl|-onr] path- Removes all records of a database.
kcforestmgr import [-onl|-otl|-onr] [-sx] path [file]- Imports records from a TSV file.
kcforestmgr copy [-onl|-otl|-onr] path file- Copies the whole database.
kcforestmgr dump [-onl|-otl|-onr] path [file]- Dumps records into a snapshot file.
kcforestmgr load [-otr] [-onl|-otl|-onr] path [file]- Loads records from a snapshot file.
kcforestmgr setbulk [-onl|-otl|-onr] path key value ...- Store records at once.
kcforestmgr removebulk [-onl|-otl|-onr] [-sx] path key ...- Remove records at once.
kcforestmgr getbulk [-onl|-otl|-onr] [-sx] [-px] path key ...- Retrieve records at once.
kcforestmgr check [-onl|-otl|-onr] path- Checks consistency.
Options feature the following.
-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.-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.-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.-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.-max num : specifies the maximum number of shown records.-pv : prints values of records also.
This command returns 0 on success, another on failure.
kcpolytest
The command `kcpolytest' is a utility for facility test and performance test of the polymorphic database. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
kcpolytest order [-th num] [-rnd] [-set|-get|-getw|-rem|-etc] [-tran] [-oat|-onl|-onl|-otl|-onr] [-lv] path rnum- Performs in-order tests.
kcpolytest queue [-th num] [-it num] [-rnd] [-oat|-onl|-onl|-otl|-onr] [-lv] path rnum- Performs queuing operations.
kcpolytest wicked [-th num] [-it num] [-oat|-onl|-onl|-otl|-onr] [-lv] path rnum- Performs mixed operations selected at random.
kcpolytest tran [-th num] [-it num] [-hard] [-oat|-onl|-onl|-otl|-onr] [-lv] path rnum- Performs test of transaction.
kcpolytest mapred [-rnd] [-oat|-onl|-onl|-otl|-onr] [-lv] [-tmp str] [-dbnum num] [-clim num] [-cbnum num] [-xnl] [-xnc] path rnum- Performs MapReduce operations.
kcpolytest misc path- Performs miscellaneous tests.
Options feature the following.
-th num : specifies the number of worker threads.-rnd : performs random test.-set : performs setting operation only.-get : performs getting operation only.-getw : performs getting with a buffer operation only.-rem : performs removing operation only.-etc : performs miscellaneous operations.-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.-lv : reports all errors.-it num : specifies the number of repetition.-hard : performs physical synchronization.-tmp str : specifies the path of a directory for temporary storage.-dbnum num : specifies the number of temporary databases.-clim num : specifies the limit size of cache memory.-cbnum num : specifies the bucket number of cache memory.-xnl : executes with the no locking option.-xnc : executes with the no compression option.
This command returns 0 on success, another on failure.
kcpolymgr
The command `kcpolymgr' is a utility for test and debugging of the polymorphic database and its applications. `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. `src' specifies other database files.
kcpolymgr create [-otr] [-onl|-otl|-onr] path- Creates a database file.
kcpolymgr inform [-onl|-otl|-onr] [-st] path- Prints status information.
kcpolymgr set [-onl|-otl|-onr] [-add|-app|-rep|-inci|-incd] [-sx] path key value- Stores a record.
kcpolymgr remove [-onl|-otl|-onr] [-sx] path key- Removes a record.
kcpolymgr get [-onl|-otl|-onr] [-sx] [-px] [-pz] path key- Prints the value of a record.
kcpolymgr list [-onl|-otl|-onr] [-des] [-max num] [-sx] [-pv] [-px] path [key]- Prints keys of all records, separated by line feeds.
kcpolymgr clear [-onl|-otl|-onr] path- Removes all records of a database.
kcpolymgr import [-onl|-otl|-onr] [-sx] path [file]- Imports records from a TSV file.
kcpolymgr copy [-onl|-otl|-onr] path file- Copies the whole database.
kcpolymgr dump [-onl|-otl|-onr] path [file]- Dumps records into a snapshot file.
kcpolymgr load [-otr] [-onl|-otl|-onr] path [file]- Loads records from a snapshot file.
kcpolymgr merge [-onl|-otl|-onr] [-add|-app|-rep] path src...- Merge records from other databases.
kcpolymgr setbulk [-onl|-otl|-onr] path key value ...- Store records at once.
kcpolymgr removebulk [-onl|-otl|-onr] [-sx] path key ...- Remove records at once.
kcpolymgr getbulk [-onl|-otl|-onr] [-sx] [-px] path key ...- Retrieve records at once.
kcpolymgr check [-onl|-otl|-onr] path- Checks consistency.
Options feature the following.
-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.-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.-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.-max num : specifies the maximum number of shown records.-pv : prints values of records also.
This command returns 0 on success, another on failure.
kclangctest
The command `kclangctest' is a utility for facility test and performance test of the C language binding. This command is used in the following format. `path' specifies the path of a database file. `rnum' specifies the number of iterations.
kcpolytest order [-rnd] [-etc] [-tran] [-oat|-onl|-onl|-otl|-onr] path rnum- Performs in-order tests.
Options feature the following.
-rnd : performs random test.-etc : performs miscellaneous operations.-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.
This command returns 0 on success, another on failure.