update pod
|
1 |
=encoding utf8 |
2 | ||
added DBIx::Custom::Guides
|
3 |
=head1 NAME |
4 | ||
update pod
|
5 |
DBIx::Custom::Guide - DBIx::Custom Guide |
added DBIx::Custom::Guides
|
6 | |
pod fix
|
7 |
=head1 GUIDE |
added DBIx::Custom::Guides
|
8 | |
update pod
|
9 |
B<This guide is now writing.> |
update pod
|
10 | |
update pod
|
11 |
L<DBIx::Custom> is the class to make easy to execute SQL. |
12 |
This is L<DBI> wrapper class like L<DBIx::Class> or L<DBIx::Simple>. |
|
13 |
You can do thing more easy than L<DBIx::Class>, more flexible |
|
14 |
than L<DBIx::Simple>. |
|
added DBIx::Custom::Guides
|
15 | |
update pod
|
16 |
L<DBIx::Custom> is B<not< O/R mapper, O/R mapper is usefule, but |
17 |
you must learn many things. Created SQL is sometimes inefficient, |
|
18 |
and in many cases you create raw SQL because |
|
19 |
O/R mapper can't make complex SQL |
|
added DBIx::Custom::Guides
|
20 | |
update pod
|
21 |
L<DBIx::Custom> is opposit of O/R mapper. |
22 |
The main purpose is that we respect SQL |
|
23 |
and make easy difficult works if you use only L<DBI>. |
|
24 |
If you already learn SQL, it is easy to use L<DBIx::Custom>. |
|
deprecated DBIx::Custom::MyS...
|
25 | |
update pod
|
26 |
I explain L<DBIx::Custom> a little in this section. |
27 |
In L<DBIx::Custom>, you embbed tag in SQL. |
|
deprecated DBIx::Custom::MyS...
|
28 | |
update pod
|
29 |
select * from book where {= title} and {=author}; |
deprecated DBIx::Custom::MyS...
|
30 | |
update pod
|
31 |
The part arround {} is tag. |
32 |
This SQL is converted to the one which contains place holder. |
|
33 | ||
34 |
select * from book where title = ? and author = ?; |
|
35 | ||
36 |
Maybe you ask me that this conversion is meaningful. |
|
37 |
On the top of this, usuful features is implemented. |
|
38 |
See the following descriptions. |
|
39 | ||
40 |
=over 4 |
|
41 | ||
42 |
=item 1. Specify place holder binding value as hash refernce |
|
43 | ||
44 |
If you use L<DBI>, you must specify place holder binding value |
|
45 |
as array. |
|
46 | ||
47 |
$sth->execute(@bind); |
|
48 | ||
49 |
If you use L<DBIx::Custom>, you specify it as hash reference. |
|
50 |
|
|
51 |
my $param = {title => 'Perl', author => 'Ken'}; |
|
52 |
$dbi->execute($sql, $param); |
|
53 | ||
54 |
=item 2. Filtering |
|
55 | ||
56 |
L<DBIx::Custom> provides filtering system. |
|
57 |
For example, You think that about date value you want to |
|
58 |
manipulate it as date object like L<Time::Piece> in Perl, |
|
59 |
and want to convert it to database DATE format. |
|
60 |
and want to do reverse. |
|
61 | ||
62 |
You can use filtering system. |
|
63 | ||
64 |
At first, register filter. |
|
65 | ||
66 |
$dbi->register_filter( |
|
67 |
tp_to_date => sub { |
|
68 |
... |
|
69 |
}, |
|
70 |
date_to_tp => sub { |
|
71 |
... |
|
72 |
} |
|
73 |
); |
|
74 | ||
75 |
next, apply this filter to each column. |
|
76 | ||
77 |
$dbi->apply_filter('book', |
|
78 |
'issue_date' => {out => 'tp_to_date', in => 'date_to_tp'} |
|
79 |
); |
|
80 | ||
81 |
C<out> is perl-to-database way. C<in> is perl-from-database way. |
|
82 | ||
83 |
This filter is automatically enabled in many method. |
|
84 | ||
85 |
$dbi->insert(table => 'book', param => {issue_date => $tp}); |
|
86 | ||
87 | ||
88 |
=item 3. Selective search condition |
|
89 | ||
90 |
It is difficult to create selective where clause in L<DBI>. |
|
91 |
For example, If C<title> and C<author> is specified, we create |
|
92 |
the following SQL. |
|
93 | ||
94 |
select * from book where title = ? and author = ?; |
|
95 | ||
96 |
If only C<title> is specified, the following one |
|
97 | ||
98 |
select * from book where title = ?; |
|
99 | ||
100 |
If only C<author> is specified, the following one, |
|
101 | ||
102 |
select * from book where author = ?; |
|
103 | ||
104 |
This is hard work. Generally we use modules like L<SQL::Abstract>. |
|
105 |
L<DBIx::Custom> prepare the way to make it easy. |
|
106 | ||
107 |
# Where object |
|
108 |
my $where = $dbi->where; |
|
109 |
|
|
110 |
# Search condition |
|
111 |
$where->clause( |
|
112 |
['and', '{= title}', {'= author'}] |
|
113 |
); |
|
114 |
|
|
115 |
# Setting to automatically select needed column |
|
116 |
$where->param({title => 'Perl'}); |
|
117 | ||
118 |
# Embbed where clause to SQL |
|
119 |
my $sql = "select * from book $where"; |
|
120 | ||
121 |
You can create where clause which has selected search condition. |
|
122 |
You can write nesting of where clause and C<or> condition |
|
123 | ||
update pod
|
124 |
=item 4. Methods for insert, update, delete, select |
update pod
|
125 | |
update pod
|
126 |
L<DBIx::Custom> provides methods for insert, update, delete, select |
127 |
There are C<insert()>, C<update()>, C<delete()>,C<select()>. |
|
update pod
|
128 | |
129 |
my $param = {title => 'Perl', author => 'Ken'}; |
|
130 |
$dbi->insert(table => 'book', param => $param); |
|
131 | ||
update pod
|
132 |
=item 5. Register method for table. |
deprecated DBIx::Custom::MyS...
|
133 | |
update pod
|
134 |
You can register method for table. |
update pod
|
135 | |
update pod
|
136 |
$dbi->table('book')->method( |
update pod
|
137 |
list => sub { |
138 |
... |
|
139 |
}, |
|
update pod
|
140 |
something => sub { |
141 |
... |
|
update pod
|
142 |
} |
143 |
); |
|
144 | ||
update pod
|
145 |
use the mehtod. |
update pod
|
146 | |
147 |
$dbi->table('book')->list; |
|
148 | ||
update pod
|
149 |
Many O/R mapper must create class for table, |
150 |
but L<DBIx::Custom> make it easy. |
|
update pod
|
151 | |
152 |
=back |
|
153 | ||
update pod
|
154 |
L<DBIx::Custom> is very useful. |
155 |
See the following if you are interested in it. |
|
update pod
|
156 | |
update pod
|
157 |
=head2 1. Connect to database |
update pod
|
158 | |
update pod
|
159 |
Load L<DBIx::Custom>. |
update pod
|
160 | |
161 |
use DBIx::Custom; |
|
162 | ||
update pod
|
163 |
use C<connect()> to connect to database. |
164 |
Return value is L<DBIx::Custom> object. |
|
update pod
|
165 | |
166 |
my $dbi = DBIx::Custom->connect( |
|
update pod
|
167 |
data_source => "dbi:mysql:database=bookstore", |
update pod
|
168 |
user => 'ken', |
169 |
password => '!LFKD%$&', |
|
170 |
dbi_options => {mysql_enable_utf8 => 1} |
|
171 |
); |
|
172 | ||
update pod
|
173 |
C<data_source> must be one corresponding to the database system. |
174 |
The following ones are data source example. |
|
update pod
|
175 | |
176 |
B<MySQL> |
|
remove DBIx::Custom::Model
|
177 | |
178 |
"dbi:mysql:database=$database" |
|
179 |
"dbi:mysql:database=$database;host=$hostname;port=$port" |
|
180 | ||
update pod
|
181 |
B<SQLite> |
182 | ||
183 |
"dbi:SQLite:dbname=$database" |
|
184 |
"dbi:SQLite:dbname=:memory:" |
|
185 | ||
186 |
B<PostgreSQL> |
|
deprecated DBIx::Custom::MyS...
|
187 | |
188 |
"dbi:Pg:dbname=$dbname" |
|
189 | ||
update pod
|
190 |
B<Oracle> |
deprecated DBIx::Custom::MyS...
|
191 | |
192 |
"dbi:Oracle:$dbname" |
|
193 |
"dbi:Oracle:host=$host;sid=$sid" |
|
194 | ||
update pod
|
195 |
B<ODBC(Microsoft Access)> |
deprecated DBIx::Custom::MyS...
|
196 | |
197 |
"dbi:ODBC:driver=Microsoft Access Driver (*.mdb);dbq=hoge.mdb" |
|
198 | ||
update pod
|
199 |
B<ODBC(SQL Server)> |
deprecated DBIx::Custom::MyS...
|
200 | |
201 |
"dbi:ODBC:driver={SQL Server};Server=(local);database=test;Trusted_Connection=yes;AutoTranslate=No;" |
|
added DBIx::Custom::Guides
|
202 | |
update pod
|
203 |
If authentication is needed, you can specify C<user> and C<password> |
204 | ||
205 |
L<DBIx::Custom> is wrapper class of L<DBI>. |
|
206 |
You can use all methods of L<DBI> from L<DBIx::Custom> object. |
|
207 | ||
208 |
$dbi->do(...); |
|
209 |
$dbi->begin_work; |
|
update pod
|
210 | |
update pod
|
211 |
use C<dhb()> to get database handle of L<DBI> |
added DBIx::Custom::Guides
|
212 | |
update pod
|
213 |
my $dbh = $dbi->dbh; |
added DBIx::Custom::Guides
|
214 | |
update pod
|
215 |
By default, the following ones is set to database handle attributes. |
216 | ||
217 |
RaiseError -> 1 |
|
218 |
PrintError -> 0 |
|
219 |
AutoCommit -> 1 |
|
added DBIx::Custom::Guides
|
220 | |
update pod
|
221 |
If fatal error occuer, program terminate. |
222 |
If SQL is executed, commit is executed automatically. |
|
update pod
|
223 | |
update pod
|
224 |
=head2 2. Methods for insert, update, delete, or insert |
update pod
|
225 | |
update pod
|
226 |
There are following methods. |
update pod
|
227 | |
update pod
|
228 |
=head3 C<insert()> |
update pod
|
229 | |
update pod
|
230 |
use C<insert()> to insert row into database |
added DBIx::Custom::Guides
|
231 | |
remove DBIx::Custom::Model
|
232 |
$dbi->insert(table => 'book', |
added DBIx::Custom::Guides
|
233 |
param => {title => 'Perl', author => 'Ken'}); |
234 | ||
update pod
|
235 |
C<table> is table name, C<param> is insert data. |
added DBIx::Custom::Guides
|
236 | |
update pod
|
237 |
Following SQL is executed. |
added DBIx::Custom::Guides
|
238 | |
update pod
|
239 |
insert into (title, author) values (?, ?); |
added DBIx::Custom::Guides
|
240 | |
update pod
|
241 |
=head3 C<update()> |
added DBIx::Custom::Guides
|
242 | |
update pod
|
243 |
use C<update()> to update row in database. |
added DBIx::Custom::Guides
|
244 | |
remove DBIx::Custom::Model
|
245 |
$dbi->update(table => 'book', |
added DBIx::Custom::Guides
|
246 |
param => {title => 'Perl', author => 'Ken'}, |
247 |
where => {id => 5}); |
|
248 | ||
update pod
|
249 |
C<table> is table name, C<param> is update data, C<where> is condition. |
added DBIx::Custom::Guides
|
250 | |
update pod
|
251 |
Following SQL is executed. |
added DBIx::Custom::Guides
|
252 | |
update pod
|
253 |
update book set title = ?, author = ?; |
added DBIx::Custom::Guides
|
254 | |
update pod
|
255 |
You can't execute C<update()> without C<where> for safety. |
256 |
use C<update_all()> if you want to update all rows. |
|
added DBIx::Custom::Guides
|
257 | |
update pod
|
258 |
$dbi->update_all(table => 'book', |
259 |
param => {title => 'Perl', author => 'Ken'}); |
|
added DBIx::Custom::Guides
|
260 | |
update pod
|
261 |
=head3 C<delete()> |
added DBIx::Custom::Guides
|
262 | |
update pod
|
263 |
use C<delete()> to delete rows from database. |
added DBIx::Custom::Guides
|
264 | |
remove DBIx::Custom::Model
|
265 |
$dbi->delete(table => 'book', |
added DBIx::Custom::Guides
|
266 |
where => {author => 'Ken'}); |
267 | ||
update pod
|
268 |
C<table> is table name, C<where> is condition. |
added DBIx::Custom::Guides
|
269 | |
update pod
|
270 |
Following SQL is executed. |
added DBIx::Custom::Guides
|
271 | |
update pod
|
272 |
delete from book where id = ?; |
added DBIx::Custom::Guides
|
273 | |
update pod
|
274 |
You can't execute C<delete()> without C<where> for safety. |
275 |
use C<delete_all()> if you want to delete all rows. |
|
added DBIx::Custom::Guides
|
276 | |
update pod
|
277 |
$dbi->delete_all(table => 'book'); |
added DBIx::Custom::Guides
|
278 | |
update pod
|
279 |
=head3 C<select()> |
added DBIx::Custom::Guides
|
280 | |
update pod
|
281 |
use C<select()> to select rows from database |
added DBIx::Custom::Guides
|
282 | |
remove DBIx::Custom::Model
|
283 |
my $result = $dbi->select(table => 'book'); |
added DBIx::Custom::Guides
|
284 | |
update pod
|
285 |
Following SQL is executed. |
added DBIx::Custom::Guides
|
286 | |
remove DBIx::Custom::Model
|
287 |
select * from book; |
added DBIx::Custom::Guides
|
288 | |
update pod
|
289 |
Return value is L<DBIx::Custom::Result> object. |
290 |
use C<fetch()> to fetch row. |
|
added DBIx::Custom::Guides
|
291 | |
292 |
while (my $row = $result->fetch) { |
|
293 |
my $title = $row->[0]; |
|
294 |
my $author = $row->[1]; |
|
295 |
} |
|
296 | ||
update pod
|
297 |
See L<3. Fetch row/"3. Fetch row"> about L<DBIx::Custom::Result>. |
added DBIx::Custom::Guides
|
298 | |
update pod
|
299 |
Continue more examples. |
added DBIx::Custom::Guides
|
300 | |
301 |
my $result = $dbi->select( |
|
remove DBIx::Custom::Model
|
302 |
table => 'book', |
update pod
|
303 |
column => ['author', 'title'], |
added DBIx::Custom::Guides
|
304 |
where => {author => 'Ken'} |
305 |
); |
|
306 | ||
update pod
|
307 |
C<column> is column names, C<where> is condition. |
308 | ||
309 |
Following SQL is executed. |
|
added DBIx::Custom::Guides
|
310 | |
remove DBIx::Custom::Model
|
311 |
select author, title from book where author = ?; |
added DBIx::Custom::Guides
|
312 | |
update pod
|
313 |
Next example. |
added DBIx::Custom::Guides
|
314 | |
315 |
my $result = $dbi->select( |
|
remove DBIx::Custom::Model
|
316 |
table => ['book', 'rental'], |
update pod
|
317 |
where => {'book.name' => 'Perl'}, |
remove DBIx::Custom::Model
|
318 |
relation => {'book.id' => 'rental.book_id'} |
added DBIx::Custom::Guides
|
319 |
); |
320 | ||
update pod
|
321 |
C<relation> is relation of tables. This is inner join. |
322 | ||
323 |
Following SQL is executed. |
|
added DBIx::Custom::Guides
|
324 | |
update pod
|
325 |
select * from book, rental where book.name = ? and book.id = rental.book_id; |
added DBIx::Custom::Guides
|
326 | |
update pod
|
327 |
Next example. |
added DBIx::Custom::Guides
|
328 | |
329 |
my $result = $dbi->select( |
|
remove DBIx::Custom::Model
|
330 |
table => 'book', |
added DBIx::Custom::Guides
|
331 |
where => {author => 'Ken'}, |
update pod
|
332 |
append => 'for update', |
added DBIx::Custom::Guides
|
333 |
); |
334 | ||
update pod
|
335 |
C<append> is string appending to end of SQL. |
336 | ||
337 |
Following SQL is executed. |
|
added DBIx::Custom::Guides
|
338 | |
update pod
|
339 |
select * book where author = ? for update; |
added DBIx::Custom::Guides
|
340 | |
update pod
|
341 |
C<appned> is also used at C<insert()>, C<update()>, C<update_all()> |
342 |
C<delete()>, C<delete_all()>, and C<select()>. |
|
added DBIx::Custom::Guides
|
343 | |
update pod
|
344 |
Instead of C<column> and C<table>, |
345 |
you can use C<selection>. |
|
346 |
This is used to specify column names and table names at once |
|
347 | ||
348 |
my $selection = <<"EOS"; |
|
349 |
title, author, company_name |
|
350 |
from book inner join company on book.company_id = company.id |
|
351 |
EOS |
|
352 | ||
353 |
$dbi->select(selection => $selection); |
|
354 | ||
355 |
Note that you can't use where clause in C<selection>. |
|
356 |
use clause like "inner join". |
|
357 | ||
update pod
|
358 |
=head3 C<execute()> SQL |
added DBIx::Custom::Guides
|
359 | |
update pod
|
360 |
use C<execute()> to execute SQL |
update pod
|
361 | |
362 |
$dbi->execute("select * from book;"); |
|
363 | ||
update pod
|
364 |
Process tag and execute SQL. |
update pod
|
365 | |
366 |
$dbi->execute( |
|
367 |
"select * from book {= title} and {= author};" |
|
368 |
param => {title => 'Perl', author => 'Ken'} |
|
369 |
); |
|
370 | ||
update pod
|
371 |
Following SQL is executed. |
update pod
|
372 | |
373 |
select * from book title = ? and author = ?; |
|
374 | ||
update pod
|
375 |
Values of title and author is embbdeded into placeholder. |
update pod
|
376 | |
update pod
|
377 |
See L<5. Tag/"5. Tag"> about tag. |
update pod
|
378 | |
update pod
|
379 |
You don't have to wirte last semicolon in C<execute()>. |
update pod
|
380 | |
381 |
$dbi->execute('select * from book'); |
|
382 | ||
update pod
|
383 |
=head2 3. Fetch row |
update pod
|
384 | |
update pod
|
385 |
Return value of C<select()> is L<DBIx::Custom::Result> object. |
386 |
There are many methods to fetch row. |
|
update pod
|
387 | |
update pod
|
388 |
=head3 Fetch a row (array) C<fetch()> |
update pod
|
389 | |
update pod
|
390 |
use C<fetch()> to fetch a row and assign it into array reference. |
391 | ||
392 |
my $row = $result->fetch; |
|
393 | ||
394 |
You can get all rows. |
|
added DBIx::Custom::Guides
|
395 | |
396 |
while (my $row = $result->fetch) { |
|
update pod
|
397 |
my $title = $row->[0]; |
398 |
my $author = $row->[1]; |
|
added DBIx::Custom::Guides
|
399 |
} |
400 | ||
update pod
|
401 |
=head3 Fetch only first row (array) C<fetch_first()> |
update pod
|
402 | |
update pod
|
403 |
use C<fetch_first()> to fetch only first row. |
added DBIx::Custom::Guides
|
404 | |
405 |
my $row = $result->fetch_first; |
|
406 | ||
update pod
|
407 |
You can't fetch rest rows |
408 |
because statement handle C<finish()> is executed. |
|
added DBIx::Custom::Guides
|
409 | |
update pod
|
410 |
=head3 Fetch rows (array) C<fetch_multi()> |
update pod
|
411 | |
update pod
|
412 |
use C<fetch_multi()> to fetch rows and assign it into |
413 |
array reference which has array references as element. |
|
update pod
|
414 | |
415 |
while (my $rows = $result->fetch_multi(2)) { |
|
416 |
my $title0 = $rows->[0][0]; |
|
417 |
my $author0 = $rows->[0][1]; |
|
418 |
|
|
419 |
my $title1 = $rows->[1][0]; |
|
420 |
my $author1 = $rows->[1][1]; |
|
added DBIx::Custom::Guides
|
421 |
} |
update pod
|
422 | |
update pod
|
423 |
Specify row count as argument. |
update pod
|
424 | |
update pod
|
425 |
You can get the following data. |
update pod
|
426 | |
427 |
[ |
|
428 |
['Perl', 'Ken'], |
|
429 |
['Ruby', 'Mark'] |
|
430 |
] |
|
431 | ||
update pod
|
432 |
=head3 Fetch all rows (array) C<fetch_all> |
update pod
|
433 | |
update pod
|
434 |
use C<fetch_all()> to fetch all rows and assign it into |
435 |
array reference which has array reference as element. |
|
added DBIx::Custom::Guides
|
436 | |
437 |
my $rows = $result->fetch_all; |
|
438 | ||
update pod
|
439 |
You can get the following data. |
update pod
|
440 | |
441 |
[ |
|
442 |
['Perl', 'Ken'], |
|
443 |
['Ruby', 'Mark'] |
|
444 |
] |
|
445 | ||
update pod
|
446 |
=head3 Fetch a row (hash) C<fetch_hash()> |
update pod
|
447 | |
update pod
|
448 |
use C<fetch_hash()> to fetch a row and assign it into hash reference. |
added DBIx::Custom::Guides
|
449 | |
450 |
while (my $row = $result->fetch_hash) { |
|
451 |
my $title = $row->{title}; |
|
452 |
my $author = $row->{author}; |
|
453 |
} |
|
454 | ||
update pod
|
455 |
=head3 Fetch only first row (hash) C<fetch_hash_first()> |
update pod
|
456 | |
update pod
|
457 |
use C<fetch_hash_first()> to fetch only first row |
458 |
and assign it into hash reference. |
|
added DBIx::Custom::Guides
|
459 | |
460 |
my $row = $result->fetch_hash_first; |
|
update pod
|
461 | |
update pod
|
462 |
You can't fetch rest rows |
463 |
because statement handle C<finish()> is executed. |
|
update pod
|
464 | |
update pod
|
465 |
=head3 Fetch rows (hash) C<fetch_hash_multi()> |
update pod
|
466 | |
update pod
|
467 |
use C<fetch_hash_multi()> to fetch rows and |
468 |
assign it into array reference which has hash references as element. |
|
added DBIx::Custom::Guides
|
469 | |
470 |
while (my $rows = $result->fetch_hash_multi(5)) { |
|
update pod
|
471 |
my $title0 = $rows->[0]{title}; |
472 |
my $author0 = $rows->[0]{author}; |
|
473 |
my $title1 = $rows->[1]{title}; |
|
474 |
my $author1 = $rows->[1]{author}; |
|
added DBIx::Custom::Guides
|
475 |
} |
update pod
|
476 | |
update pod
|
477 |
Specify row count as argument. |
update pod
|
478 | |
update pod
|
479 |
You can get the following data. |
update pod
|
480 | |
481 |
[ |
|
482 |
{title => 'Perl', author => 'Ken'}, |
|
483 |
{title => 'Ruby', author => 'Mark'} |
|
484 |
] |
|
485 | ||
update pod
|
486 |
=head3 Fetch all rows (hash) C<fetch_hash_all()> |
update pod
|
487 | |
update pod
|
488 |
use C<fetch_hash_all()> to fetch all rows and |
489 |
assign it into array reference which has hash |
|
490 |
references as element. |
|
added DBIx::Custom::Guides
|
491 | |
492 |
my $rows = $result->fetch_hash_all; |
|
493 | ||
update pod
|
494 |
You can get the following data. |
update pod
|
495 | |
496 |
[ |
|
497 |
{title => 'Perl', author => 'Ken'}, |
|
498 |
{title => 'Ruby', author => 'Mark'} |
|
499 |
] |
|
500 | ||
update pod
|
501 |
=head3 Statement handle C<sth()> |
update pod
|
502 | |
update pod
|
503 |
use <sth()> to get statement handle. |
added DBIx::Custom::Guides
|
504 | |
505 |
my $sth = $result->sth; |
|
506 | ||
update pod
|
507 |
=head2 4. Filtering |
update pod
|
508 | |
update pod
|
509 |
L<DBIx::Custom> provide value filtering. |
510 |
For example, You maybe want to convert L<Time::Piece> object to |
|
511 |
database date format when register data into database. |
|
512 |
and convert database date fromat to L<Time::Piece> object |
|
513 |
when get data from database. |
|
update pod
|
514 | |
update pod
|
515 |
=head3 Register filter C<register_filter()> |
update pod
|
516 | |
update pod
|
517 |
use C<register_filter() to register filter. |
update pod
|
518 | |
519 |
$dbi->register_filter( |
|
520 |
# Time::Piece object to DATE format |
|
521 |
tp_to_date => sub { |
|
522 |
my $date = shift; |
|
523 | ||
524 |
return '0000-00-00' unless $tp; |
|
525 |
return $tp->strftime('%Y-%m-%d'); |
|
526 |
}, |
|
527 |
|
|
528 |
# DATE to Time::Piece object |
|
529 |
date_to_tp => sub { |
|
530 |
my $date = shift; |
|
531 | ||
532 |
return if $date eq '0000-00-00'; |
|
533 |
return Time::Piece->strptime($date, '%Y-%m-%d'); |
|
534 |
}, |
|
535 |
); |
|
added DBIx::Custom::Guides
|
536 | |
update pod
|
537 |
Registered filter is used by C<apply_filter()> or etc. |
added DBIx::Custom::Guides
|
538 | |
update pod
|
539 |
=head3 Apply filter C<apply_filter()> |
added DBIx::Custom::Guides
|
540 | |
update pod
|
541 |
use C<apply_filter()> to apply registered filter. |
update pod
|
542 | |
543 |
$dbi->apply_filter('book', |
|
544 |
issue_date => {out => 'tp_to_date', in => 'date_to_tp'}, |
|
545 |
first_issue_date => {out => 'tp_to_date', in => 'date_to_tp'} |
|
added DBIx::Custom::Guides
|
546 |
); |
547 | ||
update pod
|
548 |
First argument is table name. Arguments after first argument are pairs of column |
549 |
name and fitering rule. C<out> of filtering rule is filter which is used when data |
|
550 |
is send to database. C<in> of filtering rule is filter which is used when data |
|
551 |
is got from database. |
|
552 | ||
553 |
You can specify code reference as filter. |
|
update pod
|
554 | |
555 |
issue_date => {out => sub { ... }, in => sub { ... }} |
|
556 | ||
update pod
|
557 |
Applied filter become effective at insert()>, C<update()>, C<update_all()>, |
558 |
C<delete()>, C<delete_all()>, C<select()>. |
|
update pod
|
559 | |
560 |
my $tp = Time::Piece->strptime('2010/10/14', '%Y/%m/%d'); |
|
update pod
|
561 |
my $result = $dbi->select(table => 'book', where => {issue_date => $tp}); |
update pod
|
562 | |
update pod
|
563 |
When data is send to database, L<Time::Piece> object is converted |
564 |
to database date format "2010-10-14" |
|
update pod
|
565 | |
update pod
|
566 |
When data is fetched, database date format is |
567 |
converted to L<Time::Piece> object. |
|
update pod
|
568 | |
569 |
my $row = $resutl->fetch_hash_first; |
|
570 |
my $tp = $row->{issue_date}; |
|
571 | ||
update pod
|
572 |
You can also use column name which contains table name. |
update pod
|
573 | |
574 |
$dbi->select( |
|
575 |
table => 'book', |
|
update pod
|
576 |
where => {'book.issue_date' => $tp} |
update pod
|
577 |
); |
578 | ||
update pod
|
579 |
In fetching, Filter is effective if you use "TABLE__COLUMN" as column name. |
580 | ||
581 |
my $result = $dbi->execute( |
|
582 |
"select issue_date as book__issue_date from book"); |
|
583 | ||
584 |
You can apply C<end> filter execute after C<in> filter. |
|
585 | ||
586 |
$dbi->apply_filter('book', |
|
587 |
issue_date => {out => 'tp_to_date', in => 'date_to_tp', |
|
588 |
end => 'tp_to_displaydate'}, |
|
589 |
); |
|
590 | ||
update pod
|
591 |
=head3 Individual filter C<filter> |
update pod
|
592 | |
update pod
|
593 |
You can apply individual filter . |
594 |
This filter overwrite the filter by C<apply_filter()> |
|
update pod
|
595 | |
update pod
|
596 |
use C<filter> option to apply individual filter |
597 |
when data is send to database. |
|
598 |
This option is used at C<insert()>, C<update()>, |
|
599 |
C<update_all()>, C<delete()>, C<delete_all()>, C<select()>, |
|
600 |
C<execute()>. |
|
update pod
|
601 | |
update pod
|
602 |
C<insert()> example: |
update pod
|
603 | |
604 |
$dbi->insert( |
|
605 |
table => 'book', |
|
606 |
param => {issue_date => $tp, first_issue_date => $tp}, |
|
607 |
filter => {issue_date => 'tp_to_date', first_issue_date => 'tp_to_date'} |
|
608 |
); |
|
added DBIx::Custom::Guides
|
609 | |
update pod
|
610 |
C<execute()> example: |
update pod
|
611 | |
612 |
my $sql = <<"EOS"; |
|
613 |
select YEAR(issue_date) as issue_year |
|
614 |
from book |
|
615 |
where YEAR(issue_date) = {? issue_year} |
|
616 |
EOS |
|
617 |
|
|
added DBIx::Custom::Guides
|
618 |
my $result = $dbi->execute( |
update pod
|
619 |
$sql, |
620 |
param => {issue_year => '2010'}, |
|
621 |
filter => {issue_year => 'tp_to_year'} |
|
added DBIx::Custom::Guides
|
622 |
); |
623 | ||
update pod
|
624 |
You can also apply indivisual filter when you fetch row. |
625 |
use C<DBIx::Custom::Result>'s C<filter()>. |
|
added DBIx::Custom::Guides
|
626 | |
update pod
|
627 |
$result->filter(issue_year => 'year_to_tp'); |
added DBIx::Custom::Guides
|
628 | |
update pod
|
629 |
=head3 End filtering : C<end_filter()> |
update pod
|
630 | |
update pod
|
631 |
You can add filter at end. |
632 |
It is useful to create last output. |
|
633 |
use C<end_filter()> to add end filter. |
|
update pod
|
634 | |
635 |
$result->end_filter(issue_date => sub { |
|
636 |
my $tp = shift; |
|
637 |
|
|
638 |
return '' unless $tp; |
|
639 |
return $tp->strftime('%Y/%m/%d %h:%m:%s (%a)'); |
|
640 |
}); |
|
641 | ||
update pod
|
642 |
In this example, L<Time::Piece> object is converted to readable format. |
update pod
|
643 | |
update pod
|
644 |
=head3 Automate applying filter C<each_column()> |
update pod
|
645 | |
update pod
|
646 |
It is useful to apply filter automatically at date type columns. |
647 |
You can use C<each_column()> to process all column infos. |
|
update pod
|
648 | |
649 |
$dbi->each_column( |
|
650 |
sub { |
|
651 |
my ($self, $table, $column, $info) = @_; |
|
652 |
|
|
653 |
my $type = $info->{TYPE_NAME}; |
|
654 |
|
|
655 |
my $filter = $type eq 'DATE' ? {out => 'tp_to_date', in => 'date_to_tp'} |
|
656 |
: $type eq 'DATETIME' ? {out => 'tp_to_datetime', in => 'datetime_to_tp'} |
|
657 |
: undef; |
|
658 |
|
|
659 |
$self->apply_filter($table, $column, $filter) |
|
660 |
if $filter; |
|
661 |
} |
|
662 |
); |
|
663 | ||
update pod
|
664 |
C<each_column() receive callback. |
665 |
callback arguments are L<DBIx::Custom> object, table name, column name, column information. |
|
666 |
Filter is applied automatically by column type. |
|
update pod
|
667 | |
update pod
|
668 |
=head2 5. Tag |
update pod
|
669 | |
update pod
|
670 |
=head3 Basic of Tag |
update pod
|
671 | |
update pod
|
672 |
You can embedd tag into SQL. |
update pod
|
673 | |
674 |
select * from book where {= title} and {like author}; |
|
675 | ||
update pod
|
676 |
{= title} and {like author} are tag. Tag has the folloring format. |
update pod
|
677 | |
update pod
|
678 |
{TAG_NAME ARG1 ARG2 ...} |
update pod
|
679 | |
update pod
|
680 |
Tag start C<{> and end C<}>. |
681 |
Don't insert space between C<{} and tag name. |
|
682 | ||
683 |
C<{> and C<}> are reserved word. |
|
684 |
If you want to use these, escape it by '\'; |
|
update pod
|
685 | |
686 |
select from book \\{ ... \\} |
|
687 | ||
update pod
|
688 |
\ is perl's escape character, you need two \. |
689 | ||
690 |
Tag is expanded before executing SQL. |
|
update pod
|
691 | |
692 |
select * from book where title = ? and author like ?; |
|
693 | ||
update pod
|
694 |
use C<execute()> to execute SQL which contains tag |
update pod
|
695 | |
696 |
my $sql = "select * from book where {= author} and {like title};" |
|
697 |
$dbi->execute($sql, param => {title => 'Perl', author => '%Ken%'}); |
|
698 | ||
update pod
|
699 |
You can specify values embedded into place holder as hash reference using |
700 |
C<param> option. |
|
update pod
|
701 | |
update pod
|
702 |
You can specify C<filter()> at C<execute()>. |
update pod
|
703 | |
704 |
$dbi->execute($sql, param => {title => 'Perl', author => '%Ken%'} |
|
705 |
filter => {title => 'to_something'); |
|
706 | ||
update pod
|
707 |
Note that at C<execute()> the filter applied by C<apply_filter()> |
708 |
don't has effective to columns. |
|
update pod
|
709 |
You have to use C<table> tag in SQL |
update pod
|
710 | |
update pod
|
711 |
my $sql = "select * from {table book} where {= author} and {like title};" |
update pod
|
712 | |
update pod
|
713 |
=head3 Tag list |
update pod
|
714 | |
715 |
L<DBIx::Custom>�ł͎��̃^�O���g�p�\�ł��B |
|
716 | ||
update pod
|
717 |
The following tag is available. |
update pod
|
718 | |
update pod
|
719 |
=head4 C<table> |
720 | ||
721 |
{table NAME} -> NAME |
|
722 | ||
723 |
This is used to specify table name in SQL. |
|
724 |
If you specify table name, Filtering by |
|
725 |
C<apply_filter()> is effective. |
|
726 | ||
update pod
|
727 |
=head4 C<?> |
update pod
|
728 | |
729 |
{? NAME} -> ? |
|
730 | ||
update pod
|
731 |
=head4 C<=> |
update pod
|
732 | |
733 |
{= NAME} -> NAME = ? |
|
734 | ||
update pod
|
735 |
=head4 C<E<lt>E<gt>> |
update pod
|
736 | |
737 |
{<> NAME} -> NAME <> ? |
|
738 | ||
update pod
|
739 |
=head4 C<E<lt>> |
update pod
|
740 | |
741 |
{< NAME} -> NAME < ? |
|
742 | ||
update pod
|
743 |
=head4 C<E<gt>> |
update pod
|
744 | |
745 |
{> NAME} -> NAME > ? |
|
746 | ||
update pod
|
747 |
=head4 C<E<gt>=> |
update pod
|
748 | |
749 |
{>= NAME} -> NAME >= ? |
|
750 | ||
update pod
|
751 |
=head4 C<E<lt>=> |
update pod
|
752 | |
753 |
{<= NAME} -> NAME <= ? |
|
754 | ||
update pod
|
755 |
=head4 C<like> |
update pod
|
756 | |
757 |
{like NAME} -> NAME like ? |
|
758 | ||
update pod
|
759 |
=head4 C<in> |
update pod
|
760 | |
761 |
{in NAME COUNT} -> NAME in [?, ?, ..] |
|
762 | ||
update pod
|
763 |
=head4 C<insert_param> |
update pod
|
764 | |
added DBIx::Custom::Guides
|
765 |
{insert_param NAME1 NAME2} -> (NAME1, NAME2) values (?, ?) |
update pod
|
766 | |
update pod
|
767 |
=head4 C<update_param> |
update pod
|
768 | |
added DBIx::Custom::Guides
|
769 |
{update_param NAME1 NAME2} -> set NAME1 = ?, NAME2 = ? |
770 | ||
update pod
|
771 |
=head3 Manipulate same name's columns |
added DBIx::Custom::Guides
|
772 | |
update pod
|
773 |
It is ok if there are same name's columns. |
774 |
Let's think two date comparison. |
|
added DBIx::Custom::Guides
|
775 | |
update pod
|
776 |
my $sql = "select * from table where {> date} and {< date};"; |
added DBIx::Custom::Guides
|
777 | |
update pod
|
778 |
In this case, You specify paramter values as array reference. |
added DBIx::Custom::Guides
|
779 | |
update pod
|
780 |
my $dbi->execute($sql, param => {date => ['2010-10-01', '2012-02-10']}); |
added DBIx::Custom::Guides
|
781 | |
update pod
|
782 |
=head3 Register Tag C<register_tag()> |
update pod
|
783 | |
update pod
|
784 |
You can register custom tag. |
update pod
|
785 |
use C<register_tag()> to register tag. |
update pod
|
786 | |
787 |
$dbi->register_tag( |
|
788 |
'=' => sub { |
|
789 |
my $column = shift; |
|
790 |
|
|
791 |
return ["$column = ?", [$column]]; |
|
added DBIx::Custom::Guides
|
792 |
} |
793 |
); |
|
794 | ||
update pod
|
795 |
This is implementation of C<=> tag. |
796 |
Tag format is the following one. |
|
added experimental DBIx::Cus...
|
797 | |
update pod
|
798 |
{TAG_NAME ARG1 ARG2 ...} |
added experimental DBIx::Cus...
|
799 | |
update pod
|
800 |
In case C<=> tag. Format is |
cleanup
|
801 | |
update pod
|
802 |
{= title} |
added experimental DBIx::Cus...
|
803 | |
update pod
|
804 |
So subroutine receive one argument "title". |
805 |
You have to return array reference in the following format. |
|
update pod
|
806 | |
807 |
[ |
|
update pod
|
808 |
String after expanding, |
809 |
[COLUMN1(This is used for place holder), COLUMN2 , ...] |
|
update pod
|
810 |
] |
811 | ||
update pod
|
812 |
First element is expanded stirng. In this example, |
update pod
|
813 | |
814 |
'title = ?' |
|
815 | ||
update pod
|
816 |
Secount element is array reference which is used to embedd value to |
817 |
place holder. In this example, |
|
update pod
|
818 | |
819 |
['title'] |
|
820 | ||
update pod
|
821 |
If there are more than one placeholders, |
822 |
This elements is multipul. |
|
update pod
|
823 | |
update pod
|
824 |
You return the following array reference. |
update pod
|
825 | |
826 |
['title = ?', ['title']] |
|
added DBIx::Custom::Guides
|
827 | |
update pod
|
828 |
See source of L<DBIx::Custom::Tag> to see many implementation. |
added DBIx::Custom::Guides
|
829 | |
update pod
|
830 |
=head2 6. Where��̓��I�Ȑ��� |
831 | ||
832 |
=head3 Where��̓��I�Ȑ��� where() |
|
833 | ||
834 |
�����̌�����w�肵�āA�����s�������ꍇ������܂��B |
|
835 |
����3�̃P�[�X��where���l���Ă݂܂��傤�B |
|
836 |
���L�̂悤��where�傪�K�v�ɂȂ�܂��B |
|
837 | ||
838 |
title�̒l�����Ō�������ꍇ |
|
839 | ||
840 |
where {= title} |
|
841 | ||
842 |
author�̒l�����Ō�������ꍇ |
|
843 | ||
844 |
where {= author} |
|
845 | ||
846 |
title��author�̗���̒l�Ō�������ꍇ |
|
847 | ||
848 |
where {= title} and {=author} |
|
849 | ||
850 |
L<DBIx::Custom>�ł͓��I��Where��̐�����T�|�[�g���Ă��܂��B |
|
851 |
�܂�C<where()>��L<DBIx::Custom::Where>�I�u�W�F�N�g�����܂��B |
|
852 | ||
853 |
my $where = $dbi->where; |
|
854 | ||
855 |
����C<clause()>��g�p����where���L�q���܂��B |
|
856 | ||
857 |
$where->clause( |
|
858 |
['and', '{= title'}, '{= author}'] |
|
added DBIx::Custom::Guides
|
859 |
); |
860 | ||
update pod
|
861 |
clause�̎w���@�͎��̂悤�ɂȂ�܂��B |
862 | ||
863 |
['or' ���邢�� 'and', �^�O1, �^�O2, �^�O3] |
|
added DBIx::Custom::Guides
|
864 | |
update pod
|
865 |
����ɂ�or���邢��and��w�肵�܂��B����ȍ~�ɂ� |
866 |
������^�O��g��ċL�q���܂��B |
|
867 | ||
868 |
C<clause>�̎w��͓��q�ɂ��邱�Ƃ�ł��A����ɕ��G�ȏ� |
|
869 |
��L�q���邱�Ƃ�ł��܂��B |
|
870 | ||
871 |
['and', |
|
872 |
'{= title}', |
|
873 |
['or', '{= author}', '{like date}'] |
|
874 |
] |
|
875 | ||
876 |
���̂悤��C<clause>��ݒ肵�����C<param>�Ƀp�����[�^��w�肵�܂��B |
|
added DBIx::Custom::Guides
|
877 |
|
update pod
|
878 |
my $param => {title => 'Perl'}; |
879 |
$where->param($param); |
|
added DBIx::Custom::Guides
|
880 | |
update pod
|
881 |
���̗�ł�title�������p�����[�^�Ɋ܂܂�Ă��܂��B |
added DBIx::Custom::Guides
|
882 | |
update pod
|
883 |
���̌�C<to_string()>���s�����$param�Ɋ܂܂��p�����[�^���� |
884 |
where������邱�Ƃ��ł��܂��B |
|
885 | ||
886 |
my $where_clause = $where->to_string; |
|
887 | ||
888 |
�p�����[�^��title�����ł��̂ŁA���̂悤��where�傪��������܂��B |
|
889 | ||
890 |
where {= title} |
|
891 | ||
892 |
�܂�L<DBIx::Custom>�͕�����̕]����I�[�o�[���[�h���āAC<to_string()> |
|
893 |
��Ăяo���悤�ɂ��Ă��܂��̂ŁA���̂悤�ɂ���where������邱�Ƃ� |
|
894 |
�ł��܂��B |
|
895 | ||
896 |
my $where_clause = "$where"; |
|
897 | ||
898 |
�����SQL�̒���where��ߍ��ނƂ��ɂƂĂ�𗧂@�\�ł��B |
|
added DBIx::Custom::Guides
|
899 | |
update pod
|
900 |
=head3 ����̗�܂ޏꍇ |
check arguments of connect m...
|
901 | |
update pod
|
902 |
�^�O�̒��ɓ���̖��O���̂����݂����ꍇ�ł��I�� |
903 |
where���쐬���邱�Ƃ��ł��܂��B |
|
added experimental DBIx::Cus...
|
904 | |
update pod
|
905 |
���Ƃ��A�p�����[�^�Ƃ��ĊJ�n��t�ƏI����t��������Ƃ� |
906 |
�l���Ă݂Ă��������B |
|
added experimental DBIx::Cus...
|
907 | |
update pod
|
908 |
my $param = {start_date => '2010-11-15', end_date => '2011-11-21'}; |
added experimental DBIx::Cus...
|
909 | |
update pod
|
910 |
�܂��J�n��t�ƏI����t�̕Е���A�ǂ������Ȃ��ꍇ���邩����܂���B |
added experimental DBIx::Cus...
|
911 | |
update pod
|
912 |
���̏ꍇ�͎��̂悤�ȃp�����[�^�ɕϊ����邱�ƂőΉ����邱�Ƃ��ł��܂��B |
913 | ||
914 |
my $p = {date => ['2010-11-15', '2011-11-21']}; |
|
915 | ||
916 |
�l���z��̃��t�@�����X�ɂȂ�Ă��邱�Ƃɒ��ڂ��Ă��������B���̂悤�ɂ���� |
|
917 |
�����̗��܂ރ^�O�ɏ��Ԃɖ��ߍ��ނ��Ƃ��ł��܂��B |
|
918 | ||
919 |
$where->clause( |
|
920 |
['and', '{> date}', '{< date}'] |
|
added experimental DBIx::Cus...
|
921 |
); |
update pod
|
922 |
$where->param($p); |
923 | ||
924 |
�܂��J�n��t�����݂��Ȃ��ꍇ�͎��̂悤�ȃf�[�^��쐬���܂��B |
|
925 | ||
926 |
my $p = {date => [$dbi->not_exists, '2011-11-21']}; |
|
927 | ||
928 |
L<DBIx::Custom>��C<not_exists>��DBIx::Custom::NotExists�I�u�W�F�N�g�� |
|
929 |
�擾�ł��܂��B����͑Ή�����l�����݂��Ȃ����Ƃ�����߂̂�̂ł��B |
|
930 | ||
931 |
�܂��I����t�����݂��Ȃ��ꍇ�͎��̂悤�ȃf�[�^��쐬���܂��B |
|
932 | ||
933 |
my $p = {date => ['2010-11-15']}; |
|
934 | ||
935 |
�ǂ�����݂��Ȃ��ꍇ�͎��̂悤�ȃf�[�^��쐬���܂��B |
|
936 | ||
937 |
my $p = {date => []}; |
|
938 | ||
939 |
��������̂ň�ԊȒP�ɍ쐬�ł��郍�W�b�N����Ă����܂��B |
|
940 | ||
941 |
my @date; |
|
942 |
push @date, exists $param->{start_date} ? $param->{start_date} |
|
943 |
: $dbi->not_exists; |
|
944 |
push @date, $param->{end_date} if exists $param->{end_date}; |
|
945 |
my $p = {date => \@date}; |
|
946 | ||
947 |
=head3 C<select()>�Ƃ̘A�g |
|
948 | ||
949 |
L<DBIx::Custom::Where>�I�u�W�F�N�g�� |
|
950 |
C<select()>��C<where>�ɒ��ړn�����Ƃ� |
|
951 |
�ł��܂��B |
|
952 |
|
|
953 |
my $where = $dbi->where; |
|
954 |
$where->clause(...); |
|
955 |
$where->param($param); |
|
956 |
my $result = $dbi->select(table => 'book', where => $where); |
|
957 | ||
958 |
���邢��C<update()>�AC<delete()>��where�Ɏw�肷�邱�Ƃ�\�ł��B |
|
959 | ||
960 |
=head3 C<execute()>�Ƃ̘A�g |
|
961 | ||
962 |
C<execute()>�Ƃ̘A�g�ł��BSQL��쐬����Ƃ��ɖ��ߍ��ނ��Ƃ��ł��܂��B |
|
added experimental DBIx::Cus...
|
963 | |
964 | ||
update pod
|
965 |
my $where = $dbi->where; |
966 |
$where->clause(...); |
|
967 |
$where->param($param); |
|
968 | ||
969 |
my $sql = <<"EOS" |
|
970 |
select * from book; |
|
971 |
$where |
|
972 |
EOS |
|
973 | ||
974 |
$dbi->execute($sql, param => $param); |
|
975 | ||
update pod
|
976 |
=head2 7. Table object |
update pod
|
977 | |
update pod
|
978 |
=head3 Create table object C<table()> |
update pod
|
979 | |
update pod
|
980 |
You can create table object to access table in database. |
981 |
use C<tabel()> to create table object. |
|
update pod
|
982 | |
983 |
my $table = $dbi->table('book'); |
|
984 | ||
update pod
|
985 |
Return value is L<DBIx::Custom::Table>. |
986 |
From table object, you can call C<insert()>, C<update()>, C<update_all()>�A |
|
987 |
C<delete()>, C<delete_all()>, C<select()>. |
|
988 |
You don't have to specify table name. |
|
update pod
|
989 | |
990 |
$table->insert(param => $param); |
|
991 | ||
update pod
|
992 |
You can add any method to table object. |
update pod
|
993 | |
994 |
$table->method( |
|
995 |
register => sub { |
|
added experimental DBIx::Cus...
|
996 |
my $self = shift; |
update pod
|
997 |
my $table_name = $self->name; |
update pod
|
998 |
# ... |
added experimental DBIx::Cus...
|
999 |
}, |
update pod
|
1000 |
list => sub { ... } |
update pod
|
1001 |
); |
1002 | ||
update pod
|
1003 |
You can get table name by C<name()>. |
update pod
|
1004 | |
update pod
|
1005 |
You can call these method from table object. |
update pod
|
1006 | |
1007 |
$table->register(...); |
|
1008 |
$table->list(...); |
|
1009 | ||
update pod
|
1010 |
=head2 Use L<DBIx::Custom> and <DBI> methods |
update pod
|
1011 | |
update pod
|
1012 |
You can call all methods of L<DBIx::Custom> and L<DBI> |
added experimental DBIx::Cus...
|
1013 | |
update pod
|
1014 |
# DBIx::Custom method |
1015 |
$table->execute($sql); |
|
1016 |
|
|
1017 |
# DBI method |
|
1018 |
$table->begin_work; |
|
1019 |
$table->commit; |
|
added experimental DBIx::Cus...
|
1020 | |
update pod
|
1021 |
=head2 Add table shared method |
added experimental DBIx::Cus...
|
1022 | |
update pod
|
1023 |
To share methods in all tables, |
1024 |
add method to base table. |
|
1025 |
You can get base table by C<base_table()>. |
|
added experimental DBIx::Cus...
|
1026 | |
update pod
|
1027 |
$dbi->base_table->method( |
1028 |
count => sub { |
|
1029 |
my $self = shift; |
|
1030 |
return $self->select(column => ['count(*)']); |
|
1031 |
} |
|
1032 |
); |
|
added DBIx::Custom::Guides
|
1033 | |
update pod
|
1034 |
This method is used by all talbes. |
added DBIx::Custom::Guides
|
1035 | |
update pod
|
1036 |
$dbi->table('book')->count(...); |
update pod
|
1037 | |
update pod
|
1038 |
Even if same method name is added to table, |
1039 |
You can use base table method by C<base_METHOD()>. |
|
added DBIx::Custom::Guides
|
1040 | |
update pod
|
1041 |
$table->method( |
1042 |
count => sub { |
|
1043 |
my $self = shift; |
|
1044 |
|
|
1045 |
$self->base_count(...); |
|
1046 |
|
|
1047 |
# ... |
|
1048 |
} |
|
1049 |
); |
|
1050 | ||
1051 |
=head2 Model example |
|
1052 | ||
1053 |
Generally, it is good to create model in constructor |
|
1054 |
in the class extending L<DBIx::Custom>. |
|
added DBIx::Custom::Guides
|
1055 | |
update pod
|
1056 |
package MyDBI; |
1057 |
|
|
1058 |
use base 'DBIx::Custom'; |
|
added DBIx::Custom::Guides
|
1059 |
|
update pod
|
1060 |
sub connect { |
1061 |
my $self = shift->SUPER::connect(@_); |
|
1062 |
|
|
1063 |
$self->base_table->method( |
|
update pod
|
1064 |
delete_multi => sub { ... } |
update pod
|
1065 |
); |
1066 |
|
|
1067 |
$self->table('book')->method( |
|
update pod
|
1068 |
register => sub { ... }, |
1069 |
remove => sub { ... }, |
|
update pod
|
1070 |
); |
1071 |
|
|
1072 |
$self->table('company')->method( |
|
update pod
|
1073 |
register => sub { ... }, |
1074 |
remove => sub { ... }, |
|
update pod
|
1075 |
); |
1076 |
} |
|
1077 | ||
update pod
|
1078 |
You can use this class in the following way. |
update pod
|
1079 | |
1080 |
my $dbi = MyDBI->connect(...); |
|
update pod
|
1081 |
$dbi->table('book')->delete_multi(...); |
update pod
|
1082 | |
update pod
|
1083 |
=head2 8. Improve performance |
update pod
|
1084 | |
update pod
|
1085 |
=head3 Create query |
update pod
|
1086 | |
update pod
|
1087 |
If you can't get performance, create query by C<query> option. |
1088 |
For example, many insert is needed. |
|
update pod
|
1089 | |
update pod
|
1090 |
my $params = [ |
1091 |
{title => 'Perl', author => 'Ken'}, |
|
1092 |
{title => 'Good day', author => 'Tom'} |
|
1093 |
] |
|
1094 |
my $query = $dbi->insert(table => 'book', param => $params->[0], query => 1); |
|
added DBIx::Custom::Guides
|
1095 | |
update pod
|
1096 |
Return value is L<DBIx::Custom::Query> object. |
1097 |
This query is executed by C<execute()>. |
|
added DBIx::Custom::Guides
|
1098 | |
update pod
|
1099 |
foreach my $param (@$params) { |
1100 |
$dbi->execute($query, $param); |
|
added DBIx::Custom::Guides
|
1101 |
} |
1102 | ||
update pod
|
1103 |
Performance is improved because statement handle is reused |
1104 |
C<query> option is used in C<insert()>, C<update()>, C<update_all()>, |
|
1105 |
C<delete()>, C<delete_all()>. |
|
1106 | ||
1107 |
Note that parameters count is same as method for creating query and C<execute()>. |
|
added DBIx::Custom::Guides
|
1108 | |
update pod
|
1109 |
You can create query from any SQL by C<create_query()>. |
added DBIx::Custom::Guides
|
1110 | |
update pod
|
1111 |
my $query = $dbi->create_query( |
1112 |
"insert into book {insert_param title author};"; |
|
1113 |
); |
|
added DBIx::Custom::Guides
|
1114 | |
update pod
|
1115 |
=head2 9. Other features |
added DBIx::Custom::Guides
|
1116 | |
update pod
|
1117 |
=head3 Add method |
added DBIx::Custom::Guides
|
1118 | |
update pod
|
1119 |
You can add method to L<DBIx::Custom> object. |
1120 |
use C<method(). |
|
added DBIx::Custom::Guides
|
1121 | |
update pod
|
1122 |
$dbi->method( |
1123 |
update_or_insert => sub { |
|
1124 |
my $self = shift; |
|
1125 |
# something |
|
1126 |
}, |
|
1127 |
find_or_create => sub { |
|
1128 |
my $self = shift; |
|
1129 |
# something |
|
1130 |
} |
|
1131 |
); |
|
1132 | ||
update pod
|
1133 |
You can call these methods from L<DBIx::Custom> object. |
update pod
|
1134 | |
1135 |
$dbi->update_or_insert; |
|
1136 |
$dbi->find_or_create; |
|
1137 | ||
update pod
|
1138 |
=head3 Change result class |
added DBIx::Custom::Guides
|
1139 | |
update pod
|
1140 |
You can change result class. By default it is L<DBIx::Custom::Result>. |
added DBIx::Custom::Guides
|
1141 | |
update pod
|
1142 |
package MyResult; |
added DBIx::Custom::Guides
|
1143 |
use base 'DBIx::Custom::Result'; |
1144 |
|
|
1145 |
sub some_method { ... } |
|
1146 | ||
1147 |
1; |
|
1148 |
|
|
1149 |
package main; |
|
1150 |
|
|
update pod
|
1151 |
use MyResult; |
added DBIx::Custom::Guides
|
1152 |
|
1153 |
my $dbi = DBIx::Custom->connect(...); |
|
update pod
|
1154 |
$dbi->result_class('MyResult'); |
added DBIx::Custom::Guides
|
1155 | |
update pod
|
1156 |
=head3 �L���b�V���O |
added DBIx::Custom::Guides
|
1157 | |
update pod
|
1158 |
SQL after parsing tag is cached for performance. |
1159 |
You can set C<cache()>. By default, chaching is true. |
|
added DBIx::Custom::Guides
|
1160 | |
update pod
|
1161 |
$dbi->cache(1); |
added DBIx::Custom::Guides
|
1162 | |
update pod
|
1163 |
The way to cache is changed by C<cache_method()>. |
1164 |
Default method is the following one. |
|
1165 |
Cache is saved to memory. |
|
update pod
|
1166 | |
1167 |
$dbi->cache_method(sub { |
|
1168 |
sub { |
|
added DBIx::Custom::Guides
|
1169 |
my $self = shift; |
update pod
|
1170 |
|
1171 |
$self->{_cached} ||= {}; |
|
1172 |
|
|
1173 |
if (@_ > 1) { |
|
update pod
|
1174 |
# Save cache |
update pod
|
1175 |
$self->{_cached}{$_[0]} = $_[1] |
1176 |
} |
|
1177 |
else { |
|
update pod
|
1178 |
# Get cache |
update pod
|
1179 |
return $self->{_cached}{$_[0]} |
1180 |
} |
|
added DBIx::Custom::Guides
|
1181 |
} |
update pod
|
1182 |
}); |
1183 |
|
|
update pod
|
1184 |
First argument is L<DBIx::Custom> object. |
1185 |
Second argument is SQL before parsing. |
|
1186 |
Third argument is SQL information after parsing. This is hash reference. |
|
added DBIx::Custom::Guides
|
1187 | |
update pod
|
1188 |
If third argument exists, you save cache, |
1189 |
and if third argument isn't exists, you get chace. |
|
added DBIx::Custom::Guides
|
1190 | |
pod fix
|
1191 |
=head1 EXAMPLES |
1192 | ||
update pod
|
1193 |
You can see exsamples in the following wiki. |
1194 | ||
pod fix
|
1195 |
L<DBIx::Custom Wiki|https://github.com/yuki-kimoto/DBIx-Custom/wiki> - Many useful examples |
add examples
|
1196 | |
added DBIx::Custom::Guides
|
1197 |
=cut |