[ViewVC] Diff of: cvs/PApp-SQL/SQL.pm

Comparing PApp-SQL/SQL.pm (file contents):
Revision 1.7 by root, Mon Jan 15 00:19:55 2001 UTC vs.
Revision 1.15 by root, Sun Apr 22 14:38:27 2001 UTC

…		…
3	PApp::SQL - absolutely easy yet fast and powerful sql access	3	PApp::SQL - absolutely easy yet fast and powerful sql access
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use PApp::SQL;	7	use PApp::SQL;
8	# to be written	8
		9	my $st = sql_exec $DBH, "select ... where a = ?", $a;
		10
		11	local $DBH = <database handle>;
		12	my $st = sql_exec \my($bind_a, $bind_b), "select a,b ...";
		13	my $st = sql_insertid
		14	sql_exec "insert into ... values (?, ?)", $v1, $v2;
		15	my $a = sql_fetch "select a from ...";
		16	sql_fetch \my($a, $b), "select a,b ...";
		17
		18	sql_exists "name from table where name like 'a%'"
		19	or die "a* required but not existent";
		20
		21	my $db = new PApp::SQL::Database "", "DBI:mysql:test", "user", "pass";
		22	local $PApp::SQL::DBH = $db->checked_dbh; # does 'ping'
		23
		24	sql_exec $db->dbh, "select ...";
9		25
10	=head1 DESCRIPTION	26	=head1 DESCRIPTION
11		27
12	This module provides you with easy-to-use functions to execute sql	28	This module provides you with easy-to-use functions to execute sql
13	commands (using DBI). Despite being easy to use, they are also quite	29	commands (using DBI). Despite being easy to use, they are also quite
14	efficient and allow you to write faster programs in less lines of code.	30	efficient and allow you to write faster programs in less lines of code. It
		31	should work with anything from perl-5.004_01 onwards, but I only support
		32	5.005+. UTF8 handling (the C<sql_u*> family of functions) will only be
		33	effective with perl version 5.006 and beyond.
15		34
16	=over 4	35	If the descriptions here seem terse or if you always wanted to know
		36	what PApp is then have a look at the PApp module which uses this module
		37	extensively but also provides you with a lot more gimmicks to play around
		38	with to help you create cool applications ;)
17		39
18	=cut	40	=cut
19		41
20	package PApp::SQL;	42	package PApp::SQL;
21		43
22	use DBI;	44	use DBI ();
23
24	#use PApp::Exception; # not yet used
25		45
26	BEGIN {	46	BEGIN {
27	use base Exporter;	47	use base qw(Exporter DynaLoader);
28		48
29	$VERSION = 0.11;	49	$VERSION = 0.123;
30	@EXPORT = qw(	50	@EXPORT = qw(
31	sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec	51	sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec
		52	sql_ufetch sql_ufetchall sql_uexists
32	);	53	);
33	@EXPORT_OK = qw(	54	@EXPORT_OK = qw(
34	connect_cached	55	connect_cached
35	);	56	);
36		57
37	require XSLoader;	58	bootstrap PApp::SQL $VERSION;
38	XSLoader::load PApp::SQL, $VERSION;
39	}	59	}
40		60
41	our $sql_exec; # last result of sql_exec's execute call	61	our $sql_exec; # last result of sql_exec's execute call
42	our $DBH; # the default database handle	62	our $DBH; # the default database handle
43	our $database; # the current SQL::Database object, if applicable	63	our $Database; # the current SQL::Database object, if applicable
44		64
45	our %dbcache;	65	our %dbcache;
		66
		67	=head2 GLOBAL VARIABLES
		68
		69	=over 4
		70
		71	=item $sql_exec
		72
		73	Since the C<sql_exec> family of functions return a statement handle there
		74	must eb another way to test the return value of the C<execute> call. This
		75	global variable contains the result of the most recent call to C<execute>
		76	done by this module.
		77
		78	=item $PApp::SQL::DBH
		79
		80	The default database handle used by this module if no C<$DBH> was
		81	specified as argument and no C<$DBH> is found in the current package. See
		82	C<sql_exec> for a discussion.
		83
		84	=item $PApp::SQL::Database
		85
		86	The current default C<PApp::SQL::Database>-object. Future versions might
		87	automatically fall back on this database and create database handles from
		88	it if neccessary. At the moment this is not used by this module but might
		89	be nice as a placeholder for the database object that corresponds to
		90	$PApp::SQL::DBH.
		91
		92	=back
		93
		94	=head2 FUNCTIONS
		95
		96	=over 4
46		97
47	=item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect	98	=item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect
48		99
49	(not exported by by default)	100	(not exported by by default)
50		101
…		…
94	$dbcache{$id};	145	$dbcache{$id};
95	}	146	}
96		147
97	=item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...]	148	=item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...]
98		149
		150	=item $sth = sql_uexec <see sql_exec>
		151
99	C<sql_exec> is the most important and most-used function in this module.	152	C<sql_exec> is the most important and most-used function in this module.
100		153
101	Runs the given sql command with the given parameters and returns the	154	Runs the given sql command with the given parameters and returns the
102	statement handle. The command and the statement handle will be cached	155	statement handle. The command and the statement handle will be cached
103	(with the database handle and the sql string as key), so prepare will be	156	(with the database handle and the sql string as key), so prepare will be
…		…
114	The actual return value from the C<$sth->execute> call is stored in the	167	The actual return value from the C<$sth->execute> call is stored in the
115	package-global (and exported) variable C<$sql_exec>.	168	package-global (and exported) variable C<$sql_exec>.
116		169
117	If any error occurs C<sql_exec> will throw an exception.	170	If any error occurs C<sql_exec> will throw an exception.
118		171
		172	C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to
		173	utf8 before calling the C<execute> method.
		174
119	Examples:	175	Examples:
120		176
121	# easy one	177	# easy one
122	my $st = sql_exec "select name, id from table where id = ?", $id;	178	my $st = sql_exec "select name, id from table where id = ?", $id;
123	while (my ($name, $id) = $st->fetchrow_array) { ... };	179	while (my ($name, $id) = $st->fetchrow_array) { ... };
…		…
132	sql_exec $dbh, "update file set name = ?", "oops.txt";	188	sql_exec $dbh, "update file set name = ?", "oops.txt";
133		189
134		190
135	=item sql_fetch <see sql_exec>	191	=item sql_fetch <see sql_exec>
136		192
		193	=item sql_ufetch <see sql_uexec>
		194
137	Execute a sql-statement and fetch the first row of results. Depending on	195	Execute an sql-statement and fetch the first row of results. Depending on
138	the caller context the row will be returned as a list (array context), or	196	the caller context the row will be returned as a list (array context), or
139	just the first columns. In table form:	197	just the first columns. In table form:
140		198
141	CONTEXT RESULT	199	CONTEXT RESULT
142	void ()	200	void ()
…		…
153		211
154	my($name, $amount) = sql_fetch "select ...", args...	212	my($name, $amount) = sql_fetch "select ...", args...
155		213
156	... and it's still quite fast unless you fetch large amounts of data.	214	... and it's still quite fast unless you fetch large amounts of data.
157		215
		216	C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to
		217	utf8 and forces all result values to utf8.
		218
158	=item sql_fetchall <see sql_exec>	219	=item sql_fetchall <see sql_exec>
		220
		221	=item sql_ufetchall <see sql_uexec>
159		222
160	Similarly to C<sql_fetch>, but all result rows will be fetched (this is	223	Similarly to C<sql_fetch>, but all result rows will be fetched (this is
161	of course inefficient for large results!). The context is ignored (only	224	of course inefficient for large results!). The context is ignored (only
162	list context makes sense), but the result still depends on the number of	225	list context makes sense), but the result still depends on the number of
163	columns in the result:	226	columns in the result:
…		…
175		238
176	for (sql_fetchall "select name, age, place from user") {	239	for (sql_fetchall "select name, age, place from user") {
177	my ($name, $age, $place) = @$_;	240	my ($name, $age, $place) = @$_;
178	}	241	}
179		242
		243	C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input
		244	values to utf8 and forces all result values to utf8.
		245
180	=item sql_exists "<table> where ...", args...	246	=item sql_exists "<table> where ...", args...
		247
		248	=item sql_uexists <see sql_exists>
181		249
182	Check wether the result of the sql-statement "select xxx from	250	Check wether the result of the sql-statement "select xxx from
183	$first_argument" would be empty or not (that is, imagine the string	251	$first_argument" would be empty or not (that is, imagine the string
184	"select from" were prepended to your statement (it isn't)). Should work	252	"select * from" were prepended to your statement (it isn't)). Should work
185	with every database but can be quite slow, except on mysql, where this	253	with every database but can be quite slow, except on mysql, where this
186	should be quite fast.	254	should be quite fast.
		255
		256	C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to
		257	utf8.
187		258
188	Examples:	259	Examples:
189		260
190	print "user 7 exists!\n"	261	print "user 7 exists!\n"
191	if sql_exists "user where id = ?", 7;	262	if sql_exists "user where id = ?", 7;
…		…
195		266
196	=cut	267	=cut
197		268
198	=item $lastid = sql_insertid $sth	269	=item $lastid = sql_insertid $sth
199		270
200	Returns the last automatically created key value (e.g. for mysql	271	Returns the last automatically created key value. It must be executed
201	AUTO_INCREMENT or sybase IDENTITY fields). It must be executed directly
202	after executing the insert statement that created it.	272	directly after executing the insert statement that created it. This is
		273	what is actually returned for various databases. If your database is
		274	missing, please send me an e-mail on how to implement this ;)
		275
		276	mysql: first C<AUTO_INCREMENT> column set to NULL
		277	postgres: C<oid> column (is there a way to get the last SERIAL?)
		278	sybase: C<IDENTITY> column of the last insert (slow)
		279	informix: C<SERIAL> or C<SERIAL8> column of the last insert
		280
		281	Except for sybase, this does not require a server access.
203		282
204	=cut	283	=cut
205		284
206	sub sql_insertid($) {	285	sub sql_insertid($) {
207	my $sth = shift or die "sql_insertid requires a statement handle";	286	my $sth = shift or die "sql_insertid requires a statement handle";
208	my $dbh = $sth->{Database};	287	my $dbh = $sth->{Database};
209	my $driver = $dbh->{Driver}{Name};	288	my $driver = $dbh->{Driver}{Name};
210		289
211	$driver eq "mysql" and return $sth->{mysql_insertid};	290	$driver eq "mysql" and return $sth->{mysql_insertid};
		291	$driver eq "Pg" and return $sth->{pg_oid_status};
212	$driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY');	292	$driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY');
213	$driver eq "Informix" and return $sth->{ix_sqlerrd}[1];	293	$driver eq "Informix" and return $sth->{ix_sqlerrd}[1];
214		294
215	die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid";	295	die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid";
216	}	296	}
217		297
…		…
232		312
233	=cut	313	=cut
234		314
235	=item reinitialize [not exported]	315	=item reinitialize [not exported]
236		316
237	Clears any internal caches (statement cache, database handle cache).	317	Clears any internal caches (statement cache, database handle
		318	cache). Should be called after C<fork> and other accidents that invalidate
		319	database handles.
238		320
239	=cut	321	=cut
240		322
241	sub reinitialize {	323	sub reinitialize {
242	cachesize cachesize 0;	324	cachesize cachesize 0;
243	for (values %dbcache) {	325	for (values %dbcache) {
244	eval { $_->disconnect };	326	eval { $_->{InactiveDestroy} = 1 };
245	}	327	}
246	undef %dbcache;	328	undef %dbcache;
247	}	329	}
248		330
249	=back	331	=back
…		…
254		336
255	package PApp::SQL::Database;	337	package PApp::SQL::Database;
256		338
257	=head2 THE DATABASE CLASS	339	=head2 THE DATABASE CLASS
258		340
259	Again (sigh) the problem of persistency. What do you do when you have to serialize on object	341	Again (sigh) the problem of persistency. What do you do when you have
260	that contains (or should contain) a database handle? Short answer: you don't. Long answer:	342	to serialize on object that contains (or should contain) a database
		343	handle? Short answer: you don't. Long answer: you can embed the necessary
261	you can embed the necessary information to recreate the dbh when needed.	344	information to recreate the dbh when needed.
262		345
263	The C<PApp::SQL::Database> class does that, in a relatively efficient	346	The C<PApp::SQL::Database> class does that, in a relatively efficient
264	fashion: the overhead is currently a single method call per access (you	347	fashion: the overhead is currently a single method call per access (you
265	can cache the real dbh if you want).	348	can cache the real dbh if you want).
266		349
…		…
306		389
307	=item $db->dsn	390	=item $db->dsn
308		391
309	Return the DSN (L<DBI>) fo the database object (e.g. for error messages).	392	Return the DSN (L<DBI>) fo the database object (e.g. for error messages).
310		393
		394	=item $db->login
		395
		396	Return the login name.
		397
		398	=item $db->password
		399
		400	Return the password (emphasizing the fact that the apssword is stored plaintext ;)
		401
311	=cut	402	=cut
312		403
313	sub dsn($) {	404	sub dsn($) {
314	my $self = shift;	405	my $self = shift;
315	$self->[1][1];	406	(split /\x00/, $self->[0])[1];
		407	}
		408
		409	sub login($) {
		410	my $self = shift;
		411	(split /\x00/, $self->[0])[2];
		412	}
		413
		414	sub password($) {
		415	my $self = shift;
		416	(split /\x00/, $self->[0])[3];
316	}	417	}
317		418
318	=back	419	=back
319		420
320	=cut	421	=cut
321		422
322	1;	423	1;
323
324	=head1 BUGS
325
326	As of this writing, sql_fetch and sql_fetchall are not very well tested
327	(they were just re-written in C).
328
329	sql_exists could be faster (it is written very ugly to not change the
330	current package).
331		424
332	=head1 SEE ALSO	425	=head1 SEE ALSO
333		426
334	L<PApp>.	427	L<PApp>.
335		428

Diff Legend

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

Comparing PApp-SQL/SQL.pm (file contents): Revision 1.7 by root, Mon Jan 15 00:19:55 2001 UTC vs. Revision 1.15 by root, Sun Apr 22 14:38:27 2001 UTC

Diff Legend

Comparing PApp-SQL/SQL.pm (file contents):
Revision 1.7 by root, Mon Jan 15 00:19:55 2001 UTC vs.
Revision 1.15 by root, Sun Apr 22 14:38:27 2001 UTC