… | |
… | |
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.1242; |
49 | $VERSION = 0.141; |
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( |
… | |
… | |
69 | =over 4 |
69 | =over 4 |
70 | |
70 | |
71 | =item $sql_exec |
71 | =item $sql_exec |
72 | |
72 | |
73 | Since the C<sql_exec> family of functions return a statement handle there |
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 |
74 | must be 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> |
75 | global variable contains the result of the most recent call to C<execute> |
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 |
… | |
… | |
111 | __LINE__ work fine as well). |
110 | __LINE__ work fine as well). |
112 | |
111 | |
113 | The reason C<$id> is necessary is that you might specify special connect |
112 | The reason C<$id> is necessary is that you might specify special connect |
114 | arguments or special flags, or you might want to configure your $DBH |
113 | arguments or special flags, or you might want to configure your $DBH |
115 | differently than maybe other applications requesting the same database |
114 | differently than maybe other applications requesting the same database |
116 | connection. If none of this is becessary for your application you can |
115 | connection. If none of this is necessary for your application you can |
117 | leave $id empty (i.e. ""). |
116 | leave C<$id> empty (i.e. ""). |
118 | |
117 | |
119 | If specified, C<$connect> is a callback (e.g. a coderef) that will be |
118 | If specified, C<$connect> is a callback (e.g. a coderef) that will be |
120 | called each time a new connection is being established, with the new |
119 | called each time a new connection is being established, with the new |
121 | C<$dbh> as first argument. |
120 | C<$dbh> as first argument. |
122 | |
121 | |
… | |
… | |
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. |
… | |
… | |
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. |
235 | utf8 and forces all result values to utf8 (this does I<not> include result |
|
|
236 | parameters, only return values. Using bind variables in cinjunction with |
|
|
237 | sql_u* functions results in undefined behaviour). |
226 | |
238 | |
227 | =item sql_fetchall <see sql_exec> |
239 | =item sql_fetchall <see sql_exec> |
228 | |
240 | |
229 | =item sql_ufetchall <see sql_uexec> |
241 | =item sql_ufetchall <see sql_uexec> |
230 | |
242 | |
… | |
… | |
247 | for (sql_fetchall "select name, age, place from user") { |
259 | for (sql_fetchall "select name, age, place from user") { |
248 | my ($name, $age, $place) = @$_; |
260 | my ($name, $age, $place) = @$_; |
249 | } |
261 | } |
250 | |
262 | |
251 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
263 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
252 | values to utf8 and forces all result values to utf8. |
264 | values to utf8 and forces all result values to utf8 (see the caveats in |
|
|
265 | the description of C<sql_ufetch>, though). |
253 | |
266 | |
254 | =item sql_exists "<table_references> where <where_condition>...", args... |
267 | =item sql_exists "<table_references> where <where_condition>...", args... |
255 | |
268 | |
256 | =item sql_uexists <see sql_exists> |
269 | =item sql_uexists <see sql_exists> |
257 | |
270 | |
… | |
… | |
305 | |
318 | |
306 | =item [old-size] = cachesize [new-size] |
319 | =item [old-size] = cachesize [new-size] |
307 | |
320 | |
308 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
321 | Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The |
309 | default is somewhere around 50 (= the 50 last recently used statements |
322 | default is somewhere around 50 (= the 50 last recently used statements |
310 | will be cached). It shouldn't be too large, since a simple linear listed |
323 | will be cached). It shouldn't be too large, since a simple linear list |
311 | is used for the cache at the moment (which, for small (<100) cache sizes |
324 | is used for the cache at the moment (which, for small (<100) cache sizes |
312 | is actually quite fast). |
325 | is actually quite fast). |
313 | |
326 | |
314 | The function always returns the cache size in effect I<before> the call, |
327 | The function always returns the cache size in effect I<before> the call, |
315 | so, to nuke the cache (for example, when a database connection has died |
328 | so, to nuke the cache (for example, when a database connection has died |
… | |
… | |
403 | |
416 | |
404 | Return the login name. |
417 | Return the login name. |
405 | |
418 | |
406 | =item $db->password |
419 | =item $db->password |
407 | |
420 | |
408 | Return the password (emphasizing the fact that the apssword is stored plaintext ;) |
421 | Return the password (emphasizing the fact that the password is stored plaintext ;) |
409 | |
422 | |
410 | =cut |
423 | =cut |
411 | |
424 | |
412 | sub dsn($) { |
425 | sub dsn($) { |
413 | my $self = shift; |
426 | my $self = shift; |