… | |
… | |
44 | use DBI (); |
44 | use DBI (); |
45 | |
45 | |
46 | BEGIN { |
46 | BEGIN { |
47 | use base qw(Exporter DynaLoader); |
47 | use base qw(Exporter DynaLoader); |
48 | |
48 | |
49 | $VERSION = 0.13; |
49 | $VERSION = '1.01'; |
50 | @EXPORT = qw( |
50 | @EXPORT = qw( |
51 | 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 |
52 | sql_uexec sql_ufetch sql_ufetchall sql_uexists |
53 | ); |
53 | ); |
54 | @EXPORT_OK = qw( |
54 | @EXPORT_OK = qw( |
… | |
… | |
62 | our $DBH; # the default database handle |
62 | our $DBH; # the default database handle |
63 | our $Database; # the current SQL::Database object, if applicable |
63 | our $Database; # the current SQL::Database object, if applicable |
64 | |
64 | |
65 | our %dbcache; |
65 | our %dbcache; |
66 | |
66 | |
67 | =head2 GLOBAL VARIABLES |
67 | =head2 Global Variables |
68 | |
68 | |
69 | =over 4 |
69 | =over 4 |
70 | |
70 | |
71 | =item $sql_exec |
71 | =item $sql_exec |
72 | |
72 | |
… | |
… | |
76 | done by this module. |
76 | done by this module. |
77 | |
77 | |
78 | =item $PApp::SQL::DBH |
78 | =item $PApp::SQL::DBH |
79 | |
79 | |
80 | The default database handle used by this module if no C<$DBH> was |
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 |
81 | specified as argument. See C<sql_exec> for a discussion. |
82 | C<sql_exec> for a discussion. |
|
|
83 | |
82 | |
84 | =item $PApp::SQL::Database |
83 | =item $PApp::SQL::Database |
85 | |
84 | |
86 | The current default C<PApp::SQL::Database>-object. Future versions might |
85 | The current default C<PApp::SQL::Database>-object. Future versions might |
87 | automatically fall back on this database and create database handles from |
86 | automatically fall back on this database and create database handles from |
… | |
… | |
89 | be nice as a placeholder for the database object that corresponds to |
88 | be nice as a placeholder for the database object that corresponds to |
90 | $PApp::SQL::DBH. |
89 | $PApp::SQL::DBH. |
91 | |
90 | |
92 | =back |
91 | =back |
93 | |
92 | |
94 | =head2 FUNCTIONS |
93 | =head2 Functions |
95 | |
94 | |
96 | =over 4 |
95 | =over 4 |
97 | |
96 | |
98 | =item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect |
97 | =item $dbh = connect_cached $id, $dsn, $user, $pass, $flags, $connect |
99 | |
98 | |
… | |
… | |
163 | statement handle. The command and the statement handle will be cached |
162 | statement handle. The command and the statement handle will be cached |
164 | (with the database handle and the sql string as key), so prepare will be |
163 | (with the database handle and the sql string as key), so prepare will be |
165 | called only once for each distinct sql call (please keep in mind that the |
164 | called only once for each distinct sql call (please keep in mind that the |
166 | returned statement will always be the same, so, if you call C<sql_exec> |
165 | returned statement will always be the same, so, if you call C<sql_exec> |
167 | with the same dbh and sql-statement twice (e.g. in a subroutine you |
166 | with the same dbh and sql-statement twice (e.g. in a subroutine you |
168 | called), the statement handle for the first call mustn't be used. |
167 | called), the statement handle for the first call mustn't not be in use |
|
|
168 | anymore, as the subsequent call will re-use the handle. |
169 | |
169 | |
170 | The database handle (the first argument) is optional. If it is missing, |
170 | The database handle (the first argument) is optional. If it is missing, |
171 | C<sql_exec> first tries to use the variable C<$DBH> in the current (= |
171 | it tries to use database handle in C<$PApp::SQL::DBH>, which you can set |
172 | calling) package and, if that fails, it tries to use database handle in |
172 | before calling these functions. NOTICE: future and former versions of |
173 | C<$PApp::SQL::DBH>, which you can set before calling these functions. |
173 | PApp::SQL might also look up the global variable C<$DBH> in the callers |
|
|
174 | package. |
|
|
175 | |
|
|
176 | =begin comment |
|
|
177 | |
|
|
178 | If it is missing, C<sql_exec> first tries to use the variable C<$DBH> |
|
|
179 | in the current (= calling) package and, if that fails, it tries to use |
|
|
180 | database handle in C<$PApp::SQL::DBH>, which you can set before calling |
|
|
181 | these functions. |
|
|
182 | |
|
|
183 | =end comment |
174 | |
184 | |
175 | The actual return value from the C<$sth->execute> call is stored in the |
185 | The actual return value from the C<$sth->execute> call is stored in the |
176 | package-global (and exported) variable C<$sql_exec>. |
186 | package-global (and exported) variable C<$sql_exec>. |
177 | |
187 | |
178 | If any error occurs C<sql_exec> will throw an exception. |
188 | If any error occurs C<sql_exec> will throw an exception. |
179 | |
189 | |
180 | C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to |
190 | C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to |
181 | utf8 before calling the C<execute> method. |
191 | UTF-8 before calling the C<execute> method. |
182 | |
192 | |
183 | Examples: |
193 | Examples: |
184 | |
194 | |
185 | # easy one |
195 | # easy one |
186 | my $st = sql_exec "select name, id from table where id = ?", $id; |
196 | my $st = sql_exec "select name, id from table where id = ?", $id; |
… | |
… | |
220 | my($name, $amount) = sql_fetch "select ...", args... |
230 | my($name, $amount) = sql_fetch "select ...", args... |
221 | |
231 | |
222 | ... and it's still quite fast unless you fetch large amounts of data. |
232 | ... and it's still quite fast unless you fetch large amounts of data. |
223 | |
233 | |
224 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
234 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
225 | utf8 and forces all result values to utf8 (this does I<not> include result |
235 | UTF-8 and forces all result values to UTF-8 (this does I<not> include result |
226 | parameters, only return values. Using bind variables in cinjunction with |
236 | parameters, only return values. Using bind variables in conjunction with |
227 | sql_u* functions results in undefined behaviour). |
237 | sql_u* functions might result in undefined behaviour - we use UTF-8 on |
|
|
238 | bind-variables at execution time and it seems to work on DBD::mysql as it |
|
|
239 | ignores the UTF-8 bit completely. Which just means that that DBD-driver is |
|
|
240 | broken). |
228 | |
241 | |
229 | =item sql_fetchall <see sql_exec> |
242 | =item sql_fetchall <see sql_exec> |
230 | |
243 | |
231 | =item sql_ufetchall <see sql_uexec> |
244 | =item sql_ufetchall <see sql_uexec> |
232 | |
245 | |
… | |
… | |
249 | for (sql_fetchall "select name, age, place from user") { |
262 | for (sql_fetchall "select name, age, place from user") { |
250 | my ($name, $age, $place) = @$_; |
263 | my ($name, $age, $place) = @$_; |
251 | } |
264 | } |
252 | |
265 | |
253 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
266 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
254 | values to utf8 and forces all result values to utf8 (see the caveats in |
267 | values to UTF-8 and forces all result values to UTF-8 (see the caveats in |
255 | the description of C<sql_ufetch>, though). |
268 | the description of C<sql_ufetch>, though). |
256 | |
269 | |
257 | =item sql_exists "<table_references> where <where_condition>...", args... |
270 | =item sql_exists "<table_references> where <where_condition>...", args... |
258 | |
271 | |
259 | =item sql_uexists <see sql_exists> |
272 | =item sql_uexists <see sql_exists> |
… | |
… | |
263 | "select * from" were prepended to your statement (it isn't)). Should work |
276 | "select * from" were prepended to your statement (it isn't)). Should work |
264 | with every database but can be quite slow, except on mysql, where this |
277 | with every database but can be quite slow, except on mysql, where this |
265 | should be quite fast. |
278 | should be quite fast. |
266 | |
279 | |
267 | C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to |
280 | C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to |
268 | utf8. |
281 | UTF-8. |
269 | |
282 | |
270 | Examples: |
283 | Examples: |
271 | |
284 | |
272 | print "user 7 exists!\n" |
285 | print "user 7 exists!\n" |
273 | if sql_exists "user where id = ?", 7; |
286 | if sql_exists "user where id = ?", 7; |
… | |
… | |
286 | |
299 | |
287 | mysql: first C<AUTO_INCREMENT> column set to NULL |
300 | mysql: first C<AUTO_INCREMENT> column set to NULL |
288 | postgres: C<oid> column (is there a way to get the last SERIAL?) |
301 | postgres: C<oid> column (is there a way to get the last SERIAL?) |
289 | sybase: C<IDENTITY> column of the last insert (slow) |
302 | sybase: C<IDENTITY> column of the last insert (slow) |
290 | informix: C<SERIAL> or C<SERIAL8> column of the last insert |
303 | informix: C<SERIAL> or C<SERIAL8> column of the last insert |
|
|
304 | sqlite: C<last_insert_rowid()> |
291 | |
305 | |
292 | Except for sybase, this does not require a server access. |
306 | Except for sybase, this does not require a server access. |
293 | |
307 | |
294 | =cut |
308 | =cut |
295 | |
309 | |
… | |
… | |
300 | |
314 | |
301 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
315 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
302 | $driver eq "Pg" and return $sth->{pg_oid_status}; |
316 | $driver eq "Pg" and return $sth->{pg_oid_status}; |
303 | $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); |
317 | $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); |
304 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
318 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
|
|
319 | $driver eq "SQLite" and return sql_fetch($dbh, 'SELECT last_insert_rowid ()'); |
305 | |
320 | |
306 | die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; |
321 | die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; |
307 | } |
322 | } |
308 | |
323 | |
309 | =item [old-size] = cachesize [new-size] |
324 | =item [old-size] = cachesize [new-size] |
310 | |
325 | |
311 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
326 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
312 | default is somewhere around 50 (= the 50 last recently used statements |
327 | default is somewhere around 50 (= the 50 last recently used statements |
313 | will be cached). It shouldn't be too large, since a simple linear listed |
328 | will be cached). It shouldn't be too large, since a simple linear list |
314 | is used for the cache at the moment (which, for small (<100) cache sizes |
329 | is used for the cache at the moment (which, for small (<100) cache sizes |
315 | is actually quite fast). |
330 | is actually quite fast). |
316 | |
331 | |
317 | The function always returns the cache size in effect I<before> the call, |
332 | The function always returns the cache size in effect I<before> the call, |
318 | so, to nuke the cache (for example, when a database connection has died |
333 | so, to nuke the cache (for example, when a database connection has died |
… | |
… | |
345 | |
360 | |
346 | reinitialize; |
361 | reinitialize; |
347 | |
362 | |
348 | package PApp::SQL::Database; |
363 | package PApp::SQL::Database; |
349 | |
364 | |
350 | =head2 THE DATABASE CLASS |
365 | =head2 The Database Class |
351 | |
366 | |
352 | Again (sigh) the problem of persistency. What do you do when you have |
367 | Again (sigh) the problem of persistency. What do you do when you have |
353 | to serialize on object that contains (or should contain) a database |
368 | to serialize on object that contains (or should contain) a database |
354 | handle? Short answer: you don't. Long answer: you can embed the necessary |
369 | handle? Short answer: you don't. Long answer: you can embed the necessary |
355 | information to recreate the dbh when needed. |
370 | information to recreate the dbh when needed. |
… | |
… | |
393 | |
408 | |
394 | sub checked_dbh($) { |
409 | sub checked_dbh($) { |
395 | my $dbh = $dbcache{$_[0][0]}; |
410 | my $dbh = $dbcache{$_[0][0]}; |
396 | $dbh && $dbh->ping |
411 | $dbh && $dbh->ping |
397 | ? $dbh |
412 | ? $dbh |
398 | : PApp::SQL::connect_cached((split /\x00/, $_[0][0]), $_[0][1], $_[0][2]); |
413 | : PApp::SQL::connect_cached((split /\x00/, $_[0][0], 4), $_[0][1], $_[0][2]); |
399 | } |
414 | } |
400 | |
415 | |
401 | =item $db->dsn |
416 | =item $db->dsn |
402 | |
417 | |
403 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
418 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
… | |
… | |
406 | |
421 | |
407 | Return the login name. |
422 | Return the login name. |
408 | |
423 | |
409 | =item $db->password |
424 | =item $db->password |
410 | |
425 | |
411 | Return the password (emphasizing the fact that the apssword is stored plaintext ;) |
426 | Return the password (emphasizing the fact that the password is stored plaintext ;) |
412 | |
427 | |
413 | =cut |
428 | =cut |
414 | |
429 | |
415 | sub dsn($) { |
430 | sub dsn($) { |
416 | my $self = shift; |
431 | my $self = shift; |
… | |
… | |
437 | |
452 | |
438 | L<PApp>. |
453 | L<PApp>. |
439 | |
454 | |
440 | =head1 AUTHOR |
455 | =head1 AUTHOR |
441 | |
456 | |
442 | Marc Lehmann <pcg@goof.com> |
457 | Marc Lehmann <schmorp@schmorp.de> |
443 | http://www.goof.com/pcg/marc/ |
458 | http://home.schmorp.de/ |
444 | |
459 | |
445 | =cut |
460 | =cut |
446 | |
461 | |