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

Comparing BDB/BDB.pm (file contents):
Revision 1.34 by root, Sun Mar 30 06:17:31 2008 UTC vs.
Revision 1.38 by root, Mon Jul 7 22:11:04 2008 UTC

… …
27 db_sync $db; 27 db_sync $db;
28 28
29 # when you also use Coro, management is easy: 29 # when you also use Coro, management is easy:
30 use Coro::BDB; 30 use Coro::BDB;
31 31
32 # automatic result processing with AnyEvent: 32 # automatic event loop intergration with AnyEvent:
33 our $FH; open $FH, "<&=" . BDB::poll_fileno; 33 use AnyEvent::BDB;
34 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb);
35 34
36 # automatic result processing with EV: 35 # automatic result processing with EV:
37 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;
38 37
39 # with Glib: 38 # with Glib:
… …
110use strict 'vars'; 109use strict 'vars';
111 110
112use base 'Exporter'; 111use base 'Exporter';
113 112
114BEGIN { 113BEGIN {
115 our $VERSION = '1.44'; 114 our $VERSION = '1.5';
116 115
117 our @BDB_REQ = qw( 116 our @BDB_REQ = qw(
118 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
119 db_env_memp_sync db_env_memp_trickle 118 db_env_memp_sync db_env_memp_trickle db_env_dbrename db_env_dbremove
120 db_open db_close db_compact db_sync db_upgrade 119 db_open db_close db_compact db_sync db_upgrade
121 db_put db_get db_pget db_del db_key_range 120 db_put db_get db_pget db_del db_key_range
122 db_txn_commit db_txn_abort db_txn_finish 121 db_txn_commit db_txn_abort db_txn_finish
123 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
124 db_sequence_open db_sequence_close 123 db_sequence_open db_sequence_close
… …
134 133
135 require XSLoader; 134 require XSLoader;
136 XSLoader::load ("BDB", $VERSION); 135 XSLoader::load ("BDB", $VERSION);
137} 136}
138 137
139=head2 FILENAMES/DATABASE NAMES 138=head2 WIN32 FILENAMES/DATABASE NAME MESS
140 139
141The BDB expects "binary" filenames (octet strings) for pathnames on POSIX 140Perl on Win32 supports only ASCII filenames (the reason is that it abuses
142systems, and "unicode" filenames (strings with characters potentially 141an internal flag to store wether a filename is Unicode or ANSI, but that
143>255) on Win32 (expecting a Unicode win32 build - win32 is a total mess). 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.
144 146
145=head2 BERKELEYDB FUNCTIONS 147=head2 BERKELEYDB FUNCTIONS
146 148
147All of these are functions. The create functions simply return a new 149All of these are functions. The create functions simply return a new
148object and never block. All the remaining functions take an optional 150object and never block. All the remaining functions take an optional
… …
154settings) 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
155is: if it's a method, it's not blocking, if it's a function, it takes a 157is: if it's a method, it's not blocking, if it's a function, it takes a
156callback as last argument. 158callback as last argument.
157 159
158In the following, C<$int> signifies an integer return value, 160In the following, C<$int> signifies an integer return value,
159C<octetstring> is a "binary string" (i.e. a perl string with no character 161C<bdb_filename> is a "filename" (octets on unix, madness on windows),
160indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some 162C<U32> is an unsigned 32 bit integer, C<int> is some integer, C<NV> is a
161integer, C<NV> is a floating point value. 163floating point value.
162 164
163The C<SV *> types are generic perl scalars (for input and output of data 165The C<SV *> types are generic perl scalars (for input and output of data
164values), and the C<SV *callback> is the optional callback function to call 166values), and the C<SV *callback> is the optional callback function to call
165when the request is completed. 167when the request is completed.
166 168
… …
174Functions in the BDB namespace, exported by default: 176Functions in the BDB namespace, exported by default:
175 177
176 $env = db_env_create (U32 env_flags = 0) 178 $env = db_env_create (U32 env_flags = 0)
177 flags: RPCCLIENT 179 flags: RPCCLIENT
178 180
179 db_env_open (DB_ENV *env, octetstring db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef) 181 db_env_open (DB_ENV *env, bdb_filename db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef)
180 open_flags: INIT_CDB INIT_LOCK INIT_LOG INIT_MPOOL INIT_REP INIT_TXN RECOVER RECOVER_FATAL USE_ENVIRON USE_ENVIRON_ROOT CREATE LOCKDOWN PRIVATE REGISTER SYSTEM_MEM 182 open_flags: INIT_CDB INIT_LOCK INIT_LOG INIT_MPOOL INIT_REP INIT_TXN RECOVER RECOVER_FATAL USE_ENVIRON USE_ENVIRON_ROOT CREATE LOCKDOWN PRIVATE REGISTER SYSTEM_MEM
181 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef) 183 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef)
182 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef) 184 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef)
183 flags: FORCE 185 flags: FORCE
184 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef) 186 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef)
185 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST 187 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST
186 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef) 188 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef)
187 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef) 189 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef)
190 db_env_dbremove (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, U32 flags = 0, SV *callback = &PL_sv_undef)
191 db_env_dbrename (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, bdb_filename newname, U32 flags = 0, SV *callback = &PL_sv_undef)
188 192
189 $db = db_create (DB_ENV *env = 0, U32 flags = 0) 193 $db = db_create (DB_ENV *env = 0, U32 flags = 0)
190 flags: XA_CREATE 194 flags: XA_CREATE
191 195
192 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 196 db_open (DB *db, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
193 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 197 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
194 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 198 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
195 flags: DB_NOSYNC 199 flags: DB_NOSYNC
196 db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef) 200 db_upgrade (DB *db, bdb_filename file, U32 flags = 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) 201 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)
198 flags: FREELIST_ONLY FREE_SPACE 202 flags: FREELIST_ONLY FREE_SPACE
199 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 203 db_sync (DB *db, 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) 204 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, 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) 205 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
… …
609 613
610=item BDB::set_sync_prepare $cb 614=item BDB::set_sync_prepare $cb
611 615
612Sets a callback that is called whenever a request is created without an 616Sets a callback that is called whenever a request is created without an
613explicit callback. It has to return two code references. The first is used 617explicit callback. It has to return two code references. The first is used
614as the request callback, and the second is called to wait until the first 618as the request callback (it should save the return status), and the second
619is called to wait until the first callback has been called (it must set
620C<$!> to the return status).
621
622This mechanism can be used to include BDB into other event mechanisms,
623such as L<AnyEvent::BDB> or L<Coro::BDB>.
624
615callback has been called. The default implementation works like this: 625The default implementation works like this:
616 626
617 sub { 627 sub {
618 my $status; 628 my $status;
619 ( 629 (
620 sub { $status = $! }, 630 sub { $status = $! },
621 sub { BDB::poll while !defined $status; $! = $status }, 631 sub { BDB::poll while !defined $status; $! = $status },
622 ) 632 )
623 } 633 }
634
635It simply blocks the process till the request has finished and then sets
636C<$!> to the return value. This means that if you don't use a callback,
637BDB will simply fall back to synchronous operations.
624 638
625=back 639=back
626 640
627=head3 STATISTICAL INFORMATION 641=head3 STATISTICAL INFORMATION
628 642
… …
719 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>, 733 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
720 above. 734 above.
721 735
722=head1 SEE ALSO 736=head1 SEE ALSO
723 737
724L<Coro::BDB>, L<IO::AIO>. 738L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
739syntax), L<IO::AIO> (nice to have).
725 740
726=head1 AUTHOR 741=head1 AUTHOR
727 742
728 Marc Lehmann <schmorp@schmorp.de> 743 Marc Lehmann <schmorp@schmorp.de>
729 http://home.schmorp.de/ 744 http://home.schmorp.de/

Diff Legend

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