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

Comparing PApp-SQL/SQL.pm (file contents):
Revision 1.5 by root, Sat Jan 6 03:04:03 2001 UTC vs.
Revision 1.12 by root, Mon Feb 12 17:47:10 2001 UTC

… …
3PApp::SQL - absolutely easy yet fast and powerful sql access 3PApp::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
12This module provides you with easy-to-use functions to execute sql 28This module provides you with easy-to-use functions to execute sql
13commands (using DBI). Despite being easy to use, they are also quite 29commands (using DBI). Despite being easy to use, they are also quite
14efficient and allow you to write faster programs in less lines of code. 30efficient and allow you to write faster programs in less lines of code. It
31should work with anything from perl-5.004_01 onwards, but I only support
325.005+.
15 33
16=over 4 34If the descriptions here seem terse or if you always wanted to know
35what PApp is then have a look at the PApp module which uses this module
36extensively but also provides you with a lot more gimmicks to play around
37with to help you create cool applications ;)
17 38
18=cut 39=cut
19 40
20package PApp::SQL; 41package PApp::SQL;
21 42
22use DBI; 43use DBI ();
23
24#use PApp::Exception; # not yet used
25 44
26BEGIN { 45BEGIN {
27 use base Exporter; 46 use base qw(Exporter DynaLoader);
28 47
29 $VERSION = 0.11; 48 $VERSION = 0.121;
30 @EXPORT = qw( 49 @EXPORT = qw(
31 sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec 50 sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec
32 ); 51 );
33 @EXPORT_OK = qw( 52 @EXPORT_OK = qw(
34 connect_cached 53 connect_cached
35 ); 54 );
36 55
37 require XSLoader; 56 bootstrap PApp::SQL $VERSION;
38 XSLoader::load PApp::SQL, $VERSION;
39} 57}
40 58
41our $sql_exec; # last result of sql_exec's execute call 59our $sql_exec; # last result of sql_exec's execute call
42our $DBH; # the default database handle 60our $DBH; # the default database handle
43our $database; # the current SQL::Database object, if applicable 61our $Database; # the current SQL::Database object, if applicable
44 62
45our %dbcache; 63our %dbcache;
64
65=head2 GLOBAL VARIABLES
66
67=over 4
68
69=item $sql_exec
70
71Since the C<sql_exec> family of functions return a statement handle there
72must eb another way to test the return value of the C<execute> call. This
73global variable contains the result of the most recent call to C<execute>
74done by this module.
75
76=item $PApp::SQL::DBH
77
78The default database handle used by this module if no C<$DBH> was
79specified as argument and no C<$DBH> is found in the current package. See
80C<sql_exec> for a discussion.
81
82=item $PApp::SQL::Database
83
84The current default C<PApp::SQL::Database>-object. Future versions might
85automatically fall back on this database and create database handles from
86it if neccessary. At the moment this is not used by this module but might
87be nice as a placeholder for the database object that corresponds to
88$PApp::SQL::DBH.
89
90=back
91
92=head2 FUNCTIONS
93
94=over 4
46 95
47=item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect 96=item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect
48 97
49(not exported by by default) 98(not exported by by default)
50 99
51Connect to the database given by C<($dsn,$user,$pass)>, while using the 100Connect to the database given by C<($dsn,$user,$pass)>, while using the
52flags from C<$flags>. These are just the same arguments as given to 101flags from C<$flags>. These are just the same arguments as given to
53C<DBI->connect>. 102C<DBI->connect>.
54 103
55The database handle will be cached under the unique id C<$id>. If the same 104The database handle will be cached under the unique id
56id is requested later, the cached handle will be checked (using ping), and 105C<$id|$dsn|$user|$pass>. If the same id is requested later, the
106cached handle will be checked (using ping), and the connection will
57the connection will be re-established if necessary (be sure to prefix your 107be re-established if necessary (be sure to prefix your application or
58application or module name to the id to make it "more" unique. Things like 108module name to the id to make it "more" unique. Things like __PACKAGE__ .
59__PACKAGE__ . __LINE__ work fine as well). 109__LINE__ work fine as well).
110
111The reason C<$id> is necessary is that you might specify special connect
112arguments or special flags, or you might want to configure your $DBH
113differently than maybe other applications requesting the same database
114connection. If none of this is becessary for your application you can
115leave $id empty (i.e. "").
60 116
61If specified, C<$connect> is a callback (e.g. a coderef) that will be 117If specified, C<$connect> is a callback (e.g. a coderef) that will be
62called each time a new connection is being established, with the new 118called each time a new connection is being established, with the new
63C<$dbh> as first argument. 119C<$dbh> as first argument.
64 120
… …
188 244
189=cut 245=cut
190 246
191=item $lastid = sql_insertid $sth 247=item $lastid = sql_insertid $sth
192 248
193Returns the last automatically created key value (e.g. for mysql 249Returns the last automatically created key value. It must be executed
194AUTO_INCREMENT or sybase IDENTITY fields). It must be executed directly
195after executing the insert statement that created it. 250directly after executing the insert statement that created it. This is
251what is actually returned for various databases. If your database is
252missing, please send me an e-mail on how to implement this ;)
253
254 mysql: first C<AUTO_INCREMENT> column set to NULL
255 postgres: C<oid> column (is there a way to get the last SERIAL?)
256 sybase: C<IDENTITY> column of the last insert (slow)
257 informix: C<SERIAL> or C<SERIAL8> column of the last insert
258
259Except for sybase, this does not require a server access.
196 260
197=cut 261=cut
198 262
199sub sql_insertid($) { 263sub sql_insertid($) {
200 my $sth = shift or die "sql_insertid requires a statement handle"; 264 my $sth = shift or die "sql_insertid requires a statement handle";
201 my $dbh = $sth->{Database}; 265 my $dbh = $sth->{Database};
202 my $driver = $dbh->{Driver}{Name}; 266 my $driver = $dbh->{Driver}{Name};
203 267
204 $driver eq "mysql" and return $sth->{mysql_insertid}; 268 $driver eq "mysql" and return $sth->{mysql_insertid};
269 $driver eq "Pg" and return $sth->{pg_oid_status};
205 $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); 270 $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY');
206 $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; 271 $driver eq "Informix" and return $sth->{ix_sqlerrd}[1];
207 272
208 die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; 273 die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid";
209} 274}
210 275
… …
225 290
226=cut 291=cut
227 292
228=item reinitialize [not exported] 293=item reinitialize [not exported]
229 294
230Clears any internal caches (statement cache, database handle cache). 295Clears any internal caches (statement cache, database handle
296cache). Should be called after C<fork> and other accidents that invalidate
297database handles.
231 298
232=cut 299=cut
233 300
234sub reinitialize { 301sub reinitialize {
235 cachesize cachesize 0; 302 cachesize cachesize 0;
236 for (values %dbcache) { 303 for (values %dbcache) {
237 eval { $_->disconnect }; 304 eval { $_->{InactiveDestroy} = 1 };
238 } 305 }
239 undef %dbcache; 306 undef %dbcache;
240} 307}
241 308
242=back 309=back
243 310
244=cut 311=cut
312
313reinitialize;
245 314
246package PApp::SQL::Database; 315package PApp::SQL::Database;
247 316
248=head2 THE DATABASE CLASS 317=head2 THE DATABASE CLASS
249 318
… …
301 370
302=cut 371=cut
303 372
304sub dsn($) { 373sub dsn($) {
305 my $self = shift; 374 my $self = shift;
306 $self->[1][1]; 375 (split /\x00/, $self->[0])[1];
307} 376}
308 377
309=back 378=back
310 379
311=cut 380=cut
312 381
313reinitialize;
314
3151; 3821;
316
317=head1 BUGS
318
319As of this writing, sql_fetch and sql_fetchall are not very well tested
320(they were just re-written in C).
321
322sql_exists could be faster (it is written very ugly to not change the
323current package).
324 383
325=head1 SEE ALSO 384=head1 SEE ALSO
326 385
327L<PApp>. 386L<PApp>.
328 387

Diff Legend

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