TKRZW_DBM_UTIL(1)

📦
version 1.0.32 · 3 versions
, in epel 10, fedora 43

👑 NAME 👑

okay so bestie, meet tkrzw_dbm_util — this is the manual page for tkrzw_dbm_util version 1.0.32, and it lives in the User Commands section. it's giving "swiss army knife for Tkrzw databases" and I'm obsessed 💅

✨ DESCRIPTION ✨

tkrzw_dbm_util: DBM utilities of Tkrzw periodt 🦋

🎀 Usage:

each of these is a whole subcommand, and the vibe is: you say what you want, then you hand it a file. here we go, no cap:

tkrzw_dbm_util create [common_options] [tuning_options] [options] file

: Creates a database file. 🌱

tkrzw_dbm_util inspect [common_options] file [attr]

: Prints inspection of a database file. 🔍

tkrzw_dbm_util get [common_options] file key

: Gets a record and prints it. 💌

tkrzw_dbm_util set [common_options] [options] file key

: Sets a record. ✍️

tkrzw_dbm_util remove [common_options] file key

: Removes a record. 🗑️

tkrzw_dbm_util rekey [common_options] file old_key new_key

: Changes the key of a record. 🔑

tkrzw_dbm_util list [common_options] file

: Lists up records and prints them. 📜

tkrzw_dbm_util rebuild [common_options] [tuning_options] file

: Rebuilds a database file for optimization. 🛠️

tkrzw_dbm_util restore [common_options] old_file [new_file]

: Restores a broken database file. 🩹

tkrzw_dbm_util merge [common_options] dest_file src_files...

: Merges database files. 🫱🫲

tkrzw_dbm_util export [common_options] [options] dbm_file rec_file

: Exports records to a flat record file. 📤

tkrzw_dbm_util import [common_options] [options] dbm_file rec_file

: Imports records from a flat record file. 📥

🌈 Common options:

these ones work basically everywhere, they're the group-chat regulars 💖

  • --dbm impl — the name of a DBM implementation: auto, hash, tree, skip, tiny, baby, cache, stdhash, stdtree, poly, shard. (default: auto)
  • --file impl — the name of a file implementation: mmap-para, mmap-atom, pos-para, pos-atom. (default: mmap-para)
  • --no_wait — fails if the file is locked by another process. like, no waiting around, it just says no 💀
  • --no_lock — omits file locking. 🙈
  • --sync_hard — synchronizes the file physically when closing.
  • --alloc_init num — the initial allocation size. (default: 1048576)
  • --alloc_inc num — the allocation increment factor. (default: 2.0)
  • --block_size num — the block size of the positional access file. (default: 1)
  • --direct_io — enables the direct I/O option of the positional access file.
  • --sync_io — enables the synchronous I/O option of the positional access file.
  • --padding — enables padding at the end of the file.
  • --pagecache — enables the mini page cache in the process.
  • --multi — calls xxxMulti methods for get, set, and remove subcommands.

🍓 Options for the create subcommand:

  • --truncate — truncates an existing database file. > heads up bestie, "existing" is doing a lot of work in that sentence — it's cutting your current file down. know that before you type it 🙈

🔍 Options for the inspect subcommand:

  • --validate — validates records. ✅

✍️ Options for the set subcommand:

  • --no_overwrite — fails if there's an existing record with the same key. no takebacks, no clobbering 🚫
  • --append str — appends the value at the end after the given delimiter.
  • --incr num — increments the value with the given initial value.
  • --reducer func — sets the reducer for the skip database: none, first, second, last, concat, concatnull, concattab, concatline, total. (default: none)

🔑 Options for the rekey subcommand:

  • --no_overwrite — fails if there's an existing record with the same key. same energy as above 💅

📜 Options for the list subcommand:

  • --move type — type of movement: first, jump, jumplower, jumplowerinc, jumpupper, jumpupperinc. (default: first)
  • --jump_key str — specifies the jump key. (default: empty string)
  • --items num — the number of items to print. (default: 10)
  • --escape — C-style escape is applied to the TSV data.
  • --keys — prints keys only.

🛠️ Options for the rebuild subcommand:

  • --restore — skips broken records to restore a broken database. 🩹

🩹 Options for the restore subcommand:

  • --auto str — the restore mode automatically done: none, default, default-ns, sync, sync-ns. (default: none)
  • --end_offset — the exclusive end offset of records to read. (default: -1)
  • --class — the class name given to PolyDBM or ShardDBM.

🫱🫲 Options for the merge subcommand:

  • --reducer func — sets the reducer for the skip database: none, first, second, last, concat, concatnull, concattab, concatline, total. (default: none)

📤📥 Options for the export and import subcommands:

  • --tsv — the record file is in TSV format instead of flat record.
  • --escape — C-style escape/unescape is applied to the TSV data.
  • --keys — exports keys only.
  • --ulog num — uses update logs based on the timestamp.
  • --ulog_ids num num — sets the server ID and the DBM index of update logs.

🌸 Tuning options for HashDBM:

  • --in_place — uses in-place rather than pre-defined ones.
  • --append — uses appending rather than pre-defined ones.
  • --record_crc num — the record CRC mode: -1, 0, 8, 16, 32. (default: 0 or -1)
  • --record_comp str — the record compression mode: default, none, zlib, zstd, lz4, lzma, rc4, aes. (default: none or default)
  • --offset_width num — the width to represent the offset of records. (default: 4 or -1)
  • --align_pow num — sets the power to align records. (default: 3 or -1)
  • --buckets num — sets the number of buckets for hashing. (default: 1048583 or -1)
  • --cipher_key str — sets the encryption key for cipher compressors. (default: empty)

🦋 Tuning options for TreeDBM:

  • --in_place — uses in-place rather than pre-defined ones.
  • --append — uses appending rather than pre-defined ones.
  • --record_crc num — the record CRC mode: -1, 0, 8, 16, 32. (default: 0 or -1)
  • --record_comp str — the record compression mode: default, none, zlib, zstd, lz4, lzma, rc4, aes. (default: none or default)
  • --offset_width num — the width to represent the offset of records. (default: 4 or -1)
  • --align_pow num — sets the power to align records. (default: 10 or -1)
  • --buckets num — sets the number of buckets for hashing. (default: 131101 or -1)
  • --cipher_key str — sets the encryption key for cipher compressors. (default: empty)
  • --max_page_size num — sets the maximum size of a page. (default: 8130 or -1)
  • --max_branches num — sets the maximum number of branches of inner nodes. (default: 256 or -1)
  • --comparator func — sets the key comparator: lex, lexcase, dec, hex, real, float. (default: lex)

🧚 Tuning options for SkipDBM:

  • --offset_width num — the width to represent the offset of records. (default: 4)
  • --step_unit num — sets the step unit of the skip list. (default: 4)
  • --max_level num — sets the maximum level of the skip list. (default: 14)
  • --sort_mem_size num — sets the memory size used for sorting. (default: 268435456)
  • --insert_in_order — inserts records in ascending order of the key.

💜 Options for PolyDBM and ShardDBM:

  • --params str — sets the parameters in "key=value,key=value" format.

okay that's the whole page bestie, every single flag accounted for, nothing dropped, we ate and left no crumbs 👑✨

this has been tkrzw_dbm_util version 1.0.32, dated January 2025 — mwah, go forth and manage your databases, you main character 🫶🌸💅

📦 where this page comes from