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

Comparing BDB/BDB.pm (file contents):
Revision 1.21 by root, Fri Dec 7 13:38:52 2007 UTC vs.
Revision 1.35 by root, Sun Mar 30 08:01:58 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.45';
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 WIN32 FILENAMES/DATABASE NAME MESS
140
141Perl on Win32 supports only ASCII filenames (the reason is that it abuses
142an internal flag to store wether a filename is Unicode or ANSI, but that
143flag is used for somethign else in the perl core, so there is no way to
144detect wether a filename is ANSI or Unicode-encoded). The BDB module
145tries to work around this issue by assuming that the filename is an ANSI
146filename and BDB was built for unicode support.
147
135=head2 BERKELEYDB FUNCTIONS 148=head2 BERKELEYDB FUNCTIONS
136 149
137All of these are functions. The create functions simply return a new 150All of these are functions. The create functions simply return a new
138object and never block. All the remaining functions all take an optional 151object and never block. All the remaining functions take an optional
139callback as last argument. If it is missing, then the fucntion will be 152callback as last argument. If it is missing, then the function will be
140executed synchronously. 153executed synchronously. In both cases, C<$!> will reflect the return value
154of the function.
141 155
142BDB functions that cannot block (mostly functions that manipulate 156BDB functions that cannot block (mostly functions that manipulate
143settings) are method calls on the relevant objects, so the rule of thumb 157settings) are method calls on the relevant objects, so the rule of thumb
144is: if its a method, its not blocking, if its a function, it takes a 158is: if it's a method, it's not blocking, if it's a function, it takes a
145callback as last argument. 159callback as last argument.
146 160
147In the following, C<$int> signifies an integer return value, 161In the following, C<$int> signifies an integer return value,
148C<octetstring> is a "binary string" (i.e. a perl string with no character 162C<octetstring> is a "binary string" (i.e. a perl string with no character
149indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some 163indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some
180 194
181 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 195 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
182 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 196 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
183 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 197 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
184 flags: DB_NOSYNC 198 flags: DB_NOSYNC
199 db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef)
185 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) 200 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)
186 flags: FREELIST_ONLY FREE_SPACE 201 flags: FREELIST_ONLY FREE_SPACE
187 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 202 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
188 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) 203 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
189 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 204 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
385 DESTROY (DBC_ornull *dbc) 400 DESTROY (DBC_ornull *dbc)
386 CODE: 401 CODE:
387 if (dbc) 402 if (dbc)
388 dbc->c_close (dbc); 403 dbc->c_close (dbc);
389 404
405 $int = $cursor->set_priority ($priority = PRIORITY_*)
406
390=head4 Example: 407=head4 Example:
391 408
392 my $c = $db->cursor; 409 my $c = $db->cursor;
393 410
394 for (;;) { 411 for (;;) {
426=head2 SUPPORT FUNCTIONS 443=head2 SUPPORT FUNCTIONS
427 444
428=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 445=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
429 446
430=over 4 447=over 4
448
449=item $msg = BDB::strerror [$errno]
450
451Returns the string corresponding to the given errno value. If no argument
452is given, use C<$!>.
453
454Note that the BDB module also patches the C<$!> variable directly, so you
455should be able to get a bdb error string by simply stringifying C<$!>.
431 456
432=item $fileno = BDB::poll_fileno 457=item $fileno = BDB::poll_fileno
433 458
434Return the I<request result pipe file descriptor>. This filehandle must be 459Return the I<request result pipe file descriptor>. This filehandle must be
435polled for reading by some mechanism outside this module (e.g. Event or 460polled for reading by some mechanism outside this module (e.g. Event or
663 688
664In short: the parent will, after a short pause, continue as if fork had 689In short: the parent will, after a short pause, continue as if fork had
665not been called, while the child will act as if BDB has not been used 690not been called, while the child will act as if BDB has not been used
666yet. 691yet.
667 692
693Win32 note: there is no fork on win32, and perls emulation of it is too
694broken to be supported, so do not use BDB in a windows pseudo-fork, better
695yet, switch to a more capable platform.
696
668=head2 MEMORY USAGE 697=head2 MEMORY USAGE
669 698
670Per-request usage: 699Per-request usage:
671 700
672Each aio request uses - depending on your architecture - around 100-200 701Each aio request uses - depending on your architecture - around 100-200

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines