forked from careo/tokyocabinet-ruby
-
Notifications
You must be signed in to change notification settings - Fork 1
/
tokyocabinet-doc.rb
1539 lines (1537 loc) · 93.5 KB
/
tokyocabinet-doc.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#--
# Ruby binding of Tokyo Cabinet
# Copyright (C) 2006-2010 FAL Labs
# This file is part of Tokyo Cabinet.
# Tokyo Cabinet is free software; you can redistribute it and/or modify it under the terms of
# the GNU Lesser General Public License as published by the Free Software Foundation; either
# version 2.1 of the License or any later version. Tokyo Cabinet is distributed in the hope
# that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
# License for more details.
# You should have received a copy of the GNU Lesser General Public License along with Tokyo
# Cabinet; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
# Boston, MA 02111-1307 USA.
#++
#:include:overview.rd
module TokyoCabinet
# the version information
VERSION = "x.y.z"
# Hash database is a file containing a hash table and is handled with the hash database API. Before operations to store or retrieve records, it is necessary to open a database file and connect the hash database object to it. To avoid data missing or corruption, it is important to close every database file when it is no longer in use. It is forbidden for multible database objects in a process to open the same database at the same time.%%
# Except for the interface below, methods compatible with the `Hash' class are also provided; `[]', `[]=', `store', `delete', `fetch', `has_key?', `has_value?', `key', `clear', `length', `empty?', `each', `each_key', `each_value', and `keys'.%%
class HDB
# error code: success
ESUCCESS = 0
# error code: threading error
ETHREAD = 1
# error code: invalid operation
EINVALID = 2
# error code: file not found
ENOFILE = 3
# error code: no permission
ENOPERM = 4
# error code: invalid meta data
EMETA = 5
# error code: invalid record header
ERHEAD = 6
# error code: open error
EOPEN = 7
# error code: close error
ECLOSE = 8
# error code: trunc error
ETRUNC = 9
# error code: sync error
ESYNC = 10
# error code: stat error
ESTAT = 11
# error code: seek error
ESEEK = 12
# error code: read error
EREAD = 13
# error code: write error
EWRITE = 14
# error code: mmap error
EMMAP = 15
# error code: lock error
ELOCK = 16
# error code: unlink error
EUNLINK = 17
# error code: rename error
ERENAME = 18
# error code: mkdir error
EMKDIR = 19
# error code: rmdir error
ERMDIR = 20
# error code: existing record
EKEEP = 21
# error code: no record found
ENOREC = 22
# error code: miscellaneous error
EMISC = 9999
# tuning option: use 64-bit bucket array
TLARGE = 1 << 0
# tuning option: compress each record with Deflate
TDEFLATE = 1 << 1
# tuning option: compress each record with BZIP2
TBZIP = 1 << 2
# tuning option: compress each record with TCBS
TTCBS = 1 << 3
# open mode: open as a reader
OREADER = 1 << 0
# open mode: open as a writer
OWRITER = 1 << 1
# open mode: writer creating
OCREAT = 1 << 2
# open mode: writer truncating
OTRUNC = 1 << 3
# open mode: open without locking
ONOLCK = 1 << 4
# open mode: lock without blocking
OLCKNB = 1 << 5
# open mode: synchronize every transaction
OTSYNC = 1 << 6
# Create a hash database object.%%
# The return value is the new hash database object.%%
def initialize()
# (native code)
end
# Get the message string corresponding to an error code.%%
# `<i>ecode</i>' specifies the error code. If it is not defined or negative, the last happened error code is specified.%%
# The return value is the message string of the error code.%%
def errmsg(ecode)
# (native code)
end
# Get the last happened error code.%%
# The return value is the last happened error code.%%
# The following error codes are defined: `TokyoCabinet::HDB::ESUCCESS' for success, `TokyoCabinet::HDB::ETHREAD' for threading error, `TokyoCabinet::HDB::EINVALID' for invalid operation, `TokyoCabinet::HDB::ENOFILE' for file not found, `TokyoCabinet::HDB::ENOPERM' for no permission, `TokyoCabinet::HDB::EMETA' for invalid meta data, `TokyoCabinet::HDB::ERHEAD' for invalid record header, `TokyoCabinet::HDB::EOPEN' for open error, `TokyoCabinet::HDB::ECLOSE' for close error, `TokyoCabinet::HDB::ETRUNC' for trunc error, `TokyoCabinet::HDB::ESYNC' for sync error, `TokyoCabinet::HDB::ESTAT' for stat error, `TokyoCabinet::HDB::ESEEK' for seek error, `TokyoCabinet::HDB::EREAD' for read error, `TokyoCabinet::HDB::EWRITE' for write error, `TokyoCabinet::HDB::EMMAP' for mmap error, `TokyoCabinet::HDB::ELOCK' for lock error, `TokyoCabinet::HDB::EUNLINK' for unlink error, `TokyoCabinet::HDB::ERENAME' for rename error, `TokyoCabinet::HDB::EMKDIR' for mkdir error, `TokyoCabinet::HDB::ERMDIR' for rmdir error, `TokyoCabinet::HDB::EKEEP' for existing record, `TokyoCabinet::HDB::ENOREC' for no record found, and `TokyoCabinet::HDB::EMISC' for miscellaneous error.%%
def ecode()
# (native code)
end
# Set the tuning parameters.%%
# `<i>bnum</i>' specifies the number of elements of the bucket array. If it is not defined or not more than 0, the default value is specified. The default value is 131071. Suggested size of the bucket array is about from 0.5 to 4 times of the number of all records to be stored.%%
# `<i>apow</i>' specifies the size of record alignment by power of 2. If it is not defined or negative, the default value is specified. The default value is 4 standing for 2^4=16.%%
# `<i>fpow</i>' specifies the maximum number of elements of the free block pool by power of 2. If it is not defined or negative, the default value is specified. The default value is 10 standing for 2^10=1024.%%
# `<i>opts</i>' specifies options by bitwise-or: `TokyoCabinet::HDB::TLARGE' specifies that the size of the database can be larger than 2GB by using 64-bit bucket array, `TokyoCabinet::HDB::TDEFLATE' specifies that each record is compressed with Deflate encoding, `TokyoCabinet::HDB::TDBZIP' specifies that each record is compressed with BZIP2 encoding, `TokyoCabinet::HDB::TTCBS' specifies that each record is compressed with TCBS encoding. If it is not defined, no option is specified.%%
# If successful, the return value is true, else, it is false. Note that the tuning parameters of the database should be set before the database is opened.%%
def tune(bnum, apow, fpow, opts)
# (native code)
end
# Set the caching parameters.%%
# `<i>rcnum</i>' specifies the maximum number of records to be cached. If it is not defined or not more than 0, the record cache is disabled. It is disabled by default.%%
# If successful, the return value is true, else, it is false.%%
# Note that the caching parameters of the database should be set before the database is opened.%%
def setcache(rcnum)
# (native code)
end
# Set the size of the extra mapped memory.%%
# `<i>xmsiz</i>' specifies the size of the extra mapped memory. If it is not defined or not more than 0, the extra mapped memory is disabled. The default size is 67108864.%%
# If successful, the return value is true, else, it is false.%%
# Note that the mapping parameters should be set before the database is opened.%%
def setxmsiz(xmsiz)
# (native code)
end
# Set the unit step number of auto defragmentation.%%
# `<i>dfunit</i>' specifie the unit step number. If it is not more than 0, the auto defragmentation is disabled. It is disabled by default.%%
# If successful, the return value is true, else, it is false.%%
# Note that the defragmentation parameters should be set before the database is opened.%%
def setdfunit(dfunit)
# (native code)
end
# Open a database file.%%
# `<i>path</i>' specifies the path of the database file.%%
# `<i>omode</i>' specifies the connection mode: `TokyoCabinet::HDB::OWRITER' as a writer, `TokyoCabinet::HDB::OREADER' as a reader. If the mode is `TokyoCabinet::HDB::OWRITER', the following may be added by bitwise-or: `TokyoCabinet::HDB::OCREAT', which means it creates a new database if not exist, `TokyoCabinet::HDB::OTRUNC', which means it creates a new database regardless if one exists, `TokyoCabinet::HDB::OTSYNC', which means every transaction synchronizes updated contents with the device. Both of `TokyoCabinet::HDB::OREADER' and `TokyoCabinet::HDB::OWRITER' can be added to by bitwise-or: `TokyoCabinet::HDB::ONOLCK', which means it opens the database file without file locking, or `TokyoCabinet::HDB::OLCKNB', which means locking is performed without blocking. If it is not defined, `TokyoCabinet::HDB::OREADER' is specified.%%
# If successful, the return value is true, else, it is false.%%
def open(path, omode)
# (native code)
end
# Close the database file.%%
# If successful, the return value is true, else, it is false.%%
# Update of a database is assured to be written when the database is closed. If a writer opens a database but does not close it appropriately, the database will be broken.%%
def close()
# (native code)
end
# Store a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, it is overwritten.%%
def put(key, value)
# (native code)
end
# Store a new record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, this method has no effect.%%
def putkeep(key, value)
# (native code)
end
# Concatenate a value at the end of the existing record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If there is no corresponding record, a new record is created.%%
def putcat(key, value)
# (native code)
end
# Store a record in asynchronous fashion.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, it is overwritten. Records passed to this method are accumulated into the inner buffer and wrote into the file at a blast.%%
def putasync(key, value)
# (native code)
end
# Remove a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is true, else, it is false.%%
def out(key)
# (native code)
end
# Retrieve a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is the value of the corresponding record. `nil' is returned if no record corresponds.%%
def get(key)
# (native code)
end
# Get the size of the value of a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is the size of the value of the corresponding record, else, it is -1.%%
def vsiz(key)
# (native code)
end
# Initialize the iterator.%%
# If successful, the return value is true, else, it is false.%%
# The iterator is used in order to access the key of every record stored in a database.%%
def iterinit()
# (native code)
end
# Get the next key of the iterator.%%
# If successful, the return value is the next key, else, it is `nil'. `nil' is returned when no record is to be get out of the iterator.%%
# It is possible to access every record by iteration of calling this method. It is allowed to update or remove records whose keys are fetched while the iteration. However, it is not assured if updating the database is occurred while the iteration. Besides, the order of this traversal access method is arbitrary, so it is not assured that the order of storing matches the one of the traversal access.%%
def iternext()
# (native code)
end
# Get forward matching keys.%%
# `<i>prefix</i>' specifies the prefix of the corresponding keys.%%
# `<i>max</i>' specifies the maximum number of keys to be fetched. If it is not defined or negative, no limit is specified.%%
# The return value is a list object of the keys of the corresponding records. This method does never fail. It returns an empty list even if no record corresponds.%%
# Note that this method may be very slow because every key in the database is scanned.%%
def fwmkeys(prefix, max)
# (native code)
end
# Add an integer to a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as an integer and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `i' operator after retrieval.%%
def addint(key, num)
# (native code)
end
# Add a real number to a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as a real number and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `d' operator after retrieval.%%
def adddouble(key, num)
# (native code)
end
# Synchronize updated contents with the file and the device.%%
# If successful, the return value is true, else, it is false.%%
# This method is useful when another process connects the same database file.%%
def sync()
# (native code)
end
# Optimize the database file.%%
# `<i>bnum</i>' specifies the number of elements of the bucket array. If it is not defined or not more than 0, the default value is specified. The default value is two times of the number of records.%%
# `<i>apow</i>' specifies the size of record alignment by power of 2. If it is not defined or negative, the current setting is not changed.%%
# `<i>fpow</i>' specifies the maximum number of elements of the free block pool by power of 2. If it is not defined or negative, the current setting is not changed.%%
# `<i>opts</i>' specifies options by bitwise-or: `TokyoCabinet::HDB::TLARGE' specifies that the size of the database can be larger than 2GB by using 64-bit bucket array, `TokyoCabinet::HDB::TDEFLATE' specifies that each record is compressed with Deflate encoding, `TokyoCabinet::HDB::TBZIP' specifies that each record is compressed with BZIP2 encoding, `TokyoCabinet::HDB::TTCBS' specifies that each record is compressed with TCBS encoding. If it is not defined or 0xff, the current setting is not changed.%%
# If successful, the return value is true, else, it is false.%%
# This method is useful to reduce the size of the database file with data fragmentation by successive updating.%%
def optimize(bnum, apow, fpow, opts)
# (native code)
end
# Remove all records.%%
# If successful, the return value is true, else, it is false.%%
def vanish()
# (native code)
end
# Copy the database file.%%
# `<i>path</i>' specifies the path of the destination file. If it begins with `@', the trailing substring is executed as a command line.%%
# If successful, the return value is true, else, it is false. False is returned if the executed command returns non-zero code.%%
# The database file is assured to be kept synchronized and not modified while the copying or executing operation is in progress. So, this method is useful to create a backup file of the database file.%%
def copy(path)
# (native code)
end
# Begin the transaction.%%
# If successful, the return value is true, else, it is false.%%
# The database is locked by the thread while the transaction so that only one transaction can be activated with a database object at the same time. Thus, the serializable isolation level is assumed if every database operation is performed in the transaction. All updated regions are kept track of by write ahead logging while the transaction. If the database is closed during transaction, the transaction is aborted implicitly.%%
def tranbegin()
# (native code)
end
# Commit the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is fixed when it is committed successfully.%%
def trancommit()
# (native code)
end
# Abort the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is discarded when it is aborted. The state of the database is rollbacked to before transaction.%%
def tranabort()
# (native code)
end
# Get the path of the database file.%%
# The return value is the path of the database file or `nil' if the object does not connect to any database file.%%
def path()
# (native code)
end
# Get the number of records.%%
# The return value is the number of records or 0 if the object does not connect to any database file.%%
def rnum()
# (native code)
end
# Get the size of the database file.%%
# The return value is the size of the database file or 0 if the object does not connect to any database file.%%
def fsiz()
# (native code)
end
end
# B+ tree database is a file containing a B+ tree and is handled with the B+ tree database API. Before operations to store or retrieve records, it is necessary to open a database file and connect the B+ tree database object to it. To avoid data missing or corruption, it is important to close every database file when it is no longer in use. It is forbidden for multible database objects in a process to open the same database at the same time.%%
# Except for the interface below, methods compatible with the `Hash' class are also provided; `[]', `[]=', `store', `delete', `fetch', `has_key?', `has_value?', `key', `clear', `length', `empty?', `each', `each_key', `each_value', and `keys'.%%
class BDB
# error code: success
ESUCCESS = 0
# error code: threading error
ETHREAD = 1
# error code: invalid operation
EINVALID = 2
# error code: file not found
ENOFILE = 3
# error code: no permission
ENOPERM = 4
# error code: invalid meta data
EMETA = 5
# error code: invalid record header
ERHEAD = 6
# error code: open error
EOPEN = 7
# error code: close error
ECLOSE = 8
# error code: trunc error
ETRUNC = 9
# error code: sync error
ESYNC = 10
# error code: stat error
ESTAT = 11
# error code: seek error
ESEEK = 12
# error code: read error
EREAD = 13
# error code: write error
EWRITE = 14
# error code: mmap error
EMMAP = 15
# error code: lock error
ELOCK = 16
# error code: unlink error
EUNLINK = 17
# error code: rename error
ERENAME = 18
# error code: mkdir error
EMKDIR = 19
# error code: rmdir error
ERMDIR = 20
# error code: existing record
EKEEP = 21
# error code: no record found
ENOREC = 22
# error code: miscellaneous error
EMISC = 9999
# comparison function: by lexical order
CMPLEXICAL = "CMPLEXICAL"
# comparison function: as decimal strings of real numbers
CMPDECIMAL = "CMPDECIMAL"
# comparison function: as 32-bit integers in the native byte order
CMPINT32 = "CMPINT32"
# comparison function: as 64-bit integers in the native byte order
CMPINT64 = "CMPINT64"
# tuning option: use 64-bit bucket array
TLARGE = 1 << 0
# tuning option: compress each record with Deflate
TDEFLATE = 1 << 1
# tuning option: compress each record with BZIP2
TBZIP = 1 << 2
# tuning option: compress each record with TCBS
TTCBS = 1 << 3
# open mode: open as a reader
OREADER = 1 << 0
# open mode: open as a writer
OWRITER = 1 << 1
# open mode: writer creating
OCREAT = 1 << 2
# open mode: writer truncating
OTRUNC = 1 << 3
# open mode: open without locking
ONOLCK = 1 << 4
# open mode: lock without blocking
OLCKNB = 1 << 5
# open mode: synchronize every transaction
OTSYNC = 1 << 6
# Create a B+ tree database object.%%
# The return value is the new B+ tree database object.%%
def initialize()
# (native code)
end
# Get the message string corresponding to an error code.%%
# `<i>ecode</i>' specifies the error code. If it is not defined or negative, the last happened error code is specified.%%
# The return value is the message string of the error code.%%
def errmsg(ecode)
# (native code)
end
# Get the last happened error code.%%
# The return value is the last happened error code.%%
# The following error codes are defined: `TokyoCabinet::BDB::ESUCCESS' for success, `TokyoCabinet::BDB::ETHREAD' for threading error, `TokyoCabinet::BDB::EINVALID' for invalid operation, `TokyoCabinet::BDB::ENOFILE' for file not found, `TokyoCabinet::BDB::ENOPERM' for no permission, `TokyoCabinet::BDB::EMETA' for invalid meta data, `TokyoCabinet::BDB::ERHEAD' for invalid record header, `TokyoCabinet::BDB::EOPEN' for open error, `TokyoCabinet::BDB::ECLOSE' for close error, `TokyoCabinet::BDB::ETRUNC' for trunc error, `TokyoCabinet::BDB::ESYNC' for sync error, `TokyoCabinet::BDB::ESTAT' for stat error, `TokyoCabinet::BDB::ESEEK' for seek error, `TokyoCabinet::BDB::EREAD' for read error, `TokyoCabinet::BDB::EWRITE' for write error, `TokyoCabinet::BDB::EMMAP' for mmap error, `TokyoCabinet::BDB::ELOCK' for lock error, `TokyoCabinet::BDB::EUNLINK' for unlink error, `TokyoCabinet::BDB::ERENAME' for rename error, `TokyoCabinet::BDB::EMKDIR' for mkdir error, `TokyoCabinet::BDB::ERMDIR' for rmdir error, `TokyoCabinet::BDB::EKEEP' for existing record, `TokyoCabinet::BDB::ENOREC' for no record found, and `TokyoCabinet::BDB::EMISC' for miscellaneous error.%%
def ecode()
# (native code)
end
# Set the custom comparison function.%%
# `<i>cmp</i>' specifies the custom comparison function. It should be an instance of the class `Proc'.%%
# If successful, the return value is true, else, it is false.%%
# The default comparison function compares keys of two records by lexical order. The constants `TokyoCabinet::BDB::CMPLEXICAL' (dafault), `TokyoCabinet::BDB::CMPDECIMAL', `TokyoCabinet::BDB::CMPINT32', and `TokyoCabinet::BDB::CMPINT64' are built-in. Note that the comparison function should be set before the database is opened. Moreover, user-defined comparison functions should be set every time the database is being opened.%%
def setcmpfunc(cmp)
# (native code)
end
# Set the tuning parameters.%%
# `<i>lmemb</i>' specifies the number of members in each leaf page. If it is not defined or not more than 0, the default value is specified. The default value is 128.%%
# `<i>nmemb</i>' specifies the number of members in each non-leaf page. If it is not defined or not more than 0, the default value is specified. The default value is 256.%%
# `<i>bnum</i>' specifies the number of elements of the bucket array. If it is not defined or not more than 0, the default value is specified. The default value is 32749. Suggested size of the bucket array is about from 1 to 4 times of the number of all pages to be stored.%%
# `<i>apow</i>' specifies the size of record alignment by power of 2. If it is not defined or negative, the default value is specified. The default value is 4 standing for 2^8=256.%%
# `<i>fpow</i>' specifies the maximum number of elements of the free block pool by power of 2. If it is not defined or negative, the default value is specified. The default value is 10 standing for 2^10=1024.%%
# `<i>opts</i>' specifies options by bitwise-or: `TokyoCabinet::BDB::TLARGE' specifies that the size of the database can be larger than 2GB by using 64-bit bucket array, `TokyoCabinet::BDB::TDEFLATE' specifies that each record is compressed with Deflate encoding, `TokyoCabinet::BDB::TBZIP' specifies that each record is compressed with BZIP2 encoding, `TokyoCabinet::BDB::TTCBS' specifies that each record is compressed with TCBS encoding. If it is not defined, no option is specified.%%
# If successful, the return value is true, else, it is false. Note that the tuning parameters of the database should be set before the database is opened.%%
def tune(lmemb, nmemb, bnum, apow, fpow, opts)
# (native code)
end
# Set the caching parameters.%%
# `<i>lcnum</i>' specifies the maximum number of leaf nodes to be cached. If it is not defined or not more than 0, the default value is specified. The default value is 1024.%%
# `<i>ncnum</i>' specifies the maximum number of non-leaf nodes to be cached. If it is not defined or not more than 0, the default value is specified. The default value is 512.%%
# If successful, the return value is true, else, it is false.%%
# Note that the tuning parameters of the database should be set before the database is opened.%%
def setcache(lcnum, ncnum)
# (native code)
end
# Set the size of the extra mapped memory.%%
# `<i>xmsiz</i>' specifies the size of the extra mapped memory. If it is not defined or not more than 0, the extra mapped memory is disabled. It is disabled by default.%%
# If successful, the return value is true, else, it is false.%%
# Note that the mapping parameters should be set before the database is opened.%%
def setxmsiz(xmsiz)
# (native code)
end
# Set the unit step number of auto defragmentation.%%
# `<i>dfunit</i>' specifie the unit step number. If it is not more than 0, the auto defragmentation is disabled. It is disabled by default.%%
# If successful, the return value is true, else, it is false.%%
# Note that the defragmentation parameters should be set before the database is opened.%%
def setdfunit(dfunit)
# (native code)
end
# Open a database file.%%
# `<i>path</i>' specifies the path of the database file.%%
# `<i>omode</i>' specifies the connection mode: `TokyoCabinet::BDB::OWRITER' as a writer, `TokyoCabinet::BDB::OREADER' as a reader. If the mode is `TokyoCabinet::BDB::OWRITER', the following may be added by bitwise-or: `TokyoCabinet::BDB::OCREAT', which means it creates a new database if not exist, `TokyoCabinet::BDB::OTRUNC', which means it creates a new database regardless if one exists, `TokyoCabinet::BDB::OTSYNC', which means every transaction synchronizes updated contents with the device. Both of `TokyoCabinet::BDB::OREADER' and `TokyoCabinet::BDB::OWRITER' can be added to by bitwise-or: `TokyoCabinet::BDB::ONOLCK', which means it opens the database file without file locking, or `TokyoCabinet::BDB::OLCKNB', which means locking is performed without blocking. If it is not defined, `TokyoCabinet::BDB::OREADER' is specified.%%
# If successful, the return value is true, else, it is false.%%
def open(path, omode)
# (native code)
end
# Close the database file.%%
# If successful, the return value is true, else, it is false.%%
# Update of a database is assured to be written when the database is closed. If a writer opens a database but does not close it appropriately, the database will be broken.%%
def close()
# (native code)
end
# Store a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, it is overwritten.%%
def put(key, value)
# (native code)
end
# Store a new record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, this method has no effect.%%
def putkeep(key, value)
# (native code)
end
# Concatenate a value at the end of the existing record.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If there is no corresponding record, a new record is created.%%
def putcat(key, value)
# (native code)
end
# Store a record with allowing duplication of keys.%%
# `<i>key</i>' specifies the key.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, the new record is placed after the existing one.%%
def putdup(key, value)
# (native code)
end
# Store records with allowing duplication of keys.%%
# `<i>key</i>' specifies the key.%%
# `<i>values</i>' specifies an array of the values.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, the new records are placed after the existing one.%%
def putlist(key, values)
# (native code)
end
# Remove a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is true, else, it is false.%%
# If the key of duplicated records is specified, the value of the first one is selected.%%
def out(key)
# (native code)
end
# Remove records.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is true, else, it is false.%%
# If the key of duplicated records is specified, all of them are removed.%%
def outlist(key)
# (native code)
end
# Retrieve a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is the value of the corresponding record. `nil' is returned if no record corresponds.%%
# If the key of duplicated records is specified, the value of the first one is selected.%%
def get(key)
# (native code)
end
# Retrieve records.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is a list object of the values of the corresponding records. `nil' is returned if no record corresponds.%%
def getlist(key)
# (native code)
end
# Get the number of records corresponding a key.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is the number of the corresponding records, else, it is 0.%%
def vnum(key)
# (native code)
end
# Get the size of the value of a record.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is the size of the value of the corresponding record, else, it is -1.%%
# If the key of duplicated records is specified, the value of the first one is selected.%%
def vsiz(key)
# (native code)
end
# Get keys of ranged records.%%
# `<i>bkey</i>' specifies the key of the beginning border. If it is not defined, the first record is specified.%%
# `<i>binc</i>' specifies whether the beginning border is inclusive or not. If it is not defined, false is specified.%%
# `<i>ekey</i>' specifies the key of the ending border. If it is not defined, the last record is specified.%%
# `<i>einc</i>' specifies whether the ending border is inclusive or not. If it is not defined, false is specified.%%
# `<i>max</i>' specifies the maximum number of keys to be fetched. If it is not defined or negative, no limit is specified.%%
# The return value is a list object of the keys of the corresponding records. This method does never fail. It returns an empty list even if no record corresponds.%%
def range(bkey, binc, ekey, einc, max)
# (native code)
end
# Get forward matching keys.%%
# `<i>prefix</i>' specifies the prefix of the corresponding keys.%%
# `<i>max</i>' specifies the maximum number of keys to be fetched. If it is not defined or negative, no limit is specified.%%
# The return value is a list object of the keys of the corresponding records. This method does never fail. It returns an empty list even if no record corresponds.%%
def fwmkeys(prefix, max)
# (native code)
end
# Add an integer to a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as an integer and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `i' operator after retrieval.%%
def addint(key, num)
# (native code)
end
# Add a real number to a record.%%
# `<i>key</i>' specifies the key.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as a real number and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `d' operator after retrieval.%%
def adddouble(key, num)
# (native code)
end
# Synchronize updated contents with the file and the device.%%
# If successful, the return value is true, else, it is false.%%
# This method is useful when another process connects the same database file.%%
def sync()
# (native code)
end
# Optimize the database file.%%
# `<i>lmemb</i>' specifies the number of members in each leaf page. If it is not defined or not more than 0, the default value is specified. The default value is 128.%%
# `<i>nmemb</i>' specifies the number of members in each non-leaf page. If it is not defined or not more than 0, the default value is specified. The default value is 256.%%
# `<i>bnum</i>' specifies the number of elements of the bucket array. If it is not defined or not more than 0, the default value is specified. The default value is two times of the number of pages.%%
# `<i>apow</i>' specifies the size of record alignment by power of 2. If it is not defined or negative, the current setting is not changed.%%
# `<i>fpow</i>' specifies the maximum number of elements of the free block pool by power of 2. If it is not defined or negative, the current setting is not changed.%%
# `<i>opts</i>' specifies options by bitwise-or: `TokyoCabinet::BDB::TLARGE' specifies that the size of the database can be larger than 2GB by using 64-bit bucket array, `TokyoCabinet::BDB::TDEFLATE' specifies that each record is compressed with Deflate encoding, `TokyoCabinet::BDB::TBZIP' specifies that each record is compressed with BZIP2 encoding, `TokyoCabinet::BDB::TTCBS' specifies that each record is compressed with TCBS encoding. If it is not defined or 0xff, the current setting is not changed.%%
# If successful, the return value is true, else, it is false.%%
# This method is useful to reduce the size of the database file with data fragmentation by successive updating.%%
def optimize(lmemb, nmemb, bnum, apow, fpow, opts)
# (native code)
end
# Remove all records.%%
# If successful, the return value is true, else, it is false.%%
def vanish()
# (native code)
end
# Copy the database file.%%
# `<i>path</i>' specifies the path of the destination file. If it begins with `@', the trailing substring is executed as a command line.%%
# If successful, the return value is true, else, it is false. False is returned if the executed command returns non-zero code.%%
# The database file is assured to be kept synchronized and not modified while the copying or executing operation is in progress. So, this method is useful to create a backup file of the database file.%%
def copy(path)
# (native code)
end
# Begin the transaction.%%
# If successful, the return value is true, else, it is false.%%
# The database is locked by the thread while the transaction so that only one transaction can be activated with a database object at the same time. Thus, the serializable isolation level is assumed if every database operation is performed in the transaction. Because all pages are cached on memory while the transaction, the amount of referred records is limited by the memory capacity. If the database is closed during transaction, the transaction is aborted implicitly.%%
def tranbegin()
# (native code)
end
# Commit the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is fixed when it is committed successfully.%%
def trancommit()
# (native code)
end
# Abort the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is discarded when it is aborted. The state of the database is rollbacked to before transaction.%%
def tranabort()
# (native code)
end
# Get the path of the database file.%%
# The return value is the path of the database file or `nil' if the object does not connect to any database file.%%
def path()
# (native code)
end
# Get the number of records.%%
# The return value is the number of records or 0 if the object does not connect to any database file.%%
def rnum()
# (native code)
end
# Get the size of the database file.%%
# The return value is the size of the database file or 0 if the object does not connect to any database file.%%
def fsiz()
# (native code)
end
end
# Cursor is a mechanism to access each record of B+ tree database in ascending or descending order.%%
class BDBCUR
# cursor put mode: current
CPCURRENT = 0
# cursor put mode: before
CPBEFORE = 1
# cursor put mode: after
CPAFTER = 2
# Create a cursor object.%%
# `<i>bdb</i>' specifies the B+ tree database object.%%
# The return value is the new cursor object.%%
# Note that the cursor is available only after initialization with the `first' or the `jump' methods and so on. Moreover, the position of the cursor will be indefinite when the database is updated after the initialization of the cursor.%%
def initialize(bdb)
# (native code)
end
# Move the cursor to the first record.%%
# If successful, the return value is true, else, it is false. False is returned if there is no record in the database.%%
def first()
# (native code)
end
# Move the cursor to the last record.%%
# If successful, the return value is true, else, it is false. False is returned if there is no record in the database.%%
def last()
# (native code)
end
# Move the cursor to the front of records corresponding a key.%%
# `<i>key</i>' specifies the key.%%
# If successful, the return value is true, else, it is false. False is returned if there is no record corresponding the condition.%%
# The cursor is set to the first record corresponding the key or the next substitute if completely matching record does not exist.%%
def jump(key)
# (native code)
end
# Move the cursor to the previous record.%%
# If successful, the return value is true, else, it is false. False is returned if there is no previous record.%%
def prev()
# (native code)
end
# Move the cursor to the next record.%%
# If successful, the return value is true, else, it is false. False is returned if there is no next record.%%
def next()
# (native code)
end
# Insert a record around the cursor.%%
# `<i>value</i>' specifies the value.%%
# `<i>cpmode</i>' specifies detail adjustment: `TokyoCabinet::BDBCUR::CPCURRENT', which means that the value of the current record is overwritten, `TokyoCabinet::BDBCUR::CPBEFORE', which means that the new record is inserted before the current record, `TokyoCabinet::BDBCUR::CPAFTER', which means that the new record is inserted after the current record.%%
# If successful, the return value is true, else, it is false. False is returned when the cursor is at invalid position.%%
# After insertion, the cursor is moved to the inserted record.%%
def put(value, cpmode)
# (native code)
end
# Remove the record where the cursor is.%%
# If successful, the return value is true, else, it is false. False is returned when the cursor is at invalid position.%%
# After deletion, the cursor is moved to the next record if possible.%%
def out()
# (native code)
end
# Get the key of the record where the cursor is.%%
# If successful, the return value is the key, else, it is `nil'. 'nil' is returned when the cursor is at invalid position.%%
def key()
# (native code)
end
# Get the value of the record where the cursor is.%%
# If successful, the return value is the value, else, it is `nil'. 'nil' is returned when the cursor is at invalid position.%%
def val()
# (native code)
end
end
# Fixed-Length database is a file containing a fixed-length table and is handled with the fixed-length database API. Before operations to store or retrieve records, it is necessary to open a database file and connect the fixed-length database object to it. To avoid data missing or corruption, it is important to close every database file when it is no longer in use. It is forbidden for multible database objects in a process to open the same database at the same time.%%
# Except for the interface below, methods compatible with the `Hash' class are also provided; `[]', `[]=', `store', `delete', `fetch', `has_key?', `has_value?', `key', `clear', `length', `empty?', `each', `each_key', `each_value', and `keys'.%%
class FDB
# error code: success
ESUCCESS = 0
# error code: threading error
ETHREAD = 1
# error code: invalid operation
EINVALID = 2
# error code: file not found
ENOFILE = 3
# error code: no permission
ENOPERM = 4
# error code: invalid meta data
EMETA = 5
# error code: invalid record header
ERHEAD = 6
# error code: open error
EOPEN = 7
# error code: close error
ECLOSE = 8
# error code: trunc error
ETRUNC = 9
# error code: sync error
ESYNC = 10
# error code: stat error
ESTAT = 11
# error code: seek error
ESEEK = 12
# error code: read error
EREAD = 13
# error code: write error
EWRITE = 14
# error code: mmap error
EMMAP = 15
# error code: lock error
ELOCK = 16
# error code: unlink error
EUNLINK = 17
# error code: rename error
ERENAME = 18
# error code: mkdir error
EMKDIR = 19
# error code: rmdir error
ERMDIR = 20
# error code: existing record
EKEEP = 21
# error code: no record found
ENOREC = 22
# error code: miscellaneous error
EMISC = 9999
# open mode: open as a reader
OREADER = 1 << 0
# open mode: open as a writer
OWRITER = 1 << 1
# open mode: writer creating
OCREAT = 1 << 2
# open mode: writer truncating
OTRUNC = 1 << 3
# open mode: open without locking
ONOLCK = 1 << 4
# open mode: lock without blocking
OLCKNB = 1 << 5
# Create a fixed-length database object.%%
# The return value is the new fixed-length database object.%%
def initialize()
# (native code)
end
# Get the message string corresponding to an error code.%%
# `<i>ecode</i>' specifies the error code. If it is not defined or negative, the last happened error code is specified.%%
# The return value is the message string of the error code.%%
def errmsg(ecode)
# (native code)
end
# Get the last happened error code.%%
# The return value is the last happened error code.%%
# The following error codes are defined: `TokyoCabinet::FDB::ESUCCESS' for success, `TokyoCabinet::FDB::ETHREAD' for threading error, `TokyoCabinet::FDB::EINVALID' for invalid operation, `TokyoCabinet::FDB::ENOFILE' for file not found, `TokyoCabinet::FDB::ENOPERM' for no permission, `TokyoCabinet::FDB::EMETA' for invalid meta data, `TokyoCabinet::FDB::ERHEAD' for invalid record header, `TokyoCabinet::FDB::EOPEN' for open error, `TokyoCabinet::FDB::ECLOSE' for close error, `TokyoCabinet::FDB::ETRUNC' for trunc error, `TokyoCabinet::FDB::ESYNC' for sync error, `TokyoCabinet::FDB::ESTAT' for stat error, `TokyoCabinet::FDB::ESEEK' for seek error, `TokyoCabinet::FDB::EREAD' for read error, `TokyoCabinet::FDB::EWRITE' for write error, `TokyoCabinet::FDB::EMMAP' for mmap error, `TokyoCabinet::FDB::ELOCK' for lock error, `TokyoCabinet::FDB::EUNLINK' for unlink error, `TokyoCabinet::FDB::ERENAME' for rename error, `TokyoCabinet::FDB::EMKDIR' for mkdir error, `TokyoCabinet::FDB::ERMDIR' for rmdir error, `TokyoCabinet::FDB::EKEEP' for existing record, `TokyoCabinet::FDB::ENOREC' for no record found, and `TokyoCabinet::FDB::EMISC' for miscellaneous error.%%
def ecode()
# (native code)
end
# Set the tuning parameters.%%
# `<i>width</i>' specifies the width of the value of each record. If it is not defined or not more than 0, the default value is specified. The default value is 255.%%
# `<i>limsiz</i>' specifies the limit size of the database file. If it is not defined or not more than 0, the default value is specified. The default value is 268435456.%%
# If successful, the return value is true, else, it is false. Note that the tuning parameters of the database should be set before the database is opened.%%
def tune(width, limsiz)
# (native code)
end
# Open a database file.%%
# `<i>path</i>' specifies the path of the database file.%%
# `<i>omode</i>' specifies the connection mode: `TokyoCabinet::FDB::OWRITER' as a writer, `TokyoCabinet::FDB::OREADER' as a reader. If the mode is `TokyoCabinet::FDB::OWRITER', the following may be added by bitwise-or: `TokyoCabinet::FDB::OCREAT', which means it creates a new database if not exist, `TokyoCabinet::FDB::OTRUNC', which means it creates a new database regardless if one exists. Both of `TokyoCabinet::FDB::OREADER' and `TokyoCabinet::FDB::OWRITER' can be added to by bitwise-or: `TokyoCabinet::FDB::ONOLCK', which means it opens the database file without file locking, or `TokyoCabinet::FDB::OLCKNB', which means locking is performed without blocking. If it is not defined, `TokyoCabinet::FDB::OREADER' is specified.%%
# If successful, the return value is true, else, it is false.%%
def open(path, omode)
# (native code)
end
# Close the database file.%%
# If successful, the return value is true, else, it is false.%%
# Update of a database is assured to be written when the database is closed. If a writer opens a database but does not close it appropriately, the database will be broken.%%
def close()
# (native code)
end
# Store a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is "min", the minimum ID number of existing records is specified. If it is "prev", the number less by one than the minimum ID number of existing records is specified. If it is "max", the maximum ID number of existing records is specified. If it is "next", the number greater by one than the maximum ID number of existing records is specified.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, it is overwritten.%%
def put(key, value)
# (native code)
end
# Store a new record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is "min", the minimum ID number of existing records is specified. If it is "prev", the number less by one than the minimum ID number of existing records is specified. If it is "max", the maximum ID number of existing records is specified. If it is "next", the number greater by one than the maximum ID number of existing records is specified.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If a record with the same key exists in the database, this method has no effect.%%
def putkeep(key, value)
# (native code)
end
# Concatenate a value at the end of the existing record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is "min", the minimum ID number of existing records is specified. If it is "prev", the number less by one than the minimum ID number of existing records is specified. If it is "max", the maximum ID number of existing records is specified. If it is "next", the number greater by one than the maximum ID number of existing records is specified.%%
# `<i>value</i>' specifies the value.%%
# If successful, the return value is true, else, it is false.%%
# If there is no corresponding record, a new record is created.%%
def putcat(key, value)
# (native code)
end
# Remove a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is `FDBIDMIN', the minimum ID number of existing records is specified. If it is `FDBIDMAX', the maximum ID number of existing records is specified.%%
# If successful, the return value is true, else, it is false.%%
def out(key)
# (native code)
end
# Retrieve a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is `FDBIDMIN', the minimum ID number of existing records is specified. If it is `FDBIDMAX', the maximum ID number of existing records is specified.%%
# If successful, the return value is the value of the corresponding record. `nil' is returned if no record corresponds.%%
def get(key)
# (native code)
end
# Get the size of the value of a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is `FDBIDMIN', the minimum ID number of existing records is specified. If it is `FDBIDMAX', the maximum ID number of existing records is specified.%%
# If successful, the return value is the size of the value of the corresponding record, else, it is -1.%%
def vsiz(key)
# (native code)
end
# Initialize the iterator.%%
# If successful, the return value is true, else, it is false.%%
# The iterator is used in order to access the key of every record stored in a database.%%
def iterinit()
# (native code)
end
# Get the next key of the iterator.%%
# If successful, the return value is the next key, else, it is `nil'. `nil' is returned when no record is to be get out of the iterator.%%
# It is possible to access every record by iteration of calling this method. It is allowed to update or remove records whose keys are fetched while the iteration. The order of this traversal access method is ascending of the ID number.%%
def iternext()
# (native code)
end
# Get keys with an interval notation.%%
# `<i>interval</i>' specifies the interval notation.%%
# `<i>max</i>' specifies the maximum number of keys to be fetched. If it is not defined or negative, no limit is specified.%%
# The return value is a list object of the keys of the corresponding records. This method does never fail. It returns an empty list even if no record corresponds.%%
def range(interval, max)
# (native code)
end
# Add an integer to a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is "min", the minimum ID number of existing records is specified. If it is "prev", the number less by one than the minimum ID number of existing records is specified. If it is "max", the maximum ID number of existing records is specified. If it is "next", the number greater by one than the maximum ID number of existing records is specified.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as an integer and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `i' operator after retrieval.%%
def addint(key, num)
# (native code)
end
# Add a real number to a record.%%
# `<i>key</i>' specifies the key. It should be more than 0. If it is "min", the minimum ID number of existing records is specified. If it is "prev", the number less by one than the minimum ID number of existing records is specified. If it is "max", the maximum ID number of existing records is specified. If it is "next", the number greater by one than the maximum ID number of existing records is specified.%%
# `<i>num</i>' specifies the additional value.%%
# If successful, the return value is the summation value, else, it is `nil'.%%
# If the corresponding record exists, the value is treated as a real number and is added to. If no record corresponds, a new record of the additional value is stored. Because records are stored in binary format, they should be processed with the `unpack' method with the `d' operator after retrieval.%%
def adddouble(key, num)
# (native code)
end
# Synchronize updated contents with the file and the device.%%
# If successful, the return value is true, else, it is false.%%
# This method is useful when another process connects the same database file.%%
def sync()
# (native code)
end
# Optimize the database file.%%
# `width' specifies the width of the value of each record. If it is not defined or not more than 0, the current setting is not changed.%%
# `limsiz' specifies the limit size of the database file. If it is not defined or not more than 0, the current setting is not changed.%%
# If successful, the return value is true, else, it is false.%%
def optimize(bnum, width, limsiz)
# (native code)
end
# Remove all records.%%
# If successful, the return value is true, else, it is false.%%
def vanish()
# (native code)
end
# Copy the database file.%%
# `<i>path</i>' specifies the path of the destination file. If it begins with `@', the trailing substring is executed as a command line.%%
# If successful, the return value is true, else, it is false. False is returned if the executed command returns non-zero code.%%
# The database file is assured to be kept synchronized and not modified while the copying or executing operation is in progress. So, this method is useful to create a backup file of the database file.%%
def copy(path)
# (native code)
end
# Begin the transaction.%%
# If successful, the return value is true, else, it is false.%%
# The database is locked by the thread while the transaction so that only one transaction can be activated with a database object at the same time. Thus, the serializable isolation level is assumed if every database operation is performed in the transaction. All updated regions are kept track of by write ahead logging while the transaction. If the database is closed during transaction, the transaction is aborted implicitly.%%
def tranbegin()
# (native code)
end
# Commit the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is fixed when it is committed successfully.%%
def trancommit()
# (native code)
end
# Abort the transaction.%%
# If successful, the return value is true, else, it is false.%%
# Update in the transaction is discarded when it is aborted. The state of the database is rollbacked to before transaction.%%
def tranabort()
# (native code)
end
# Get the path of the database file.%%
# The return value is the path of the database file or `nil' if the object does not connect to any database file.%%
def path()
# (native code)
end
# Get the number of records.%%
# The return value is the number of records or 0 if the object does not connect to any database file.%%
def rnum()
# (native code)
end
# Get the size of the database file.%%
# The return value is the size of the database file or 0 if the object does not connect to any database file.%%
def fsiz()
# (native code)
end
end
# Table database is a file containing records composed of the primary keys and arbitrary columns and is handled with the table database API. Before operations to store or retrieve records, it is necessary to open a database file and connect the table database object to it. To avoid data missing or corruption, it is important to close every database file when it is no longer in use. It is forbidden for multible database objects in a process to open the same database at the same time.%%
# Except for the interface below, methods compatible with the `Hash' class are also provided; `[]', `[]=', `store', `delete', `fetch', `has_key?', `clear', `length', `empty?', `each', `each_key', `each_value', and `keys'.%%
class TDB
# error code: success
ESUCCESS = 0
# error code: threading error
ETHREAD = 1
# error code: invalid operation
EINVALID = 2
# error code: file not found
ENOFILE = 3
# error code: no permission
ENOPERM = 4
# error code: invalid meta data
EMETA = 5
# error code: invalid record header
ERHEAD = 6
# error code: open error
EOPEN = 7
# error code: close error
ECLOSE = 8
# error code: trunc error
ETRUNC = 9
# error code: sync error
ESYNC = 10
# error code: stat error
ESTAT = 11
# error code: seek error
ESEEK = 12
# error code: read error
EREAD = 13
# error code: write error
EWRITE = 14
# error code: mmap error
EMMAP = 15
# error code: lock error
ELOCK = 16
# error code: unlink error
EUNLINK = 17
# error code: rename error
ERENAME = 18
# error code: mkdir error
EMKDIR = 19
# error code: rmdir error
ERMDIR = 20
# error code: existing record
EKEEP = 21
# error code: no record found
ENOREC = 22
# error code: miscellaneous error
EMISC = 9999
# tuning option: use 64-bit bucket array
TLARGE = 1 << 0
# tuning option: compress each record with Deflate
TDEFLATE = 1 << 1
# tuning option: compress each record with BZIP2
TBZIP = 1 << 2
# tuning option: compress each record with TCBS
TTCBS = 1 << 3
# open mode: open as a reader
OREADER = 1 << 0
# open mode: open as a writer
OWRITER = 1 << 1
# open mode: writer creating
OCREAT = 1 << 2
# open mode: writer truncating
OTRUNC = 1 << 3
# open mode: open without locking