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.19 by root, Sun Jan 13 06:09:50 2002 UTC vs.
Revision 1.30 by stefan, Wed Jan 28 19:50:38 2004 UTC

… …
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
… …
44use DBI (); 44use DBI ();
45 45
46BEGIN { 46BEGIN {
47 use base qw(Exporter DynaLoader); 47 use base qw(Exporter DynaLoader);
48 48
49 $VERSION = 0.1241; 49 $VERSION = 0.143;
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
73Since the C<sql_exec> family of functions return a statement handle there 73Since the C<sql_exec> family of functions return a statement handle there
74must eb another way to test the return value of the C<execute> call. This 74must be another way to test the return value of the C<execute> call. This
75global variable contains the result of the most recent call to C<execute> 75global variable contains the result of the most recent call to C<execute>
76done by this module. 76done by this module.
77 77
78=item $PApp::SQL::DBH 78=item $PApp::SQL::DBH
79 79
80The default database handle used by this module if no C<$DBH> was 80The default database handle used by this module if no C<$DBH> was
81specified as argument and no C<$DBH> is found in the current package. See 81specified as argument. See C<sql_exec> for a discussion.
82C<sql_exec> for a discussion.
83 82
84=item $PApp::SQL::Database 83=item $PApp::SQL::Database
85 84
86The current default C<PApp::SQL::Database>-object. Future versions might 85The current default C<PApp::SQL::Database>-object. Future versions might
87automatically fall back on this database and create database handles from 86automatically fall back on this database and create database handles from
… …
111__LINE__ work fine as well). 110__LINE__ work fine as well).
112 111
113The reason C<$id> is necessary is that you might specify special connect 112The reason C<$id> is necessary is that you might specify special connect
114arguments or special flags, or you might want to configure your $DBH 113arguments or special flags, or you might want to configure your $DBH
115differently than maybe other applications requesting the same database 114differently than maybe other applications requesting the same database
116connection. If none of this is becessary for your application you can 115connection. If none of this is necessary for your application you can
117leave $id empty (i.e. ""). 116leave C<$id> empty (i.e. "").
118 117
119If specified, C<$connect> is a callback (e.g. a coderef) that will be 118If specified, C<$connect> is a callback (e.g. a coderef) that will be
120called each time a new connection is being established, with the new 119called each time a new connection is being established, with the new
121C<$dbh> as first argument. 120C<$dbh> as first argument.
122 121
… …
163statement handle. The command and the statement handle will be cached 162statement 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
165called only once for each distinct sql call (please keep in mind that the 164called only once for each distinct sql call (please keep in mind that the
166returned statement will always be the same, so, if you call C<sql_exec> 165returned statement will always be the same, so, if you call C<sql_exec>
167with the same dbh and sql-statement twice (e.g. in a subroutine you 166with the same dbh and sql-statement twice (e.g. in a subroutine you
168called), the statement handle for the first call mustn't be used. 167called), the statement handle for the first call mustn't not be in use
168anymore, as the subsequent call will re-use the handle.
169 169
170The database handle (the first argument) is optional. If it is missing, 170The database handle (the first argument) is optional. If it is missing,
171C<sql_exec> first tries to use the variable C<$DBH> in the current (= 171it tries to use database handle in C<$PApp::SQL::DBH>, which you can set
172calling) package and, if that fails, it tries to use database handle in 172before calling these functions. NOTICE: future and former versions of
173C<$PApp::SQL::DBH>, which you can set before calling these functions. 173PApp::SQL might also look up the global variable C<$DBH> in the callers
174package.
175
176=begin comment
177
178If it is missing, C<sql_exec> first tries to use the variable C<$DBH>
179in the current (= calling) package and, if that fails, it tries to use
180database handle in C<$PApp::SQL::DBH>, which you can set before calling
181these functions.
182
183=end comment
174 184
175The actual return value from the C<$sth->execute> call is stored in the 185The actual return value from the C<$sth->execute> call is stored in the
176package-global (and exported) variable C<$sql_exec>. 186package-global (and exported) variable C<$sql_exec>.
177 187
178If any error occurs C<sql_exec> will throw an exception. 188If 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
224C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to 234C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to
225utf8 and forces all result values to utf8. 235utf8 and forces all result values to utf8 (this does I<not> include result
236parameters, only return values. Using bind variables in cinjunction with
237sql_u* functions results in undefined behaviour - we use utf8_on on
238bind-variables and it seems to work on DBD::mysql which just means
239that that DBD-driver is broken).
226 240
227=item sql_fetchall <see sql_exec> 241=item sql_fetchall <see sql_exec>
228 242
229=item sql_ufetchall <see sql_uexec> 243=item sql_ufetchall <see sql_uexec>
230 244
… …
247 for (sql_fetchall "select name, age, place from user") { 261 for (sql_fetchall "select name, age, place from user") {
248 my ($name, $age, $place) = @$_; 262 my ($name, $age, $place) = @$_;
249 } 263 }
250 264
251C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input 265C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input
252values to utf8 and forces all result values to utf8. 266values to utf8 and forces all result values to utf8 (see the caveats in
267the description of C<sql_ufetch>, though).
253 268
254=item sql_exists "<table> where ...", args... 269=item sql_exists "<table_references> where <where_condition>...", args...
255 270
256=item sql_uexists <see sql_exists> 271=item sql_uexists <see sql_exists>
257 272
258Check wether the result of the sql-statement "select xxx from 273Check wether the result of the sql-statement "select xxx from
259$first_argument" would be empty or not (that is, imagine the string 274$first_argument" would be empty or not (that is, imagine the string
… …
305 320
306=item [old-size] = cachesize [new-size] 321=item [old-size] = cachesize [new-size]
307 322
308Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The 323Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The
309default is somewhere around 50 (= the 50 last recently used statements 324default is somewhere around 50 (= the 50 last recently used statements
310will be cached). It shouldn't be too large, since a simple linear listed 325will be cached). It shouldn't be too large, since a simple linear list
311is used for the cache at the moment (which, for small (<100) cache sizes 326is used for the cache at the moment (which, for small (<100) cache sizes
312is actually quite fast). 327is actually quite fast).
313 328
314The function always returns the cache size in effect I<before> the call, 329The function always returns the cache size in effect I<before> the call,
315so, to nuke the cache (for example, when a database connection has died 330so, to nuke the cache (for example, when a database connection has died
… …
403 418
404Return the login name. 419Return the login name.
405 420
406=item $db->password 421=item $db->password
407 422
408Return the password (emphasizing the fact that the apssword is stored plaintext ;) 423Return the password (emphasizing the fact that the password is stored plaintext ;)
409 424
410=cut 425=cut
411 426
412sub dsn($) { 427sub dsn($) {
413 my $self = shift; 428 my $self = shift;

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines