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

Comparing BDB/BDB.pm (file contents):
Revision 1.23 by root, Mon Dec 10 04:45:52 2007 UTC vs.
Revision 1.34 by root, Sun Mar 30 06:17:31 2008 UTC

… …
24 db_put $db, undef, "key", "data", 0, sub { 24 db_put $db, undef, "key", "data", 0, sub {
25 db_del $db, undef, "key"; 25 db_del $db, undef, "key";
26 }; 26 };
27 db_sync $db; 27 db_sync $db;
28 28
29 # when you also use Coro, management is easy:
30 use Coro::BDB;
31
29 # automatic result processing with AnyEvent: 32 # automatic result processing with AnyEvent:
30 our $FH; open $FH, "<&=" . BDB::poll_fileno; 33 our $FH; open $FH, "<&=" . BDB::poll_fileno;
31 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb); 34 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb);
32 35
33 # automatic result processing with EV: 36 # automatic result processing with EV:
… …
107use strict 'vars'; 110use strict 'vars';
108 111
109use base 'Exporter'; 112use base 'Exporter';
110 113
111BEGIN { 114BEGIN {
112 our $VERSION = '1.3'; 115 our $VERSION = '1.44';
113 116
114 our @BDB_REQ = qw( 117 our @BDB_REQ = qw(
115 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect 118 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect
116 db_env_memp_sync db_env_memp_trickle 119 db_env_memp_sync db_env_memp_trickle
117 db_open db_close db_compact db_sync db_put db_get db_pget db_del db_key_range 120 db_open db_close db_compact db_sync db_upgrade
121 db_put db_get db_pget db_del db_key_range
118 db_txn_commit db_txn_abort db_txn_finish 122 db_txn_commit db_txn_abort db_txn_finish
119 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del 123 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del
120 db_sequence_open db_sequence_close 124 db_sequence_open db_sequence_close
121 db_sequence_get db_sequence_remove 125 db_sequence_get db_sequence_remove
122 ); 126 );
… …
130 134
131 require XSLoader; 135 require XSLoader;
132 XSLoader::load ("BDB", $VERSION); 136 XSLoader::load ("BDB", $VERSION);
133} 137}
134 138
139=head2 FILENAMES/DATABASE NAMES
140
141The BDB expects "binary" filenames (octet strings) for pathnames on POSIX
142systems, and "unicode" filenames (strings with characters potentially
143>255) on Win32 (expecting a Unicode win32 build - win32 is a total mess).
144
135=head2 BERKELEYDB FUNCTIONS 145=head2 BERKELEYDB FUNCTIONS
136 146
137All of these are functions. The create functions simply return a new 147All of these are functions. The create functions simply return a new
138object and never block. All the remaining functions all take an optional 148object and never block. All the remaining functions take an optional
139callback as last argument that gets passed the return value. If it is 149callback as last argument. If it is missing, then the function will be
140missing, then the function will be executed synchronously, and the return 150executed synchronously. In both cases, C<$!> will reflect the return value
141value is returned as normally. 151of the function.
142 152
143BDB functions that cannot block (mostly functions that manipulate 153BDB functions that cannot block (mostly functions that manipulate
144settings) are method calls on the relevant objects, so the rule of thumb 154settings) are method calls on the relevant objects, so the rule of thumb
145is: if its a method, its not blocking, if its a function, it takes a 155is: if it's a method, it's not blocking, if it's a function, it takes a
146callback as last argument. 156callback as last argument.
147 157
148In the following, C<$int> signifies an integer return value, 158In the following, C<$int> signifies an integer return value,
149C<octetstring> is a "binary string" (i.e. a perl string with no character 159C<octetstring> is a "binary string" (i.e. a perl string with no character
150indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some 160indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some
… …
181 191
182 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 192 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
183 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 193 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
184 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 194 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
185 flags: DB_NOSYNC 195 flags: DB_NOSYNC
196 db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef)
186 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) 197 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)
187 flags: FREELIST_ONLY FREE_SPACE 198 flags: FREELIST_ONLY FREE_SPACE
188 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 199 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
189 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) 200 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
190 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 201 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
… …
386 DESTROY (DBC_ornull *dbc) 397 DESTROY (DBC_ornull *dbc)
387 CODE: 398 CODE:
388 if (dbc) 399 if (dbc)
389 dbc->c_close (dbc); 400 dbc->c_close (dbc);
390 401
402 $int = $cursor->set_priority ($priority = PRIORITY_*)
403
391=head4 Example: 404=head4 Example:
392 405
393 my $c = $db->cursor; 406 my $c = $db->cursor;
394 407
395 for (;;) { 408 for (;;) {
… …
432 445
433=item $msg = BDB::strerror [$errno] 446=item $msg = BDB::strerror [$errno]
434 447
435Returns the string corresponding to the given errno value. If no argument 448Returns the string corresponding to the given errno value. If no argument
436is given, use C<$!>. 449is given, use C<$!>.
450
451Note that the BDB module also patches the C<$!> variable directly, so you
452should be able to get a bdb error string by simply stringifying C<$!>.
437 453
438=item $fileno = BDB::poll_fileno 454=item $fileno = BDB::poll_fileno
439 455
440Return the I<request result pipe file descriptor>. This filehandle must be 456Return the I<request result pipe file descriptor>. This filehandle must be
441polled for reading by some mechanism outside this module (e.g. Event or 457polled for reading by some mechanism outside this module (e.g. Event or
… …
669 685
670In short: the parent will, after a short pause, continue as if fork had 686In short: the parent will, after a short pause, continue as if fork had
671not been called, while the child will act as if BDB has not been used 687not been called, while the child will act as if BDB has not been used
672yet. 688yet.
673 689
690Win32 note: there is no fork on win32, and perls emulation of it is too
691broken to be supported, so do not use BDB in a windows pseudo-fork, better
692yet, switch to a more capable platform.
693
674=head2 MEMORY USAGE 694=head2 MEMORY USAGE
675 695
676Per-request usage: 696Per-request usage:
677 697
678Each aio request uses - depending on your architecture - around 100-200 698Each aio request uses - depending on your architecture - around 100-200

Diff Legend

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