… | |
… | |
8 | |
8 | |
9 | my $st = sql_exec $DBH, "select ... where a = ?", $a; |
9 | my $st = sql_exec $DBH, "select ... where a = ?", $a; |
10 | |
10 | |
11 | local $DBH = <database handle>; |
11 | local $DBH = <database handle>; |
12 | my $st = sql_exec \my($bind_a, $bind_b), "select a,b ..."; |
12 | my $st = sql_exec \my($bind_a, $bind_b), "select a,b ..."; |
13 | my $st = sql_insertid |
13 | my $id = 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 "table where name like 'a%'" |
18 | sql_exists "table where name like 'a%'" |
… | |
… | |
25 | |
25 | |
26 | =head1 DESCRIPTION |
26 | =head1 DESCRIPTION |
27 | |
27 | |
28 | 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 |
29 | 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 |
30 | efficient and allow you to write faster programs in less lines of code. It |
30 | efficient and allow you to write faster programs in fewer lines of |
31 | should work with anything from perl-5.004_01 onwards, but I only support |
31 | code. It should work with anything from perl-5.004_01 onwards, but I only |
32 | 5.005+. UTF8 handling (the C<sql_u*> family of functions) will only be |
32 | support 5.005+. UTF8 handling (the C<sql_u*> family of functions) will |
33 | effective with perl version 5.006 and beyond. |
33 | only be effective with perl version 5.006 and beyond. |
34 | |
34 | |
35 | If the descriptions here seem terse or if you always wanted to know |
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 |
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 |
37 | extensively but also provides you with a lot more gimmicks to play around |
38 | with to help you create cool applications ;) |
38 | with to help you create cool applications ;) |
39 | |
39 | |
40 | =cut |
40 | =cut |
41 | |
41 | |
42 | package PApp::SQL; |
42 | package PApp::SQL; |
43 | |
43 | |
|
|
44 | use Carp (); |
44 | use DBI (); |
45 | use DBI (); |
45 | |
46 | |
46 | BEGIN { |
47 | BEGIN { |
47 | use base qw(Exporter DynaLoader); |
48 | use base qw(Exporter DynaLoader); |
48 | |
49 | |
49 | $VERSION = 0.131; |
50 | $VERSION = '2.002'; |
50 | @EXPORT = qw( |
51 | @EXPORT = qw( |
51 | sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec |
52 | sql_exec sql_fetch sql_fetchall sql_exists sql_insertid $sql_exec |
52 | sql_uexec sql_ufetch sql_ufetchall sql_uexists |
53 | sql_uexec sql_ufetch sql_ufetchall sql_uexists |
53 | ); |
54 | ); |
54 | @EXPORT_OK = qw( |
55 | @EXPORT_OK = qw( |
… | |
… | |
56 | ); |
57 | ); |
57 | |
58 | |
58 | bootstrap PApp::SQL $VERSION; |
59 | bootstrap PApp::SQL $VERSION; |
59 | } |
60 | } |
60 | |
61 | |
|
|
62 | boot2 DBI::SQL_VARCHAR, DBI::SQL_INTEGER, DBI::SQL_DOUBLE; |
|
|
63 | |
61 | our $sql_exec; # last result of sql_exec's execute call |
64 | our $sql_exec; # last result of sql_exec's execute call |
62 | our $DBH; # the default database handle |
65 | our $DBH; # the default database handle |
63 | our $Database; # the current SQL::Database object, if applicable |
66 | our $Database; # the current SQL::Database object, if applicable |
64 | |
67 | |
65 | our %dbcache; |
68 | our %dbcache; |
66 | |
69 | |
67 | =head2 GLOBAL VARIABLES |
70 | =head2 Global Variables |
68 | |
71 | |
69 | =over 4 |
72 | =over 4 |
70 | |
73 | |
71 | =item $sql_exec |
74 | =item $sql_exec |
72 | |
75 | |
… | |
… | |
88 | be nice as a placeholder for the database object that corresponds to |
91 | be nice as a placeholder for the database object that corresponds to |
89 | $PApp::SQL::DBH. |
92 | $PApp::SQL::DBH. |
90 | |
93 | |
91 | =back |
94 | =back |
92 | |
95 | |
93 | =head2 FUNCTIONS |
96 | =head2 Functions |
94 | |
97 | |
95 | =over 4 |
98 | =over 4 |
96 | |
99 | |
97 | =item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect |
100 | =item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect |
98 | |
101 | |
99 | (not exported by by default) |
102 | (not exported by by default) |
100 | |
103 | |
101 | Connect to the database given by C<($dsn,$user,$pass)>, while using the |
104 | Connect to the database given by C<($dsn,$user,$pass)>, while using the |
102 | flags from C<$flags>. These are just the same arguments as given to |
105 | flags from C<$flags>. These are just the same arguments as given to |
103 | C<DBI->connect>. |
106 | C<< DBI->connect >>. |
104 | |
107 | |
105 | The database handle will be cached under the unique id |
108 | The database handle will be cached under the unique id |
106 | C<$id|$dsn|$user|$pass>. If the same id is requested later, the |
109 | C<$id|$dsn|$user|$pass>. If the same id is requested later, the |
107 | cached handle will be checked (using ping), and the connection will |
110 | cached handle will be checked (using ping), and the connection will |
108 | be re-established if necessary (be sure to prefix your application or |
111 | be re-established if necessary (be sure to prefix your application or |
… | |
… | |
144 | |
147 | |
145 | # then connect anew |
148 | # then connect anew |
146 | $dbcache{$id} = |
149 | $dbcache{$id} = |
147 | eval { DBI->connect($dsn, $user, $pass, $flags) } |
150 | eval { DBI->connect($dsn, $user, $pass, $flags) } |
148 | || eval { DBI->connect($dsn, $user, $pass, $flags) } |
151 | || eval { DBI->connect($dsn, $user, $pass, $flags) } |
149 | || die "unable to connect to database $dsn: $DBI::errstr\n"; |
152 | || Carp::croak "unable to connect to database $dsn: $DBI::errstr\n"; |
150 | $connect->($dbcache{$id}) if $connect; |
153 | $connect->($dbcache{$id}) if $connect; |
151 | } |
154 | } |
152 | $dbcache{$id}; |
155 | $dbcache{$id}; |
153 | } |
156 | } |
154 | |
157 | |
… | |
… | |
180 | database handle in C<$PApp::SQL::DBH>, which you can set before calling |
183 | database handle in C<$PApp::SQL::DBH>, which you can set before calling |
181 | these functions. |
184 | these functions. |
182 | |
185 | |
183 | =end comment |
186 | =end comment |
184 | |
187 | |
185 | The actual return value from the C<$sth->execute> call is stored in the |
188 | The actual return value from the C<< $sth->execute >> call is stored in |
186 | package-global (and exported) variable C<$sql_exec>. |
189 | the package-global (and exported) variable C<$sql_exec>. |
187 | |
190 | |
188 | If any error occurs C<sql_exec> will throw an exception. |
191 | If any error occurs C<sql_exec> will throw an exception. |
189 | |
192 | |
190 | C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to |
193 | C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to |
191 | utf8 before calling the C<execute> method. |
194 | UTF-8 before calling the C<execute> method. |
192 | |
195 | |
193 | Examples: |
196 | Examples: |
194 | |
197 | |
195 | # easy one |
198 | # easy one |
196 | my $st = sql_exec "select name, id from table where id = ?", $id; |
199 | my $st = sql_exec "select name, id from table where id = ?", $id; |
… | |
… | |
230 | my($name, $amount) = sql_fetch "select ...", args... |
233 | my($name, $amount) = sql_fetch "select ...", args... |
231 | |
234 | |
232 | ... and it's still quite fast unless you fetch large amounts of data. |
235 | ... and it's still quite fast unless you fetch large amounts of data. |
233 | |
236 | |
234 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
237 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
235 | utf8 and forces all result values to utf8 (this does I<not> include result |
238 | UTF-8 and forces all result values to UTF-8 (this does I<not> include result |
236 | parameters, only return values. Using bind variables in cinjunction with |
239 | parameters, only return values. Using bind variables in conjunction with |
237 | sql_u* functions results in undefined behaviour). |
240 | sql_u* functions might result in undefined behaviour - we use UTF-8 on |
|
|
241 | bind-variables at execution time and it seems to work on DBD::mysql as it |
|
|
242 | ignores the UTF-8 bit completely. Which just means that that DBD-driver is |
|
|
243 | broken). |
238 | |
244 | |
239 | =item sql_fetchall <see sql_exec> |
245 | =item sql_fetchall <see sql_exec> |
240 | |
246 | |
241 | =item sql_ufetchall <see sql_uexec> |
247 | =item sql_ufetchall <see sql_uexec> |
242 | |
248 | |
… | |
… | |
259 | for (sql_fetchall "select name, age, place from user") { |
265 | for (sql_fetchall "select name, age, place from user") { |
260 | my ($name, $age, $place) = @$_; |
266 | my ($name, $age, $place) = @$_; |
261 | } |
267 | } |
262 | |
268 | |
263 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
269 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
264 | values to utf8 and forces all result values to utf8 (see the caveats in |
270 | values to UTF-8 and forces all result values to UTF-8 (see the caveats in |
265 | the description of C<sql_ufetch>, though). |
271 | the description of C<sql_ufetch>, though). |
266 | |
272 | |
267 | =item sql_exists "<table_references> where <where_condition>...", args... |
273 | =item sql_exists "<table_references> where <where_condition>...", args... |
268 | |
274 | |
269 | =item sql_uexists <see sql_exists> |
275 | =item sql_uexists <see sql_exists> |
… | |
… | |
273 | "select * from" were prepended to your statement (it isn't)). Should work |
279 | "select * from" were prepended to your statement (it isn't)). Should work |
274 | with every database but can be quite slow, except on mysql, where this |
280 | with every database but can be quite slow, except on mysql, where this |
275 | should be quite fast. |
281 | should be quite fast. |
276 | |
282 | |
277 | C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to |
283 | C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to |
278 | utf8. |
284 | UTF-8. |
279 | |
285 | |
280 | Examples: |
286 | Examples: |
281 | |
287 | |
282 | print "user 7 exists!\n" |
288 | print "user 7 exists!\n" |
283 | if sql_exists "user where id = ?", 7; |
289 | if sql_exists "user where id = ?", 7; |
… | |
… | |
292 | Returns the last automatically created key value. It must be executed |
298 | Returns the last automatically created key value. It must be executed |
293 | directly after executing the insert statement that created it. This is |
299 | directly after executing the insert statement that created it. This is |
294 | what is actually returned for various databases. If your database is |
300 | what is actually returned for various databases. If your database is |
295 | missing, please send me an e-mail on how to implement this ;) |
301 | missing, please send me an e-mail on how to implement this ;) |
296 | |
302 | |
|
|
303 | mariadb: first C<AUTO_INCREMENT> column set to NULL |
297 | mysql: first C<AUTO_INCREMENT> column set to NULL |
304 | mysql: first C<AUTO_INCREMENT> column set to NULL |
298 | postgres: C<oid> column (is there a way to get the last SERIAL?) |
305 | postgres: C<oid> column (is there a way to get the last SERIAL?) |
299 | sybase: C<IDENTITY> column of the last insert (slow) |
306 | sybase: C<IDENTITY> column of the last insert (slow) |
300 | informix: C<SERIAL> or C<SERIAL8> column of the last insert |
307 | informix: C<SERIAL> or C<SERIAL8> column of the last insert |
|
|
308 | sqlite: C<last_insert_rowid()> |
301 | |
309 | |
302 | Except for sybase, this does not require a server access. |
310 | Except for sybase, this does not require a server access. |
303 | |
311 | |
304 | =cut |
312 | =cut |
305 | |
313 | |
306 | sub sql_insertid($) { |
314 | sub sql_insertid($) { |
307 | my $sth = shift or die "sql_insertid requires a statement handle"; |
315 | my $sth = shift or Carp::croak "sql_insertid requires a statement handle"; |
308 | my $dbh = $sth->{Database}; |
316 | my $dbh = $sth->{Database}; |
309 | my $driver = $dbh->{Driver}{Name}; |
317 | my $driver = $dbh->{Driver}{Name}; |
310 | |
318 | |
|
|
319 | $driver eq "MariaDB" and return $sth->{mariadb_insertid}; |
311 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
320 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
312 | $driver eq "Pg" and return $sth->{pg_oid_status}; |
321 | $driver eq "Pg" and return $sth->{pg_oid_status}; |
313 | $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); |
322 | $driver eq "Sybase" and return sql_fetch ($dbh, 'SELECT @@IDENTITY'); |
314 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
323 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
|
|
324 | $driver eq "SQLite" and return sql_fetch ($dbh, 'SELECT last_insert_rowid ()'); |
315 | |
325 | |
316 | die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; |
326 | $dbh->last_insert_id (undef, undef, undef, undef) |
317 | } |
327 | } |
318 | |
328 | |
319 | =item [old-size] = cachesize [new-size] |
329 | =item [old-size] = cachesize [new-size] |
320 | |
330 | |
321 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
331 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
322 | default is somewhere around 50 (= the 50 last recently used statements |
332 | default is somewhere around 50 (= the 50 last recently used statements |
323 | will be cached). It shouldn't be too large, since a simple linear listed |
333 | will be cached). It shouldn't be too large, since a simple linear list |
324 | is used for the cache at the moment (which, for small (<100) cache sizes |
334 | is used for the cache at the moment (which, for small (<100) cache sizes |
325 | is actually quite fast). |
335 | is actually quite fast). |
326 | |
336 | |
327 | The function always returns the cache size in effect I<before> the call, |
337 | The function always returns the cache size in effect I<before> the call, |
328 | so, to nuke the cache (for example, when a database connection has died |
338 | so, to nuke the cache (for example, when a database connection has died |
… | |
… | |
353 | |
363 | |
354 | =cut |
364 | =cut |
355 | |
365 | |
356 | reinitialize; |
366 | reinitialize; |
357 | |
367 | |
|
|
368 | =head2 Type Deduction |
|
|
369 | |
|
|
370 | Since every database driver seems to deduce parameter types differently, |
|
|
371 | usually wrongly, and at leats in the case of DBD::mysql, different in |
|
|
372 | every other release or so, and this can and does lead to data corruption, |
|
|
373 | this module does type deduction itself. |
|
|
374 | |
|
|
375 | What does it mean? Simple - sql parameters for placeholders will be |
|
|
376 | explicitly marked as SQL_VARCHAR, SQL_INTEGER or SQL_DOUBLE the first time |
|
|
377 | a statement is prepared. |
|
|
378 | |
|
|
379 | To force a specific type, you can either continue to use e.g. sql casts, |
|
|
380 | or you can make sure to consistently use strings or numbers. To make a |
|
|
381 | perl scalar look enough like a string or a number, use this when passing |
|
|
382 | it to sql_exec or a similar functions: |
|
|
383 | |
|
|
384 | "$string" # to pass a string |
|
|
385 | $num+0 # to pass a number |
|
|
386 | |
|
|
387 | =cut |
|
|
388 | |
358 | package PApp::SQL::Database; |
389 | package PApp::SQL::Database; |
359 | |
390 | |
360 | =head2 THE DATABASE CLASS |
391 | =head2 The Database Class |
361 | |
392 | |
362 | Again (sigh) the problem of persistency. What do you do when you have |
393 | Again (sigh) the problem of persistency. What do you do when you have |
363 | to serialize on object that contains (or should contain) a database |
394 | to serialize on object that contains (or should contain) a database |
364 | handle? Short answer: you don't. Long answer: you can embed the necessary |
395 | handle? Short answer: you don't. Long answer: you can embed the necessary |
365 | information to recreate the dbh when needed. |
396 | information to recreate the dbh when needed. |
… | |
… | |
403 | |
434 | |
404 | sub checked_dbh($) { |
435 | sub checked_dbh($) { |
405 | my $dbh = $dbcache{$_[0][0]}; |
436 | my $dbh = $dbcache{$_[0][0]}; |
406 | $dbh && $dbh->ping |
437 | $dbh && $dbh->ping |
407 | ? $dbh |
438 | ? $dbh |
408 | : PApp::SQL::connect_cached((split /\x00/, $_[0][0]), $_[0][1], $_[0][2]); |
439 | : PApp::SQL::connect_cached((split /\x00/, $_[0][0], 4), $_[0][1], $_[0][2]); |
409 | } |
440 | } |
410 | |
441 | |
411 | =item $db->dsn |
442 | =item $db->dsn |
412 | |
443 | |
413 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
444 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
… | |
… | |
416 | |
447 | |
417 | Return the login name. |
448 | Return the login name. |
418 | |
449 | |
419 | =item $db->password |
450 | =item $db->password |
420 | |
451 | |
421 | Return the password (emphasizing the fact that the apssword is stored plaintext ;) |
452 | Return the password (emphasizing the fact that the password is stored plaintext ;) |
422 | |
453 | |
423 | =cut |
454 | =cut |
424 | |
455 | |
425 | sub dsn($) { |
456 | sub dsn($) { |
426 | my $self = shift; |
457 | my $self = shift; |
… | |
… | |
447 | |
478 | |
448 | L<PApp>. |
479 | L<PApp>. |
449 | |
480 | |
450 | =head1 AUTHOR |
481 | =head1 AUTHOR |
451 | |
482 | |
452 | Marc Lehmann <pcg@goof.com> |
483 | Marc Lehmann <schmorp@schmorp.de> |
453 | http://www.goof.com/pcg/marc/ |
484 | http://home.schmorp.de/ |
454 | |
485 | |
455 | =cut |
486 | =cut |
456 | |
487 | |