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.11 by root, Sat Feb 10 01:28:26 2001 UTC vs.
Revision 1.20 by root, Tue Feb 26 03:17:52 2002 UTC

1=head1 NAME 1=head1 NAME
2 2
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 8
13 my $st = sql_insertid 13 my $st = sql_insertid
14 sql_exec "insert into ... values (?, ?)", $v1, $v2; 14 sql_exec "insert into ... values (?, ?)", $v1, $v2;
15 my $a = sql_fetch "select a from ..."; 15 my $a = sql_fetch "select a from ...";
16 sql_fetch \my($a, $b), "select a,b ..."; 16 sql_fetch \my($a, $b), "select a,b ...";
17 17
18 sql_exists "name from table where name like 'a%'" 18 sql_exists "table where name like 'a%'"
19 or die "a* required but not existent"; 19 or die "a* required but not existent";
20 20
21 my $db = new PApp::SQL::Database "", "DBI:mysql:test", "user", "pass"; 21 my $db = new PApp::SQL::Database "", "DBI:mysql:test", "user", "pass";
22 local $PApp::SQL::DBH = $db->checked_dbh; # does 'ping' 22 local $PApp::SQL::DBH = $db->checked_dbh; # does 'ping'
23 23
27 27
28This module provides you with easy-to-use functions to execute sql 28This module provides you with easy-to-use functions to execute sql
29commands (using DBI). Despite being easy to use, they are also quite 29commands (using DBI). Despite being easy to use, they are also quite
30efficient and allow you to write faster programs in less lines of code. It 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 31should work with anything from perl-5.004_01 onwards, but I only support
325.005+. 325.005+. UTF8 handling (the C<sql_u*> family of functions) will only be
33effective with perl version 5.006 and beyond.
33 34
34If the descriptions here seem terse or if you always wanted to know 35If 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 36what 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 37extensively but also provides you with a lot more gimmicks to play around
37with to help you create cool applications ;) 38with to help you create cool applications ;)
43use DBI (); 44use DBI ();
44 45
45BEGIN { 46BEGIN {
46 use base qw(Exporter DynaLoader); 47 use base qw(Exporter DynaLoader);
47 48
48 $VERSION = 0.12; 49 $VERSION = 0.1242;
49 @EXPORT = qw( 50 @EXPORT = qw(
50 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_uexec sql_ufetch sql_ufetchall sql_uexists
51 ); 53 );
52 @EXPORT_OK = qw( 54 @EXPORT_OK = qw(
53 connect_cached 55 connect_cached
54 ); 56 );
55 57
121Examples: 123Examples:
122 124
123 # try your luck opening the papp database without access info 125 # try your luck opening the papp database without access info
124 $dbh = connect_cached __FILE__, "DBI:mysql:papp"; 126 $dbh = connect_cached __FILE__, "DBI:mysql:papp";
125 127
128Mysql-specific behaviour: The default setting of
129C<mysql_client_found_rows> is TRUE, you can overwrite this, though.
130
126=cut 131=cut
127 132
128sub connect_cached { 133sub connect_cached {
129 my ($id, $dsn, $user, $pass, $flags, $connect) = @_; 134 my ($id, $dsn, $user, $pass, $flags, $connect) = @_;
130 # the following line is duplicated in PApp::SQL::Database::new 135 # the following line is duplicated in PApp::SQL::Database::new
131 $id = "$id\0$dsn\0$user\0$pass"; 136 $id = "$id\0$dsn\0$user\0$pass";
132 unless ($dbcache{$id} && $dbcache{$id}->ping) { 137 unless ($dbcache{$id} && $dbcache{$id}->ping) {
133 #warn "connecting to ($dsn|$user|$pass|$flags)\n";#d#
134 # first, nuke our statement cache (sooory ;) 138 # first, nuke our statement cache (sooory ;)
135 cachesize cachesize 0; 139 cachesize cachesize 0;
140
141 # then make mysql behave more standardly by default
142 $dsn =~ /^[Dd][Bb][Ii]:mysql:/
143 and $dsn !~ /;mysql_client_found_rows/
144 and $dsn .= ";mysql_client_found_rows=1";
145
136 # then connect anew 146 # then connect anew
137 $dbcache{$id} = 147 $dbcache{$id} =
138 eval { DBI->connect($dsn, $user, $pass, $flags) } 148 eval { DBI->connect($dsn, $user, $pass, $flags) }
139 || eval { DBI->connect($dsn, $user, $pass, $flags) } 149 || eval { DBI->connect($dsn, $user, $pass, $flags) }
140 || die "unable to connect to database $dsn: $DBI::errstr\n"; 150 || die "unable to connect to database $dsn: $DBI::errstr\n";
143 $dbcache{$id}; 153 $dbcache{$id};
144} 154}
145 155
146=item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...] 156=item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...]
147 157
158=item $sth = sql_uexec <see sql_exec>
159
148C<sql_exec> is the most important and most-used function in this module. 160C<sql_exec> is the most important and most-used function in this module.
149 161
150Runs the given sql command with the given parameters and returns the 162Runs the given sql command with the given parameters and returns the
151statement handle. The command and the statement handle will be cached 163statement handle. The command and the statement handle will be cached
152(with the database handle and the sql string as key), so prepare will be 164(with the database handle and the sql string as key), so prepare will be
163The actual return value from the C<$sth->execute> call is stored in the 175The actual return value from the C<$sth->execute> call is stored in the
164package-global (and exported) variable C<$sql_exec>. 176package-global (and exported) variable C<$sql_exec>.
165 177
166If any error occurs C<sql_exec> will throw an exception. 178If any error occurs C<sql_exec> will throw an exception.
167 179
180C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to
181utf8 before calling the C<execute> method.
182
168Examples: 183Examples:
169 184
170 # easy one 185 # easy one
171 my $st = sql_exec "select name, id from table where id = ?", $id; 186 my $st = sql_exec "select name, id from table where id = ?", $id;
172 while (my ($name, $id) = $st->fetchrow_array) { ... }; 187 while (my ($name, $id) = $st->fetchrow_array) { ... };
181 sql_exec $dbh, "update file set name = ?", "oops.txt"; 196 sql_exec $dbh, "update file set name = ?", "oops.txt";
182 197
183 198
184=item sql_fetch <see sql_exec> 199=item sql_fetch <see sql_exec>
185 200
201=item sql_ufetch <see sql_uexec>
202
186Execute a sql-statement and fetch the first row of results. Depending on 203Execute an sql-statement and fetch the first row of results. Depending on
187the caller context the row will be returned as a list (array context), or 204the caller context the row will be returned as a list (array context), or
188just the first columns. In table form: 205just the first columns. In table form:
189 206
190 CONTEXT RESULT 207 CONTEXT RESULT
191 void () 208 void ()
202 219
203 my($name, $amount) = sql_fetch "select ...", args... 220 my($name, $amount) = sql_fetch "select ...", args...
204 221
205... and it's still quite fast unless you fetch large amounts of data. 222... and it's still quite fast unless you fetch large amounts of data.
206 223
224C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to
225utf8 and forces all result values to utf8.
226
207=item sql_fetchall <see sql_exec> 227=item sql_fetchall <see sql_exec>
228
229=item sql_ufetchall <see sql_uexec>
208 230
209Similarly to C<sql_fetch>, but all result rows will be fetched (this is 231Similarly to C<sql_fetch>, but all result rows will be fetched (this is
210of course inefficient for large results!). The context is ignored (only 232of course inefficient for large results!). The context is ignored (only
211list context makes sense), but the result still depends on the number of 233list context makes sense), but the result still depends on the number of
212columns in the result: 234columns in the result:
224 246
225 for (sql_fetchall "select name, age, place from user") { 247 for (sql_fetchall "select name, age, place from user") {
226 my ($name, $age, $place) = @$_; 248 my ($name, $age, $place) = @$_;
227 } 249 }
228 250
251C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input
252values to utf8 and forces all result values to utf8.
253
229=item sql_exists "<table> where ...", args... 254=item sql_exists "<table_references> where <where_condition>...", args...
255
256=item sql_uexists <see sql_exists>
230 257
231Check wether the result of the sql-statement "select xxx from 258Check wether the result of the sql-statement "select xxx from
232$first_argument" would be empty or not (that is, imagine the string 259$first_argument" would be empty or not (that is, imagine the string
233"select from" were prepended to your statement (it isn't)). Should work 260"select * from" were prepended to your statement (it isn't)). Should work
234with every database but can be quite slow, except on mysql, where this 261with every database but can be quite slow, except on mysql, where this
235should be quite fast. 262should be quite fast.
263
264C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to
265utf8.
236 266
237Examples: 267Examples:
238 268
239 print "user 7 exists!\n" 269 print "user 7 exists!\n"
240 if sql_exists "user where id = ?", 7; 270 if sql_exists "user where id = ?", 7;
314 344
315package PApp::SQL::Database; 345package PApp::SQL::Database;
316 346
317=head2 THE DATABASE CLASS 347=head2 THE DATABASE CLASS
318 348
319Again (sigh) the problem of persistency. What do you do when you have to serialize on object 349Again (sigh) the problem of persistency. What do you do when you have
320that contains (or should contain) a database handle? Short answer: you don't. Long answer: 350to serialize on object that contains (or should contain) a database
351handle? Short answer: you don't. Long answer: you can embed the necessary
321you can embed the necessary information to recreate the dbh when needed. 352information to recreate the dbh when needed.
322 353
323The C<PApp::SQL::Database> class does that, in a relatively efficient 354The C<PApp::SQL::Database> class does that, in a relatively efficient
324fashion: the overhead is currently a single method call per access (you 355fashion: the overhead is currently a single method call per access (you
325can cache the real dbh if you want). 356can cache the real dbh if you want).
326 357
366 397
367=item $db->dsn 398=item $db->dsn
368 399
369Return the DSN (L<DBI>) fo the database object (e.g. for error messages). 400Return the DSN (L<DBI>) fo the database object (e.g. for error messages).
370 401
402=item $db->login
403
404Return the login name.
405
406=item $db->password
407
408Return the password (emphasizing the fact that the apssword is stored plaintext ;)
409
371=cut 410=cut
372 411
373sub dsn($) { 412sub dsn($) {
374 my $self = shift; 413 my $self = shift;
375 (split /\x00/, $self->[0])[1]; 414 (split /\x00/, $self->[0])[1];
376} 415}
377 416
417sub login($) {
418 my $self = shift;
419 (split /\x00/, $self->[0])[2];
420}
421
422sub password($) {
423 my $self = shift;
424 (split /\x00/, $self->[0])[3];
425}
426
378=back 427=back
379 428
380=cut 429=cut
381 430
3821; 4311;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines