1TKRZW_DBM_UTIL(1)                User Commands               TKRZW_DBM_UTIL(1)
2
3
4

NAME

6       tkrzw_dbm_util - manual page for tkrzw_dbm_util 0.9.16
7

DESCRIPTION

9       tkrzw_dbm_util: DBM utilities of Tkrzw
10
11   Usage:
12              tkrzw_dbm_util  create  [common_options]  [tuning_options]  [op‐
13              tions] file
14
15              : Creates a database file.
16
17              tkrzw_dbm_util inspect [common_options] file
18
19              : Prints inspection of a database file.
20
21              tkrzw_dbm_util get [common_options] file key
22
23              : Gets a record and prints it.
24
25              tkrzw_dbm_util set [common_options] [options] file key
26
27              : Sets a record.
28
29              tkrzw_dbm_util remove [common_options] file key
30
31              : Removes a record.
32
33              tkrzw_dbm_util list [common_options] file
34
35              : Lists up records and prints them.
36
37              tkrzw_dbm_util rebuild [common_options] [tuning_options] file
38
39              : Rebuilds a database file for optimization.
40
41              tkrzw_dbm_util restore [common_options] old_file new_file
42
43              : Restores a broken database file.
44
45              tkrzw_dbm_util merge [common_options] dest_file src_files...
46
47              : Merges database files.
48
49              tkrzw_dbm_util  export   [common_options]   [options]   dbm_file
50              rec_file
51
52              : Exports records to a flat record file.
53
54              tkrzw_dbm_util   import   [common_options]   [options]  dbm_file
55              rec_file
56
57              : Imports records from a flat record file.
58
59   Common options:
60       --dbm impl : The name of a DBM implementation: auto, hash, tree,  skip,
61              tiny,  baby,  cache,  stdhash,  stdtree,  poly, shard. (default:
62              auto)
63
64       --file impl : The name of a file implementation: mmap-para,  mmap-atom,
65              pos-para, pos-atom. (default: mmap-para)
66
67       --no_wait : Fails if the file is locked by another process.
68
69       --no_lock : Omits file locking.
70
71   Options for the create subcommand:
72       --truncate : Truncates an existing database file.
73
74   Options for the set subcommand:
75       --no_overwrite : Fails if there's an existing record wit the same key.
76
77       --reducer  func  : Sets the reducer for the skip database: none, first,
78              second, last, concat, concatnull, concattab, concatline,  total.
79              (default: none)
80
81   Options for the list subcommand:
82       --jump pattern : Jumps to the position of the pattern.
83
84       --items num : The number of items to print.
85
86       --escape : C-style escape is applied to the TSV data.
87
88   Options for the rebuild subcommand:
89       --restore : Skips broken records to restore a broken database.
90
91   Options for the restore subcommand:
92       --end_offset  :  The exclusive end offset of records to read. (default:
93              -1)
94
95   Options for the merge subcommand:
96       --reducer func : Sets the reducer for the skip database:  none,  first,
97              second,  last, concat, concatnull, concattab, concatline, total.
98              (default: none)
99
100   Options for the export and import subcommands:
101       --tsv : The record file is in TSV format instead of flat record.
102
103       --escape : C-style escape/unescape is applied to the TSV data.
104
105       --keys : Exports keys only.
106
107   Tuning options for HashDBM:
108       --in_place : Uses in-place rather than pre-defined ones.
109
110       --append : Uses appending rather than pre-defined ones.
111
112       --offset_width num : The width to represent the offset of records. (de‐
113              fault: 4 or -1)
114
115       --align_pow num : Sets the power to align records. (default: 3 or -1)
116
117       --buckets  num  :  Sets  the  number  of buckets for hashing. (default:
118              1048583 or -1)
119
120   Tuning options for TreeDBM:
121       --in_place : Uses in-place rather than pre-defined ones.
122
123       --append : Uses appending rather than pre-defined ones.
124
125       --offset_width num : The width to represent the offset of records. (de‐
126              fault: 4 or -1)
127
128       --align_pow num : Sets the power to align records. (default: 10 or -1)
129
130       --buckets  num  :  Sets  the  number  of buckets for hashing. (default:
131              131101 or -1)
132
133       --max_page_size num : Sets the maximum size of a page.  (default:  8130
134              or -1)
135
136       --max_branches  num  :  Sets  the  maximum  number of branches of inner
137              nodes. (default: 256 or -1)
138
139       --comparator func : Sets the key comparator: lex,  lexcase,  dec,  hex.
140              (default: lex)
141
142   Tuning options for SkipDBM:
143       --offset_width num : The width to represent the offset of records. (de‐
144              fault: 4)
145
146       --step_unit num : Sets the step unit of the skip list. (default: 4)
147
148       --max_level num : Sets the maximum level of the  skip  list.  (default:
149              14)
150
151       --sort_mem_size  num : Sets the memory size used for sorting. (default:
152              268435456)
153
154       --insert_in_order : Inserts records in ascending  order  order  of  the
155              key.
156
157   Options for PolyDBM and ShardDBM:
158       --params str : Sets the parameters in "key=value,key=value" format.
159
160
161
162tkrzw_dbm_util 0.9.16              May 2021                  TKRZW_DBM_UTIL(1)