[ViewVC] Diff of: cvs/BDB/BDB.pm

Comparing BDB/BDB.pm (file contents):
Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs.
Revision 1.41 by root, Wed Jul 9 12:15:36 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:
…		…
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.2';	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_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
		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
135	=head2 BERKELEYDB FUNCTIONS	147	=head2 BERKELEYDB FUNCTIONS
136		148
137	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
138	object and never block. All the remaining functions all take an optional	150	object and never block. All the remaining functions take an optional
139	callback as last argument. If it is missing, then the fucntion will be	151	callback as last argument. If it is missing, then the function will be
140	executed synchronously.	152	executed synchronously. In both cases, C<$!> will reflect the return value
		153	of the function.
141		154
142	BDB functions that cannot block (mostly functions that manipulate	155	BDB functions that cannot block (mostly functions that manipulate
143	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
144	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
145	callback as last argument.	158	callback as last argument.
146		159
147	In the following, C<$int> signifies an integer return value,	160	In the following, C<$int> signifies an integer return value,
148	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),
149	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
150	integer, C<NV> is a floating point value.	163	floating point value.
151		164
152	The C<SV *> types are generic perl scalars (for input and output of data	165	Most C<SV *> types are generic perl scalars (for input and output of data
153	values), and the C<SV *callback> is the optional callback function to call	166	values).
154	when the request is completed.
155		167
156	The various C<DB_ENV> etc. arguments are handles return by	168	The various C<DB_ENV> etc. arguments are handles return by
157	C<db_env_create>, C<db_create>, C<txn_begin> and so on. If they have an	169	C<db_env_create>, C<db_create>, C<txn_begin> and so on. If they have an
158	appended C<_ornull> this means they are optional and you can pass C<undef>	170	appended C<_ornull> this means they are optional and you can pass C<undef>
159	for them, resulting a NULL pointer on the C level.	171	for them, resulting a NULL pointer on the C level.
160		172
		173	The C<SV *callback> is the optional callback function to call when the
		174	request is completed. This last callback argument is special: the callback
		175	is simply the last argument passed. If there are "optional" arguments
		176	before the callback they can be left out. The callback itself can be left
		177	out or specified as C<undef>, in which case the function will be executed
		178	synchronously.
		179
		180	For example, C<db_env_txn_checkpoint> usually is called with all integer
		181	arguments zero. These can be left out, so all of these specify a call
		182	to C<< DB_ENV->txn_checkpoint >>, to be executed asynchronously with a
		183	callback to be called:
		184
		185	db_env_txn_checkpoint $db_env, 0, 0, 0, sub { };
		186	db_env_txn_checkpoint $db_env, 0, 0, sub { };
		187	db_env_txn_checkpoint $db_env, sub { };
		188
		189	While these all specify a call to C<< DB_ENV->txn_checkpoint >> to be
		190	executed synchronously:
		191
		192	db_env_txn_checkpoint $db_env, 0, 0, 0, undef;
		193	db_env_txn_checkpoint $db_env, 0, 0, 0;
		194	db_env_txn_checkpoint $db_env, 0;
		195
161	=head3 BDB functions	196	=head3 BDB functions
162		197
163	Functions in the BDB namespace, exported by default:	198	Functions in the BDB namespace, exported by default:
164		199
165	$env = db_env_create (U32 env_flags = 0)	200	$env = db_env_create (U32 env_flags = 0)
166	flags: RPCCLIENT	201	flags: RPCCLIENT
167		202
168	db_env_open (DB_ENV env, octetstring db_home, U32 open_flags, int mode, SV callback = &PL_sv_undef)	203	db_env_open (DB_ENV env, bdb_filename db_home, U32 open_flags, int mode, SV callback = &PL_sv_undef)
169	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	204	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
170	db_env_close (DB_ENV env, U32 flags = 0, SV callback = &PL_sv_undef)	205	db_env_close (DB_ENV env, U32 flags = 0, SV callback = &PL_sv_undef)
171	db_env_txn_checkpoint (DB_ENV env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV callback = &PL_sv_undef)	206	db_env_txn_checkpoint (DB_ENV env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV callback = &PL_sv_undef)
172	flags: FORCE	207	flags: FORCE
173	db_env_lock_detect (DB_ENV env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV dummy = 0, SV *callback = &PL_sv_undef)	208	db_env_lock_detect (DB_ENV env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV dummy = 0, SV *callback = &PL_sv_undef)
174	atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST	209	atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST
175	db_env_memp_sync (DB_ENV env, SV dummy = 0, SV *callback = &PL_sv_undef)	210	db_env_memp_sync (DB_ENV env, SV dummy = 0, SV *callback = &PL_sv_undef)
176	db_env_memp_trickle (DB_ENV env, int percent, SV dummy = 0, SV *callback = &PL_sv_undef)	211	db_env_memp_trickle (DB_ENV env, int percent, SV dummy = 0, SV *callback = &PL_sv_undef)
		212	db_env_dbremove (DB_ENV env, DB_TXN_ornull txnid, bdb_filename file, bdb_filename database, U32 flags = 0, SV *callback = &PL_sv_undef)
		213	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)
177		214
178	$db = db_create (DB_ENV *env = 0, U32 flags = 0)	215	$db = db_create (DB_ENV *env = 0, U32 flags = 0)
179	flags: XA_CREATE	216	flags: XA_CREATE
180		217
181	db_open (DB db, DB_TXN_ornull txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)	218	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)
182	flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE	219	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)	220	db_close (DB db, U32 flags = 0, SV callback = &PL_sv_undef)
184	flags: DB_NOSYNC	221	flags: DB_NOSYNC
		222	db_upgrade (DB db, bdb_filename 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)	223	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	224	flags: FREELIST_ONLY FREE_SPACE
187	db_sync (DB db, U32 flags = 0, SV callback = &PL_sv_undef)	225	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)	226	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)	227	db_put (DB db, DB_TXN_ornull txn, SV key, SV data, U32 flags = 0, SV *callback = &PL_sv_undef)
…		…
262	$int = $env->set_data_dir (const char *dir)	300	$int = $env->set_data_dir (const char *dir)
263	$int = $env->set_tmp_dir (const char *dir)	301	$int = $env->set_tmp_dir (const char *dir)
264	$int = $env->set_lg_dir (const char *dir)	302	$int = $env->set_lg_dir (const char *dir)
265	$int = $env->set_shm_key (long shm_key)	303	$int = $env->set_shm_key (long shm_key)
266	$int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0)	304	$int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0)
267	$int = $env->set_flags (U32 flags, int onoff)	305	$int = $env->set_flags (U32 flags, int onoff = 1)
		306	$int = $env->log_set_config (U32 flags, int onoff = 1) [v4.7]
		307	$int = $env->set_intermediate_dir_mode (const char *modestring) [v4.7]
268	$env->set_errfile (FILE *errfile = 0)	308	$env->set_errfile (FILE *errfile = 0)
269	$env->set_msgfile (FILE *msgfile = 0)	309	$env->set_msgfile (FILE *msgfile = 0)
270	$int = $env->set_verbose (U32 which, int onoff = 1)	310	$int = $env->set_verbose (U32 which, int onoff = 1)
271	$int = $env->set_encrypt (const char *password, U32 flags = 0)	311	$int = $env->set_encrypt (const char *password, U32 flags = 0)
272	$int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT)	312	$int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT)
…		…
277	$int = $env->set_lk_max_lockers (U32 max)	317	$int = $env->set_lk_max_lockers (U32 max)
278	$int = $env->set_lk_max_locks (U32 max)	318	$int = $env->set_lk_max_locks (U32 max)
279	$int = $env->set_lk_max_objects (U32 max)	319	$int = $env->set_lk_max_objects (U32 max)
280	$int = $env->set_lg_bsize (U32 max)	320	$int = $env->set_lg_bsize (U32 max)
281	$int = $env->set_lg_max (U32 max)	321	$int = $env->set_lg_max (U32 max)
		322	$int = $env->mutex_set_increment (U32 increment)
		323	$int = $env->mutex_set_tas_spins (U32 tas_spins)
		324	$int = $env->mutex_set_max (U32 max)
		325	$int = $env->mutex_set_align (U32 align)
282		326
283	$txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)	327	$txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)
284	flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC	328	flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC
285		329
286	=head4 Example:	330	=head4 Example:
…		…
381	DESTROY (DBC_ornull *dbc)	425	DESTROY (DBC_ornull *dbc)
382	CODE:	426	CODE:
383	if (dbc)	427	if (dbc)
384	dbc->c_close (dbc);	428	dbc->c_close (dbc);
385		429
		430	$int = $cursor->set_priority ($priority = PRIORITY_*)
		431
386	=head4 Example:	432	=head4 Example:
387		433
388	my $c = $db->cursor;	434	my $c = $db->cursor;
389		435
390	for (;;) {	436	for (;;) {
…		…
423		469
424	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	470	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
425		471
426	=over 4	472	=over 4
427		473
		474	=item $msg = BDB::strerror [$errno]
		475
		476	Returns the string corresponding to the given errno value. If no argument
		477	is given, use C<$!>.
		478
		479	Note that the BDB module also patches the C<$!> variable directly, so you
		480	should be able to get a bdb error string by simply stringifying C<$!>.
		481
428	=item $fileno = BDB::poll_fileno	482	=item $fileno = BDB::poll_fileno
429		483
430	Return the I<request result pipe file descriptor>. This filehandle must be	484	Return the I<request result pipe file descriptor>. This filehandle must be
431	polled for reading by some mechanism outside this module (e.g. Event or	485	polled for reading by some mechanism outside this module (e.g. Event or
432	select, see below or the SYNOPSIS). If the pipe becomes readable you have	486	select, see below or the SYNOPSIS). If the pipe becomes readable you have
…		…
508	BDB::poll_wait, BDB::poll_cb	562	BDB::poll_wait, BDB::poll_cb
509	while BDB::nreqs;	563	while BDB::nreqs;
510		564
511	=back	565	=back
512		566
		567	=head3 VERSION CHECKING
		568
		569	BerkeleyDB comes in various versions, many of them have minor
		570	incompatibilities. This means that traditional "at least version x.x"
		571	checks are often not sufficient.
		572
		573	Example: set the log_autoremove option in a way compatible with <v.47 and
		574	v4.7. Note the use of & on the constants to avoid triggering a compiletime
		575	bug when the symbol isn't available.
		576
		577	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		578	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		579
		580	=over 4
		581
		582	=item BDB::VERSION
		583
		584	The C<BDB::VERSION> function, when called without arguments, returns the
		585	Berkeley DB version as a v-string (usually with 3 components). You should
		586	use C<lt> and C<ge> operators exclusively to make comparisons.
		587
		588	Example: check for at least version 4.7.
		589
		590	BDB::VERSION ge v4.7 or die;
		591
		592	=item BDB::VERSION min-version
		593
		594	Returns true if the BDB version is at least the given version (specified
		595	as a v-string), false otherwise.
		596
		597	Example: check for at least version 4.5.
		598
		599	BDB::VERSION v4.7 or die;
		600
		601	=item BDB::VERSION min-version, max-version
		602
		603	Returns true of the BDB version is at least version C<min-version> (specify C<undef> or C<v0> for any minimum version)
		604	and less then C<max-version>.
		605
		606	Example: check wether version is strictly less then v4.7.
		607
		608	BDB::VERSION v0, v4.7
		609	or die "version 4.7 is not yet supported";
		610
		611	=back
		612
		613	=cut
		614
		615	sub VERSION {
		616	if (@_ > 0) {
		617	return undef if VERSION_v lt $_[0];
		618	if (@_ > 1) {
		619	return undef if VERSION_v ge $_[1];
		620	}
		621	}
		622
		623	VERSION_v
		624	}
		625
513	=head3 CONTROLLING THE NUMBER OF THREADS	626	=head3 CONTROLLING THE NUMBER OF THREADS
514		627
515	=over 4	628	=over 4
516		629
517	=item BDB::min_parallel $nthreads	630	=item BDB::min_parallel $nthreads
…		…
583		696
584	=item BDB::set_sync_prepare $cb	697	=item BDB::set_sync_prepare $cb
585		698
586	Sets a callback that is called whenever a request is created without an	699	Sets a callback that is called whenever a request is created without an
587	explicit callback. It has to return two code references. The first is used	700	explicit callback. It has to return two code references. The first is used
588	as the request callback, and the second is called to wait until the first	701	as the request callback (it should save the return status), and the second
		702	is called to wait until the first callback has been called (it must set
		703	C<$!> to the return status).
		704
		705	This mechanism can be used to include BDB into other event mechanisms,
		706	such as L<AnyEvent::BDB> or L<Coro::BDB>.
		707
589	callback has been called. The default implementation works like this:	708	The default implementation works like this:
590		709
591	sub {	710	sub {
592	my $status;	711	my $status;
593	(	712	(
594	sub { $status = $! },	713	sub { $status = $! },
595	sub { BDB::poll while !defined $status; $! = $status },	714	sub { BDB::poll while !defined $status; $! = $status },
596	)	715	)
597	}	716	}
		717
		718	It simply blocks the process till the request has finished and then sets
		719	C<$!> to the return value. This means that if you don't use a callback,
		720	BDB will simply fall back to synchronous operations.
598		721
599	=back	722	=back
600		723
601	=head3 STATISTICAL INFORMATION	724	=head3 STATISTICAL INFORMATION
602		725
…		…
659		782
660	In short: the parent will, after a short pause, continue as if fork had	783	In short: the parent will, after a short pause, continue as if fork had
661	not been called, while the child will act as if BDB has not been used	784	not been called, while the child will act as if BDB has not been used
662	yet.	785	yet.
663		786
		787	Win32 note: there is no fork on win32, and perls emulation of it is too
		788	broken to be supported, so do not use BDB in a windows pseudo-fork, better
		789	yet, switch to a more capable platform.
		790
664	=head2 MEMORY USAGE	791	=head2 MEMORY USAGE
665		792
666	Per-request usage:	793	Per-request usage:
667		794
668	Each aio request uses - depending on your architecture - around 100-200	795	Each aio request uses - depending on your architecture - around 100-200
…		…
689	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,	816	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
690	above.	817	above.
691		818
692	=head1 SEE ALSO	819	=head1 SEE ALSO
693		820
694	L<Coro::BDB>, L<IO::AIO>.	821	L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
		822	syntax), L<IO::AIO> (nice to have).
695		823
696	=head1 AUTHOR	824	=head1 AUTHOR
697		825
698	Marc Lehmann <schmorp@schmorp.de>	826	Marc Lehmann <schmorp@schmorp.de>
699	http://home.schmorp.de/	827	http://home.schmorp.de/

Diff Legend

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

Comparing BDB/BDB.pm (file contents): Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs. Revision 1.41 by root, Wed Jul 9 12:15:36 2008 UTC

Diff Legend

Comparing BDB/BDB.pm (file contents):
Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs.
Revision 1.41 by root, Wed Jul 9 12:15:36 2008 UTC