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 | |
8 | |
… | |
… | |
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 | |
… | |
… | |
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.1241; |
49 | $VERSION = 0.13; |
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 | |
… | |
… | |
111 | __LINE__ work fine as well). |
111 | __LINE__ work fine as well). |
112 | |
112 | |
113 | The reason C<$id> is necessary is that you might specify special connect |
113 | 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 |
114 | arguments or special flags, or you might want to configure your $DBH |
115 | differently than maybe other applications requesting the same database |
115 | differently than maybe other applications requesting the same database |
116 | connection. If none of this is becessary for your application you can |
116 | connection. If none of this is necessary for your application you can |
117 | leave $id empty (i.e. ""). |
117 | leave C<$id> empty (i.e. ""). |
118 | |
118 | |
119 | If specified, C<$connect> is a callback (e.g. a coderef) that will be |
119 | 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 |
120 | called each time a new connection is being established, with the new |
121 | C<$dbh> as first argument. |
121 | C<$dbh> as first argument. |
122 | |
122 | |
123 | Examples: |
123 | Examples: |
124 | |
124 | |
125 | # try your luck opening the papp database without access info |
125 | # try your luck opening the papp database without access info |
126 | $dbh = connect_cached __FILE__, "DBI:mysql:papp"; |
126 | $dbh = connect_cached __FILE__, "DBI:mysql:papp"; |
127 | |
127 | |
128 | Mysql-specific behaviour: The default setting of mysql_client_found_rows |
128 | Mysql-specific behaviour: The default setting of |
129 | is TRUE, you can overwrite this, though. |
129 | C<mysql_client_found_rows> is TRUE, you can overwrite this, though. |
130 | |
130 | |
131 | =cut |
131 | =cut |
132 | |
132 | |
133 | sub connect_cached { |
133 | sub connect_cached { |
134 | my ($id, $dsn, $user, $pass, $flags, $connect) = @_; |
134 | my ($id, $dsn, $user, $pass, $flags, $connect) = @_; |
… | |
… | |
163 | statement handle. The command and the statement handle will be cached |
163 | 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 |
164 | (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 |
165 | 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> |
166 | 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 |
167 | 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. |
168 | called), the statement handle for the first call mustn't not be in use |
|
|
169 | anymore, as the subsequent call will re-use the handle. |
169 | |
170 | |
170 | The database handle (the first argument) is optional. If it is missing, |
171 | 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 (= |
172 | C<sql_exec> first tries to use the variable C<$DBH> in the current (= |
172 | calling) package and, if that fails, it tries to use database handle in |
173 | calling) package and, if that fails, it tries to use database handle in |
173 | C<$PApp::SQL::DBH>, which you can set before calling these functions. |
174 | C<$PApp::SQL::DBH>, which you can set before calling these functions. |
… | |
… | |
220 | my($name, $amount) = sql_fetch "select ...", args... |
221 | my($name, $amount) = sql_fetch "select ...", args... |
221 | |
222 | |
222 | ... and it's still quite fast unless you fetch large amounts of data. |
223 | ... and it's still quite fast unless you fetch large amounts of data. |
223 | |
224 | |
224 | C<sql_ufetch> is similar to C<sql_fetch> but upgrades all input values to |
225 | 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 | utf8 and forces all result values to utf8 (this does I<not> include result |
|
|
227 | parameters, only return values. Using bind variables in cinjunction with |
|
|
228 | sql_u* functions results in undefined behaviour). |
226 | |
229 | |
227 | =item sql_fetchall <see sql_exec> |
230 | =item sql_fetchall <see sql_exec> |
228 | |
231 | |
229 | =item sql_ufetchall <see sql_uexec> |
232 | =item sql_ufetchall <see sql_uexec> |
230 | |
233 | |
… | |
… | |
247 | for (sql_fetchall "select name, age, place from user") { |
250 | for (sql_fetchall "select name, age, place from user") { |
248 | my ($name, $age, $place) = @$_; |
251 | my ($name, $age, $place) = @$_; |
249 | } |
252 | } |
250 | |
253 | |
251 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
254 | C<sql_ufetchall> is similar to C<sql_fetchall> but upgrades all input |
252 | values to utf8 and forces all result values to utf8. |
255 | values to utf8 and forces all result values to utf8 (see the caveats in |
|
|
256 | the description of C<sql_ufetch>, though). |
253 | |
257 | |
254 | =item sql_exists "<table> where ...", args... |
258 | =item sql_exists "<table_references> where <where_condition>...", args... |
255 | |
259 | |
256 | =item sql_uexists <see sql_exists> |
260 | =item sql_uexists <see sql_exists> |
257 | |
261 | |
258 | Check wether the result of the sql-statement "select xxx from |
262 | Check wether the result of the sql-statement "select xxx from |
259 | $first_argument" would be empty or not (that is, imagine the string |
263 | $first_argument" would be empty or not (that is, imagine the string |