… | |
… | |
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: |
… | |
… | |
107 | use strict 'vars'; |
109 | use strict 'vars'; |
108 | |
110 | |
109 | use base 'Exporter'; |
111 | use base 'Exporter'; |
110 | |
112 | |
111 | BEGIN { |
113 | BEGIN { |
112 | our $VERSION = '1.3'; |
114 | our $VERSION = '1.6'; |
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 db_env_dbrename db_env_dbremove |
117 | db_open db_close db_compact db_sync db_upgrade |
119 | db_open db_close db_compact db_sync db_upgrade |
118 | db_put db_get db_pget db_del db_key_range |
120 | db_put db_get db_pget db_del db_key_range |
119 | db_txn_commit db_txn_abort db_txn_finish |
121 | db_txn_commit db_txn_abort db_txn_finish |
120 | 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 |
121 | db_sequence_open db_sequence_close |
123 | db_sequence_open db_sequence_close |
… | |
… | |
131 | |
133 | |
132 | require XSLoader; |
134 | require XSLoader; |
133 | XSLoader::load ("BDB", $VERSION); |
135 | XSLoader::load ("BDB", $VERSION); |
134 | } |
136 | } |
135 | |
137 | |
|
|
138 | =head2 WIN32 FILENAMES/DATABASE NAME MESS |
|
|
139 | |
|
|
140 | Perl on Win32 supports only ASCII filenames (the reason is that it abuses |
|
|
141 | an internal flag to store wether a filename is Unicode or ANSI, but that |
|
|
142 | flag is used for somethign else in the perl core, so there is no way to |
|
|
143 | detect wether a filename is ANSI or Unicode-encoded). The BDB module |
|
|
144 | tries to work around this issue by assuming that the filename is an ANSI |
|
|
145 | filename and BDB was built for unicode support. |
|
|
146 | |
136 | =head2 BERKELEYDB FUNCTIONS |
147 | =head2 BERKELEYDB FUNCTIONS |
137 | |
148 | |
138 | All of these are functions. The create functions simply return a new |
149 | All of these are functions. The create functions simply return a new |
139 | object and never block. All the remaining functions all take an optional |
150 | object and never block. All the remaining functions take an optional |
140 | callback as last argument. If it is missing, then the function will be |
151 | callback as last argument. If it is missing, then the function will be |
141 | executed synchronously. In both cases, C<$!> will reflect the return value |
152 | executed synchronously. In both cases, C<$!> will reflect the return value |
142 | of the function. |
153 | of the function. |
143 | |
154 | |
144 | BDB functions that cannot block (mostly functions that manipulate |
155 | BDB functions that cannot block (mostly functions that manipulate |
145 | settings) are method calls on the relevant objects, so the rule of thumb |
156 | settings) are method calls on the relevant objects, so the rule of thumb |
146 | is: if its a method, its not blocking, if its a function, it takes a |
157 | is: if it's a method, it's not blocking, if it's a function, it takes a |
147 | callback as last argument. |
158 | callback as last argument. |
148 | |
159 | |
149 | In the following, C<$int> signifies an integer return value, |
160 | In the following, C<$int> signifies an integer return value, |
150 | C<octetstring> is a "binary string" (i.e. a perl string with no character |
161 | C<bdb_filename> is a "filename" (octets on unix, madness on windows), |
151 | indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some |
162 | C<U32> is an unsigned 32 bit integer, C<int> is some integer, C<NV> is a |
152 | integer, C<NV> is a floating point value. |
163 | floating point value. |
153 | |
164 | |
154 | The C<SV *> types are generic perl scalars (for input and output of data |
165 | The C<SV *> types are generic perl scalars (for input and output of data |
155 | values), and the C<SV *callback> is the optional callback function to call |
166 | values), and the C<SV *callback> is the optional callback function to call |
156 | when the request is completed. |
167 | when the request is completed. |
157 | |
168 | |
… | |
… | |
165 | Functions in the BDB namespace, exported by default: |
176 | Functions in the BDB namespace, exported by default: |
166 | |
177 | |
167 | $env = db_env_create (U32 env_flags = 0) |
178 | $env = db_env_create (U32 env_flags = 0) |
168 | flags: RPCCLIENT |
179 | flags: RPCCLIENT |
169 | |
180 | |
170 | 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) |
171 | 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 |
172 | 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) |
173 | 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) |
174 | flags: FORCE |
185 | flags: FORCE |
175 | 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) |
176 | 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 |
177 | 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) |
178 | 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) |
179 | |
192 | |
180 | $db = db_create (DB_ENV *env = 0, U32 flags = 0) |
193 | $db = db_create (DB_ENV *env = 0, U32 flags = 0) |
181 | flags: XA_CREATE |
194 | flags: XA_CREATE |
182 | |
195 | |
183 | 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) |
184 | 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 |
185 | 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) |
186 | flags: DB_NOSYNC |
199 | flags: DB_NOSYNC |
187 | 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) |
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) |
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) |
189 | flags: FREELIST_ONLY FREE_SPACE |
202 | flags: FREELIST_ONLY FREE_SPACE |
190 | 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) |
191 | 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) |
192 | 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) |
… | |
… | |
265 | $int = $env->set_data_dir (const char *dir) |
278 | $int = $env->set_data_dir (const char *dir) |
266 | $int = $env->set_tmp_dir (const char *dir) |
279 | $int = $env->set_tmp_dir (const char *dir) |
267 | $int = $env->set_lg_dir (const char *dir) |
280 | $int = $env->set_lg_dir (const char *dir) |
268 | $int = $env->set_shm_key (long shm_key) |
281 | $int = $env->set_shm_key (long shm_key) |
269 | $int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0) |
282 | $int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0) |
270 | $int = $env->set_flags (U32 flags, int onoff) |
283 | $int = $env->set_flags (U32 flags, int onoff = 1) |
|
|
284 | $int = $env->log_set_config (U32 flags, int onoff = 1) [v4.7] |
|
|
285 | $int = $env->set_intermediate_dir_mode (const char *modestring) [v4.7] |
271 | $env->set_errfile (FILE *errfile = 0) |
286 | $env->set_errfile (FILE *errfile = 0) |
272 | $env->set_msgfile (FILE *msgfile = 0) |
287 | $env->set_msgfile (FILE *msgfile = 0) |
273 | $int = $env->set_verbose (U32 which, int onoff = 1) |
288 | $int = $env->set_verbose (U32 which, int onoff = 1) |
274 | $int = $env->set_encrypt (const char *password, U32 flags = 0) |
289 | $int = $env->set_encrypt (const char *password, U32 flags = 0) |
275 | $int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT) |
290 | $int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT) |
… | |
… | |
388 | DESTROY (DBC_ornull *dbc) |
403 | DESTROY (DBC_ornull *dbc) |
389 | CODE: |
404 | CODE: |
390 | if (dbc) |
405 | if (dbc) |
391 | dbc->c_close (dbc); |
406 | dbc->c_close (dbc); |
392 | |
407 | |
|
|
408 | $int = $cursor->set_priority ($priority = PRIORITY_*) |
|
|
409 | |
393 | =head4 Example: |
410 | =head4 Example: |
394 | |
411 | |
395 | my $c = $db->cursor; |
412 | my $c = $db->cursor; |
396 | |
413 | |
397 | for (;;) { |
414 | for (;;) { |
… | |
… | |
435 | =item $msg = BDB::strerror [$errno] |
452 | =item $msg = BDB::strerror [$errno] |
436 | |
453 | |
437 | Returns the string corresponding to the given errno value. If no argument |
454 | Returns the string corresponding to the given errno value. If no argument |
438 | is given, use C<$!>. |
455 | is given, use C<$!>. |
439 | |
456 | |
|
|
457 | Note that the BDB module also patches the C<$!> variable directly, so you |
|
|
458 | should be able to get a bdb error string by simply stringifying C<$!>. |
|
|
459 | |
440 | =item $fileno = BDB::poll_fileno |
460 | =item $fileno = BDB::poll_fileno |
441 | |
461 | |
442 | Return the I<request result pipe file descriptor>. This filehandle must be |
462 | Return the I<request result pipe file descriptor>. This filehandle must be |
443 | polled for reading by some mechanism outside this module (e.g. Event or |
463 | polled for reading by some mechanism outside this module (e.g. Event or |
444 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
464 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
… | |
… | |
520 | BDB::poll_wait, BDB::poll_cb |
540 | BDB::poll_wait, BDB::poll_cb |
521 | while BDB::nreqs; |
541 | while BDB::nreqs; |
522 | |
542 | |
523 | =back |
543 | =back |
524 | |
544 | |
|
|
545 | =head3 VERSION CHECKING |
|
|
546 | |
|
|
547 | BerkeleyDB comes in various versions, many of them have minor |
|
|
548 | incompatibilities. This means that traditional "at least version x.x" |
|
|
549 | checks are often not sufficient. |
|
|
550 | |
|
|
551 | Example: set the log_autoremove option in a way compatible with <v.47 and |
|
|
552 | v4.7. Note the use of & on the constants to avoid triggering a compiletime |
|
|
553 | bug when the symbol isn't available. |
|
|
554 | |
|
|
555 | $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7; |
|
|
556 | $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7; |
|
|
557 | |
|
|
558 | =over 4 |
|
|
559 | |
|
|
560 | =item BDB::VERSION |
|
|
561 | |
|
|
562 | The C<BDB::VERSION> function, when called without arguments, returns the |
|
|
563 | Berkeley DB version as a v-string (usually with 3 components). You should |
|
|
564 | use C<lt> and C<ge> operators exclusively to make comparisons. |
|
|
565 | |
|
|
566 | Example: check for at least version 4.7. |
|
|
567 | |
|
|
568 | BDB::VERSION ge v4.7 or die; |
|
|
569 | |
|
|
570 | =item BDB::VERSION min-version |
|
|
571 | |
|
|
572 | Returns true if the BDB version is at least the given version (specified |
|
|
573 | as a v-string), false otherwise. |
|
|
574 | |
|
|
575 | Example: check for at least version 4.5. |
|
|
576 | |
|
|
577 | BDB::VERSION v4.7 or die; |
|
|
578 | |
|
|
579 | =item BDB::VERSION min-version, max-version |
|
|
580 | |
|
|
581 | Returns true of the BDB version is at least version C<min-version> (specify C<undef> or C<v0> for any minimum version) |
|
|
582 | and less then C<max-version>. |
|
|
583 | |
|
|
584 | Example: check wether version is strictly less then v4.7. |
|
|
585 | |
|
|
586 | BDB::VERSION v0, v4.7 |
|
|
587 | or die "version 4.7 is not yet supported"; |
|
|
588 | |
|
|
589 | =back |
|
|
590 | |
|
|
591 | =cut |
|
|
592 | |
|
|
593 | sub VERSION { |
|
|
594 | if (@_ > 0) { |
|
|
595 | return undef if VERSION_v lt $_[0]; |
|
|
596 | if (@_ > 1) { |
|
|
597 | return undef if VERSION_v ge $_[1]; |
|
|
598 | } |
|
|
599 | } |
|
|
600 | |
|
|
601 | VERSION_v |
|
|
602 | } |
|
|
603 | |
525 | =head3 CONTROLLING THE NUMBER OF THREADS |
604 | =head3 CONTROLLING THE NUMBER OF THREADS |
526 | |
605 | |
527 | =over 4 |
606 | =over 4 |
528 | |
607 | |
529 | =item BDB::min_parallel $nthreads |
608 | =item BDB::min_parallel $nthreads |
… | |
… | |
595 | |
674 | |
596 | =item BDB::set_sync_prepare $cb |
675 | =item BDB::set_sync_prepare $cb |
597 | |
676 | |
598 | Sets a callback that is called whenever a request is created without an |
677 | Sets a callback that is called whenever a request is created without an |
599 | explicit callback. It has to return two code references. The first is used |
678 | explicit callback. It has to return two code references. The first is used |
600 | as the request callback, and the second is called to wait until the first |
679 | as the request callback (it should save the return status), and the second |
|
|
680 | is called to wait until the first callback has been called (it must set |
|
|
681 | C<$!> to the return status). |
|
|
682 | |
|
|
683 | This mechanism can be used to include BDB into other event mechanisms, |
|
|
684 | such as L<AnyEvent::BDB> or L<Coro::BDB>. |
|
|
685 | |
601 | callback has been called. The default implementation works like this: |
686 | The default implementation works like this: |
602 | |
687 | |
603 | sub { |
688 | sub { |
604 | my $status; |
689 | my $status; |
605 | ( |
690 | ( |
606 | sub { $status = $! }, |
691 | sub { $status = $! }, |
607 | sub { BDB::poll while !defined $status; $! = $status }, |
692 | sub { BDB::poll while !defined $status; $! = $status }, |
608 | ) |
693 | ) |
609 | } |
694 | } |
|
|
695 | |
|
|
696 | It simply blocks the process till the request has finished and then sets |
|
|
697 | C<$!> to the return value. This means that if you don't use a callback, |
|
|
698 | BDB will simply fall back to synchronous operations. |
610 | |
699 | |
611 | =back |
700 | =back |
612 | |
701 | |
613 | =head3 STATISTICAL INFORMATION |
702 | =head3 STATISTICAL INFORMATION |
614 | |
703 | |
… | |
… | |
671 | |
760 | |
672 | In short: the parent will, after a short pause, continue as if fork had |
761 | In short: the parent will, after a short pause, continue as if fork had |
673 | not been called, while the child will act as if BDB has not been used |
762 | not been called, while the child will act as if BDB has not been used |
674 | yet. |
763 | yet. |
675 | |
764 | |
|
|
765 | Win32 note: there is no fork on win32, and perls emulation of it is too |
|
|
766 | broken to be supported, so do not use BDB in a windows pseudo-fork, better |
|
|
767 | yet, switch to a more capable platform. |
|
|
768 | |
676 | =head2 MEMORY USAGE |
769 | =head2 MEMORY USAGE |
677 | |
770 | |
678 | Per-request usage: |
771 | Per-request usage: |
679 | |
772 | |
680 | Each aio request uses - depending on your architecture - around 100-200 |
773 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
701 | TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>, |
794 | TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>, |
702 | above. |
795 | above. |
703 | |
796 | |
704 | =head1 SEE ALSO |
797 | =head1 SEE ALSO |
705 | |
798 | |
706 | L<Coro::BDB>, L<IO::AIO>. |
799 | L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural |
|
|
800 | syntax), L<IO::AIO> (nice to have). |
707 | |
801 | |
708 | =head1 AUTHOR |
802 | =head1 AUTHOR |
709 | |
803 | |
710 | Marc Lehmann <schmorp@schmorp.de> |
804 | Marc Lehmann <schmorp@schmorp.de> |
711 | http://home.schmorp.de/ |
805 | http://home.schmorp.de/ |