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

Comparing BDB/BDB.pm (file contents):
Revision 1.22 by root, Mon Dec 10 03:57:27 2007 UTC vs.
Revision 1.36 by root, Sat May 10 20:23:06 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 # automatic result processing with AnyEvent: 29 # when you also use Coro, management is easy:
30 our $FH; open $FH, "<&=" . BDB::poll_fileno; 30 use Coro::BDB;
31 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb); 31
32 # automatic event loop intergration with AnyEvent:
33 use AnyEvent::BDB;
32 34
33 # automatic result processing with EV: 35 # automatic result processing with EV:
34 my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb; 36 my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb;
35 37
36 # with Glib: 38 # with Glib:
107use strict 'vars'; 109use strict 'vars';
108 110
109use base 'Exporter'; 111use base 'Exporter';
110 112
111BEGIN { 113BEGIN {
112 our $VERSION = '1.3'; 114 our $VERSION = '1.5';
113 115
114 our @BDB_REQ = qw( 116 our @BDB_REQ = qw(
115 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect 117 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect
116 db_env_memp_sync db_env_memp_trickle 118 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 119 db_open db_close db_compact db_sync db_upgrade
120 db_put db_get db_pget db_del db_key_range
118 db_txn_commit db_txn_abort db_txn_finish 121 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 122 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 123 db_sequence_open db_sequence_close
121 db_sequence_get db_sequence_remove 124 db_sequence_get db_sequence_remove
122 ); 125 );
130 133
131 require XSLoader; 134 require XSLoader;
132 XSLoader::load ("BDB", $VERSION); 135 XSLoader::load ("BDB", $VERSION);
133} 136}
134 137
138=head2 WIN32 FILENAMES/DATABASE NAME MESS
139
140Perl on Win32 supports only ASCII filenames (the reason is that it abuses
141an internal flag to store wether a filename is Unicode or ANSI, but that
142flag is used for somethign else in the perl core, so there is no way to
143detect wether a filename is ANSI or Unicode-encoded). The BDB module
144tries to work around this issue by assuming that the filename is an ANSI
145filename and BDB was built for unicode support.
146
135=head2 BERKELEYDB FUNCTIONS 147=head2 BERKELEYDB FUNCTIONS
136 148
137All of these are functions. The create functions simply return a new 149All of these are functions. The create functions simply return a new
138object and never block. All the remaining functions all take an optional 150object and never block. All the remaining functions take an optional
139callback as last argument that gets passed the return value. If it is 151callback as last argument. If it is missing, then the function will be
140missing, then the function will be executed synchronously, and the return 152executed synchronously. In both cases, C<$!> will reflect the return value
141value is returned as normally. 153of the function.
142 154
143BDB functions that cannot block (mostly functions that manipulate 155BDB functions that cannot block (mostly functions that manipulate
144settings) are method calls on the relevant objects, so the rule of thumb 156settings) 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 157is: if it's a method, it's not blocking, if it's a function, it takes a
146callback as last argument. 158callback as last argument.
147 159
148In the following, C<$int> signifies an integer return value, 160In the following, C<$int> signifies an integer return value,
149C<octetstring> is a "binary string" (i.e. a perl string with no character 161C<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 162indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some
181 193
182 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 194 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 195 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) 196 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
185 flags: DB_NOSYNC 197 flags: DB_NOSYNC
198 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) 199 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 200 flags: FREELIST_ONLY FREE_SPACE
188 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 201 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) 202 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) 203 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) 399 DESTROY (DBC_ornull *dbc)
387 CODE: 400 CODE:
388 if (dbc) 401 if (dbc)
389 dbc->c_close (dbc); 402 dbc->c_close (dbc);
390 403
404 $int = $cursor->set_priority ($priority = PRIORITY_*)
405
391=head4 Example: 406=head4 Example:
392 407
393 my $c = $db->cursor; 408 my $c = $db->cursor;
394 409
395 for (;;) { 410 for (;;) {
427=head2 SUPPORT FUNCTIONS 442=head2 SUPPORT FUNCTIONS
428 443
429=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 444=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
430 445
431=over 4 446=over 4
447
448=item $msg = BDB::strerror [$errno]
449
450Returns the string corresponding to the given errno value. If no argument
451is given, use C<$!>.
452
453Note that the BDB module also patches the C<$!> variable directly, so you
454should be able to get a bdb error string by simply stringifying C<$!>.
432 455
433=item $fileno = BDB::poll_fileno 456=item $fileno = BDB::poll_fileno
434 457
435Return the I<request result pipe file descriptor>. This filehandle must be 458Return the I<request result pipe file descriptor>. This filehandle must be
436polled for reading by some mechanism outside this module (e.g. Event or 459polled for reading by some mechanism outside this module (e.g. Event or
664 687
665In short: the parent will, after a short pause, continue as if fork had 688In short: the parent will, after a short pause, continue as if fork had
666not been called, while the child will act as if BDB has not been used 689not been called, while the child will act as if BDB has not been used
667yet. 690yet.
668 691
692Win32 note: there is no fork on win32, and perls emulation of it is too
693broken to be supported, so do not use BDB in a windows pseudo-fork, better
694yet, switch to a more capable platform.
695
669=head2 MEMORY USAGE 696=head2 MEMORY USAGE
670 697
671Per-request usage: 698Per-request usage:
672 699
673Each aio request uses - depending on your architecture - around 100-200 700Each aio request uses - depending on your architecture - around 100-200
694 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>, 721 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
695 above. 722 above.
696 723
697=head1 SEE ALSO 724=head1 SEE ALSO
698 725
699L<Coro::BDB>, L<IO::AIO>. 726L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
727syntax), L<IO::AIO> (nice to have).
700 728
701=head1 AUTHOR 729=head1 AUTHOR
702 730
703 Marc Lehmann <schmorp@schmorp.de> 731 Marc Lehmann <schmorp@schmorp.de>
704 http://home.schmorp.de/ 732 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines