ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/BDB/BDB.pm
(Generate patch)

Comparing BDB/BDB.pm (file contents):
Revision 1.18 by root, Tue Dec 4 11:07:39 2007 UTC vs.
Revision 1.27 by root, Tue Dec 11 02:32:50 2007 UTC

… …
3BDB - Asynchronous Berkeley DB access 3BDB - Asynchronous Berkeley DB access
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use BDB; 7 use BDB;
8
9 my $env = db_env_create;
10
11 mkdir "bdtest", 0700;
12 db_env_open
13 $env,
14 "bdtest",
15 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL
16 | BDB::INIT_TXN | BDB::RECOVER | BDB::USE_ENVIRON | BDB::CREATE,
17 0600;
18
19 $env->set_flags (BDB::AUTO_COMMIT | BDB::TXN_NOSYNC, 1);
20
21 my $db = db_create $env;
22 db_open $db, undef, "table", undef, BDB::BTREE, BDB::AUTO_COMMIT | BDB::CREATE
23 | BDB::READ_UNCOMMITTED, 0600;
24 db_put $db, undef, "key", "data", 0, sub {
25 db_del $db, undef, "key";
26 };
27 db_sync $db;
28
29 # automatic result processing with AnyEvent:
30 our $FH; open $FH, "<&=" . BDB::poll_fileno;
31 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb);
32
33 # automatic result processing with EV:
34 my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb;
35
36 # with Glib:
37 add_watch Glib::IO BDB::poll_fileno,
38 in => sub { BDB::poll_cb; 1 };
39
40 # or simply flush manually
41 BDB::flush;
42
8 43
9=head1 DESCRIPTION 44=head1 DESCRIPTION
10 45
11See the BerkeleyDB documentation (L<http://www.oracle.com/technology/documentation/berkeley-db/db/index.html>). 46See the BerkeleyDB documentation (L<http://www.oracle.com/technology/documentation/berkeley-db/db/index.html>).
12The BDB API is very similar to the C API (the translation has been very faithful). 47The BDB API is very similar to the C API (the translation has been very faithful).
… …
72use strict 'vars'; 107use strict 'vars';
73 108
74use base 'Exporter'; 109use base 'Exporter';
75 110
76BEGIN { 111BEGIN {
77 our $VERSION = '1.2'; 112 our $VERSION = '1.4';
78 113
79 our @BDB_REQ = qw( 114 our @BDB_REQ = qw(
80 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect 115 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect
81 db_env_memp_sync db_env_memp_trickle 116 db_env_memp_sync db_env_memp_trickle
82 db_open db_close db_compact db_sync db_put db_get db_pget db_del db_key_range 117 db_open db_close db_compact db_sync db_upgrade
118 db_put db_get db_pget db_del db_key_range
83 db_txn_commit db_txn_abort db_txn_finish 119 db_txn_commit db_txn_abort db_txn_finish
84 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del 120 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del
85 db_sequence_open db_sequence_close 121 db_sequence_open db_sequence_close
86 db_sequence_get db_sequence_remove 122 db_sequence_get db_sequence_remove
87 ); 123 );
… …
99 135
100=head2 BERKELEYDB FUNCTIONS 136=head2 BERKELEYDB FUNCTIONS
101 137
102All of these are functions. The create functions simply return a new 138All of these are functions. The create functions simply return a new
103object and never block. All the remaining functions all take an optional 139object and never block. All the remaining functions all take an optional
104callback as last argument. If it is missing, then the fucntion will be 140callback as last argument. If it is missing, then the function will be
105executed synchronously. 141executed synchronously. In both cases, C<$!> will reflect the return value
142of the function.
106 143
107BDB functions that cannot block (mostly functions that manipulate 144BDB functions that cannot block (mostly functions that manipulate
108settings) are method calls on the relevant objects, so the rule of thumb 145settings) are method calls on the relevant objects, so the rule of thumb
109is: if its a method, its not blocking, if its a function, it takes a 146is: if its a method, its not blocking, if its a function, it takes a
110callback as last argument. 147callback as last argument.
… …
145 182
146 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 183 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
147 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 184 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
148 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 185 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
149 flags: DB_NOSYNC 186 flags: DB_NOSYNC
187 db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef)
150 db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef) 188 db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef)
151 flags: FREELIST_ONLY FREE_SPACE 189 flags: FREELIST_ONLY FREE_SPACE
152 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 190 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
153 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) 191 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
154 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 192 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
… …
242 $int = $env->set_lk_max_lockers (U32 max) 280 $int = $env->set_lk_max_lockers (U32 max)
243 $int = $env->set_lk_max_locks (U32 max) 281 $int = $env->set_lk_max_locks (U32 max)
244 $int = $env->set_lk_max_objects (U32 max) 282 $int = $env->set_lk_max_objects (U32 max)
245 $int = $env->set_lg_bsize (U32 max) 283 $int = $env->set_lg_bsize (U32 max)
246 $int = $env->set_lg_max (U32 max) 284 $int = $env->set_lg_max (U32 max)
285 $int = $env->mutex_set_increment (U32 increment)
286 $int = $env->mutex_set_tas_spins (U32 tas_spins)
287 $int = $env->mutex_set_max (U32 max)
288 $int = $env->mutex_set_align (U32 align)
247 289
248 $txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0) 290 $txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)
249 flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC 291 flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC
250 292
251=head4 Example: 293=head4 Example:
… …
387=head2 SUPPORT FUNCTIONS 429=head2 SUPPORT FUNCTIONS
388 430
389=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 431=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
390 432
391=over 4 433=over 4
434
435=item $msg = BDB::strerror [$errno]
436
437Returns the string corresponding to the given errno value. If no argument
438is given, use C<$!>.
392 439
393=item $fileno = BDB::poll_fileno 440=item $fileno = BDB::poll_fileno
394 441
395Return the I<request result pipe file descriptor>. This filehandle must be 442Return the I<request result pipe file descriptor>. This filehandle must be
396polled for reading by some mechanism outside this module (e.g. Event or 443polled for reading by some mechanism outside this module (e.g. Event or
… …
624 671
625In short: the parent will, after a short pause, continue as if fork had 672In short: the parent will, after a short pause, continue as if fork had
626not been called, while the child will act as if BDB has not been used 673not been called, while the child will act as if BDB has not been used
627yet. 674yet.
628 675
676Win32 note: there is no fork on win32, and perls emulation of it is too
677broken to be supported, so do not use BDB in a windows pseudo-fork, better
678yet, switch to a more capable platform.
679
629=head2 MEMORY USAGE 680=head2 MEMORY USAGE
630 681
631Per-request usage: 682Per-request usage:
632 683
633Each aio request uses - depending on your architecture - around 100-200 684Each aio request uses - depending on your architecture - around 100-200

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines