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.23 by root, Sun Apr 7 16:23:56 2002 UTC vs.
Revision 1.32 by root, Thu Sep 1 08:57:28 2005 UTC

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.13; 49 $VERSION = 1.0;
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(
62our $DBH; # the default database handle 62our $DBH; # the default database handle
63our $Database; # the current SQL::Database object, if applicable 63our $Database; # the current SQL::Database object, if applicable
64 64
65our %dbcache; 65our %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
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
89be nice as a placeholder for the database object that corresponds to 88be 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
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 not be in use 167called), the statement handle for the first call mustn't not be in use
169anymore, as the subsequent call will re-use the handle. 168anymore, as the subsequent call will re-use the handle.
170 169
171The database handle (the first argument) is optional. If it is missing, 170The database handle (the first argument) is optional. If it is missing,
172C<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
173calling) package and, if that fails, it tries to use database handle in 172before calling these functions. NOTICE: future and former versions of
174C<$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
175 184
176The 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
177package-global (and exported) variable C<$sql_exec>. 186package-global (and exported) variable C<$sql_exec>.
178 187
179If any error occurs C<sql_exec> will throw an exception. 188If any error occurs C<sql_exec> will throw an exception.
180 189
181C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to 190C<sql_uexec> is similar to C<sql_exec> but upgrades all input arguments to
182utf8 before calling the C<execute> method. 191UTF-8 before calling the C<execute> method.
183 192
184Examples: 193Examples:
185 194
186 # easy one 195 # easy one
187 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;
221 my($name, $amount) = sql_fetch "select ...", args... 230 my($name, $amount) = sql_fetch "select ...", args...
222 231
223... 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.
224 233
225C<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
226utf8 and forces all result values to utf8 (this does I<not> include result 235UTF-8 and forces all result values to UTF-8 (this does I<not> include result
227parameters, only return values. Using bind variables in cinjunction with 236parameters, only return values. Using bind variables in conjunction with
228sql_u* functions results in undefined behaviour). 237sql_u* functions might result in undefined behaviour - we use UTF-8 on
238bind-variables at execution time and it seems to work on DBD::mysql as it
239ignores the UTF-8 bit completely. Which just means that that DBD-driver is
240broken).
229 241
230=item sql_fetchall <see sql_exec> 242=item sql_fetchall <see sql_exec>
231 243
232=item sql_ufetchall <see sql_uexec> 244=item sql_ufetchall <see sql_uexec>
233 245
250 for (sql_fetchall "select name, age, place from user") { 262 for (sql_fetchall "select name, age, place from user") {
251 my ($name, $age, $place) = @$_; 263 my ($name, $age, $place) = @$_;
252 } 264 }
253 265
254C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input 266C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input
255values to utf8 and forces all result values to utf8 (see the caveats in 267values to UTF-8 and forces all result values to UTF-8 (see the caveats in
256the description of C<sql_ufetch>, though). 268the description of C<sql_ufetch>, though).
257 269
258=item sql_exists "<table_references> where <where_condition>...", args... 270=item sql_exists "<table_references> where <where_condition>...", args...
259 271
260=item sql_uexists <see sql_exists> 272=item sql_uexists <see sql_exists>
264"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
265with every database but can be quite slow, except on mysql, where this 277with every database but can be quite slow, except on mysql, where this
266should be quite fast. 278should be quite fast.
267 279
268C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to 280C<sql_uexists> is similar to C<sql_exists> but upgrades all parameters to
269utf8. 281UTF-8.
270 282
271Examples: 283Examples:
272 284
273 print "user 7 exists!\n" 285 print "user 7 exists!\n"
274 if sql_exists "user where id = ?", 7; 286 if sql_exists "user where id = ?", 7;
309 321
310=item [old-size] = cachesize [new-size] 322=item [old-size] = cachesize [new-size]
311 323
312Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The 324Returns (and possibly changes) the LRU cache size used by C<sql_exec>. The
313default is somewhere around 50 (= the 50 last recently used statements 325default is somewhere around 50 (= the 50 last recently used statements
314will be cached). It shouldn't be too large, since a simple linear listed 326will be cached). It shouldn't be too large, since a simple linear list
315is used for the cache at the moment (which, for small (<100) cache sizes 327is used for the cache at the moment (which, for small (<100) cache sizes
316is actually quite fast). 328is actually quite fast).
317 329
318The function always returns the cache size in effect I<before> the call, 330The function always returns the cache size in effect I<before> the call,
319so, to nuke the cache (for example, when a database connection has died 331so, to nuke the cache (for example, when a database connection has died
346 358
347reinitialize; 359reinitialize;
348 360
349package PApp::SQL::Database; 361package PApp::SQL::Database;
350 362
351=head2 THE DATABASE CLASS 363=head2 The Database Class
352 364
353Again (sigh) the problem of persistency. What do you do when you have 365Again (sigh) the problem of persistency. What do you do when you have
354to serialize on object that contains (or should contain) a database 366to serialize on object that contains (or should contain) a database
355handle? Short answer: you don't. Long answer: you can embed the necessary 367handle? Short answer: you don't. Long answer: you can embed the necessary
356information to recreate the dbh when needed. 368information to recreate the dbh when needed.
407 419
408Return the login name. 420Return the login name.
409 421
410=item $db->password 422=item $db->password
411 423
412Return the password (emphasizing the fact that the apssword is stored plaintext ;) 424Return the password (emphasizing the fact that the password is stored plaintext ;)
413 425
414=cut 426=cut
415 427
416sub dsn($) { 428sub dsn($) {
417 my $self = shift; 429 my $self = shift;
438 450
439L<PApp>. 451L<PApp>.
440 452
441=head1 AUTHOR 453=head1 AUTHOR
442 454
443 Marc Lehmann <pcg@goof.com> 455 Marc Lehmann <schmorp@schmorp.de>
444 http://www.goof.com/pcg/marc/ 456 http://home.schmorp.de/
445 457
446=cut 458=cut
447 459

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines