1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
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 "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.1242; |
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_uexec 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 | |
… | |
… | |
72 | Examples: |
123 | Examples: |
73 | |
124 | |
74 | # try your luck opening the papp database without access info |
125 | # try your luck opening the papp database without access info |
75 | $dbh = connect_cached __FILE__, "DBI:mysql:papp"; |
126 | $dbh = connect_cached __FILE__, "DBI:mysql:papp"; |
76 | |
127 | |
|
|
128 | Mysql-specific behaviour: The default setting of |
|
|
129 | C<mysql_client_found_rows> is TRUE, you can overwrite this, though. |
|
|
130 | |
77 | =cut |
131 | =cut |
78 | |
132 | |
79 | sub connect_cached { |
133 | sub connect_cached { |
80 | my ($id, $dsn, $user, $pass, $flags, $connect) = @_; |
134 | my ($id, $dsn, $user, $pass, $flags, $connect) = @_; |
81 | # the following line is duplicated in PApp::SQL::Database::new |
135 | # the following line is duplicated in PApp::SQL::Database::new |
82 | $id = "$id\0$dsn\0$user\0$pass"; |
136 | $id = "$id\0$dsn\0$user\0$pass"; |
83 | unless ($dbcache{$id} && $dbcache{$id}->ping) { |
137 | unless ($dbcache{$id} && $dbcache{$id}->ping) { |
84 | #warn "connecting to ($dsn|$user|$pass|$flags)\n";#d# |
|
|
85 | # first, nuke our statement cache (sooory ;) |
138 | # first, nuke our statement cache (sooory ;) |
86 | 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 | |
87 | # then connect anew |
146 | # then connect anew |
88 | $dbcache{$id} = |
147 | $dbcache{$id} = |
89 | eval { DBI->connect($dsn, $user, $pass, $flags) } |
148 | eval { DBI->connect($dsn, $user, $pass, $flags) } |
90 | || eval { DBI->connect($dsn, $user, $pass, $flags) } |
149 | || eval { DBI->connect($dsn, $user, $pass, $flags) } |
91 | || die "unable to connect to database $dsn: $DBI::errstr\n"; |
150 | || die "unable to connect to database $dsn: $DBI::errstr\n"; |
… | |
… | |
94 | $dbcache{$id}; |
153 | $dbcache{$id}; |
95 | } |
154 | } |
96 | |
155 | |
97 | =item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...] |
156 | =item $sth = sql_exec [dbh,] [bind-vals...,] "sql-statement", [arguments...] |
98 | |
157 | |
|
|
158 | =item $sth = sql_uexec <see sql_exec> |
|
|
159 | |
99 | C<sql_exec> is the most important and most-used function in this module. |
160 | C<sql_exec> is the most important and most-used function in this module. |
100 | |
161 | |
101 | Runs the given sql command with the given parameters and returns the |
162 | Runs the given sql command with the given parameters and returns the |
102 | statement handle. The command and the statement handle will be cached |
163 | 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 |
164 | (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 |
175 | The actual return value from the C<$sth->execute> call is stored in the |
115 | package-global (and exported) variable C<$sql_exec>. |
176 | package-global (and exported) variable C<$sql_exec>. |
116 | |
177 | |
117 | If any error occurs C<sql_exec> will throw an exception. |
178 | If any error occurs C<sql_exec> will throw an exception. |
118 | |
179 | |
|
|
180 | C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to |
|
|
181 | utf8 before calling the C<execute> method. |
|
|
182 | |
119 | Examples: |
183 | Examples: |
120 | |
184 | |
121 | # easy one |
185 | # easy one |
122 | 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; |
123 | while (my ($name, $id) = $st->fetchrow_array) { ... }; |
187 | while (my ($name, $id) = $st->fetchrow_array) { ... }; |
… | |
… | |
132 | sql_exec $dbh, "update file set name = ?", "oops.txt"; |
196 | sql_exec $dbh, "update file set name = ?", "oops.txt"; |
133 | |
197 | |
134 | |
198 | |
135 | =item sql_fetch <see sql_exec> |
199 | =item sql_fetch <see sql_exec> |
136 | |
200 | |
|
|
201 | =item sql_ufetch <see sql_uexec> |
|
|
202 | |
137 | Execute a sql-statement and fetch the first row of results. Depending on |
203 | 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 |
204 | the caller context the row will be returned as a list (array context), or |
139 | just the first columns. In table form: |
205 | just the first columns. In table form: |
140 | |
206 | |
141 | CONTEXT RESULT |
207 | CONTEXT RESULT |
142 | void () |
208 | void () |
… | |
… | |
153 | |
219 | |
154 | my($name, $amount) = sql_fetch "select ...", args... |
220 | my($name, $amount) = sql_fetch "select ...", args... |
155 | |
221 | |
156 | ... 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. |
157 | |
223 | |
|
|
224 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
|
|
225 | utf8 and forces all result values to utf8. |
|
|
226 | |
158 | =item sql_fetchall <see sql_exec> |
227 | =item sql_fetchall <see sql_exec> |
|
|
228 | |
|
|
229 | =item sql_ufetchall <see sql_uexec> |
159 | |
230 | |
160 | Similarly to C<sql_fetch>, but all result rows will be fetched (this is |
231 | 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 |
232 | 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 |
233 | list context makes sense), but the result still depends on the number of |
163 | columns in the result: |
234 | columns in the result: |
… | |
… | |
175 | |
246 | |
176 | for (sql_fetchall "select name, age, place from user") { |
247 | for (sql_fetchall "select name, age, place from user") { |
177 | my ($name, $age, $place) = @$_; |
248 | my ($name, $age, $place) = @$_; |
178 | } |
249 | } |
179 | |
250 | |
|
|
251 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
|
|
252 | values to utf8 and forces all result values to utf8. |
|
|
253 | |
180 | =item sql_exists "<table> where ...", args... |
254 | =item sql_exists "<table_references> where <where_condition>...", args... |
|
|
255 | |
|
|
256 | =item sql_uexists <see sql_exists> |
181 | |
257 | |
182 | Check wether the result of the sql-statement "select xxx from |
258 | Check wether the result of the sql-statement "select xxx from |
183 | $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 |
184 | "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 |
185 | with every database but can be quite slow, except on mysql, where this |
261 | with every database but can be quite slow, except on mysql, where this |
186 | should be quite fast. |
262 | should be quite fast. |
|
|
263 | |
|
|
264 | C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to |
|
|
265 | utf8. |
187 | |
266 | |
188 | Examples: |
267 | Examples: |
189 | |
268 | |
190 | print "user 7 exists!\n" |
269 | print "user 7 exists!\n" |
191 | if sql_exists "user where id = ?", 7; |
270 | if sql_exists "user where id = ?", 7; |
… | |
… | |
195 | |
274 | |
196 | =cut |
275 | =cut |
197 | |
276 | |
198 | =item $lastid = sql_insertid $sth |
277 | =item $lastid = sql_insertid $sth |
199 | |
278 | |
200 | Returns the last automatically created key value (e.g. for mysql |
279 | 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. |
280 | directly after executing the insert statement that created it. This is |
|
|
281 | what is actually returned for various databases. If your database is |
|
|
282 | missing, please send me an e-mail on how to implement this ;) |
|
|
283 | |
|
|
284 | mysql: first C<AUTO_INCREMENT> column set to NULL |
|
|
285 | postgres: C<oid> column (is there a way to get the last SERIAL?) |
|
|
286 | sybase: C<IDENTITY> column of the last insert (slow) |
|
|
287 | informix: C<SERIAL> or C<SERIAL8> column of the last insert |
|
|
288 | |
|
|
289 | Except for sybase, this does not require a server access. |
203 | |
290 | |
204 | =cut |
291 | =cut |
205 | |
292 | |
206 | sub sql_insertid($) { |
293 | sub sql_insertid($) { |
207 | my $sth = shift or die "sql_insertid requires a statement handle"; |
294 | my $sth = shift or die "sql_insertid requires a statement handle"; |
208 | my $dbh = $sth->{Database}; |
295 | my $dbh = $sth->{Database}; |
209 | my $driver = $dbh->{Driver}{Name}; |
296 | my $driver = $dbh->{Driver}{Name}; |
210 | |
297 | |
211 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
298 | $driver eq "mysql" and return $sth->{mysql_insertid}; |
|
|
299 | $driver eq "Pg" and return $sth->{pg_oid_status}; |
212 | $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); |
300 | $driver eq "Sybase" and return sql_fetch($dbh, 'SELECT @@IDENTITY'); |
213 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
301 | $driver eq "Informix" and return $sth->{ix_sqlerrd}[1]; |
214 | |
302 | |
215 | die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; |
303 | die "sql_insertid does not spport the dbd driver '$driver', please see PApp::SQL::sql_insertid"; |
216 | } |
304 | } |
217 | |
305 | |
… | |
… | |
232 | |
320 | |
233 | =cut |
321 | =cut |
234 | |
322 | |
235 | =item reinitialize [not exported] |
323 | =item reinitialize [not exported] |
236 | |
324 | |
237 | Clears any internal caches (statement cache, database handle cache). |
325 | Clears any internal caches (statement cache, database handle |
|
|
326 | cache). Should be called after C<fork> and other accidents that invalidate |
|
|
327 | database handles. |
238 | |
328 | |
239 | =cut |
329 | =cut |
240 | |
330 | |
241 | sub reinitialize { |
331 | sub reinitialize { |
242 | cachesize cachesize 0; |
332 | cachesize cachesize 0; |
243 | for (values %dbcache) { |
333 | for (values %dbcache) { |
244 | eval { $_->disconnect }; |
334 | eval { $_->{InactiveDestroy} = 1 }; |
245 | } |
335 | } |
246 | undef %dbcache; |
336 | undef %dbcache; |
247 | } |
337 | } |
248 | |
338 | |
249 | =back |
339 | =back |
250 | |
340 | |
251 | =cut |
341 | =cut |
252 | |
342 | |
|
|
343 | reinitialize; |
|
|
344 | |
253 | package PApp::SQL::Database; |
345 | package PApp::SQL::Database; |
254 | |
346 | |
255 | =head2 THE DATABASE CLASS |
347 | =head2 THE DATABASE CLASS |
256 | |
348 | |
257 | Again (sigh) the problem of persistency. What do you do when you have to serialize on object |
349 | Again (sigh) the problem of persistency. What do you do when you have |
258 | that contains (or should contain) a database handle? Short answer: you don't. Long answer: |
350 | to serialize on object that contains (or should contain) a database |
|
|
351 | handle? Short answer: you don't. Long answer: you can embed the necessary |
259 | you can embed the necessary information to recreate the dbh when needed. |
352 | information to recreate the dbh when needed. |
260 | |
353 | |
261 | The C<PApp::SQL::Database> class does that, in a relatively efficient |
354 | The C<PApp::SQL::Database> class does that, in a relatively efficient |
262 | fashion: the overhead is currently a single method call per access (you |
355 | fashion: the overhead is currently a single method call per access (you |
263 | can cache the real dbh if you want). |
356 | can cache the real dbh if you want). |
264 | |
357 | |
… | |
… | |
304 | |
397 | |
305 | =item $db->dsn |
398 | =item $db->dsn |
306 | |
399 | |
307 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
400 | Return the DSN (L<DBI>) fo the database object (e.g. for error messages). |
308 | |
401 | |
|
|
402 | =item $db->login |
|
|
403 | |
|
|
404 | Return the login name. |
|
|
405 | |
|
|
406 | =item $db->password |
|
|
407 | |
|
|
408 | Return the password (emphasizing the fact that the apssword is stored plaintext ;) |
|
|
409 | |
309 | =cut |
410 | =cut |
310 | |
411 | |
311 | sub dsn($) { |
412 | sub dsn($) { |
312 | my $self = shift; |
413 | my $self = shift; |
313 | $self->[1][1]; |
414 | (split /\x00/, $self->[0])[1]; |
|
|
415 | } |
|
|
416 | |
|
|
417 | sub login($) { |
|
|
418 | my $self = shift; |
|
|
419 | (split /\x00/, $self->[0])[2]; |
|
|
420 | } |
|
|
421 | |
|
|
422 | sub password($) { |
|
|
423 | my $self = shift; |
|
|
424 | (split /\x00/, $self->[0])[3]; |
314 | } |
425 | } |
315 | |
426 | |
316 | =back |
427 | =back |
317 | |
428 | |
318 | =cut |
429 | =cut |
319 | |
430 | |
320 | reinitialize; |
|
|
321 | |
|
|
322 | 1; |
431 | 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 | |
432 | |
332 | =head1 SEE ALSO |
433 | =head1 SEE ALSO |
333 | |
434 | |
334 | L<PApp>. |
435 | L<PApp>. |
335 | |
436 | |