DBIx-Custom / lib / DBIx / Custom.pm /
Newer Older
1494 lines | 38.859kb
cleanup
yuki-kimoto authored on 2009-12-22
1
package DBIx::Custom;
2

            
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-17
3
our $VERSION = '0.1631';
fixed DBIx::Custom::QueryBui...
yuki-kimoto authored on 2010-08-15
4

            
5
use 5.008001;
cleanup
yuki-kimoto authored on 2009-12-22
6
use strict;
7
use warnings;
8

            
remove run_transaction().
yuki-kimoto authored on 2010-01-30
9
use base 'Object::Simple';
many change
yuki-kimoto authored on 2010-02-11
10

            
packaging one directory
yuki-kimoto authored on 2009-11-16
11
use Carp 'croak';
12
use DBI;
13
use DBIx::Custom::Result;
cleanup
yuki-kimoto authored on 2010-02-11
14
use DBIx::Custom::Query;
cleanup
yuki-kimoto authored on 2010-08-05
15
use DBIx::Custom::QueryBuilder;
experimental extended select...
Yuki Kimoto authored on 2011-01-17
16
use DBIx::Custom::Or;
update document
yuki-kimoto authored on 2010-05-27
17
use Encode qw/encode_utf8 decode_utf8/;
packaging one directory
yuki-kimoto authored on 2009-11-16
18

            
fix tests
Yuki Kimoto authored on 2011-01-13
19
__PACKAGE__->attr(
20
    [qw/data_source dbh dbi_options password user/],
21

            
22
    cache => 1,
23
    filters => sub {
24
        {
25
            encode_utf8 => sub { encode_utf8($_[0]) },
26
            decode_utf8 => sub { decode_utf8($_[0]) }
27
        }
28
    },
29
    
30
    filter_check  => 1,
31
    query_builder => sub {DBIx::Custom::QueryBuilder->new},
32
    result_class  => 'DBIx::Custom::Result',
33
    table_class   => 'DBIx::Custom::Table'
34
);
cleanup
yuki-kimoto authored on 2010-10-17
35

            
36
# DBI methods
37
foreach my $method (qw/begin_work commit rollback/) {
38
    my $code = sub {
39
        my $self = shift;
40
        my $ret = eval {$self->dbh->$method};
41
        croak $@ if $@;
42
        return $ret;
43
    };
44
    no strict 'refs';
45
    my $pkg = __PACKAGE__;
46
    *{"${pkg}::$method"} = $code;
47
};
48

            
added helper method
yuki-kimoto authored on 2010-10-17
49
our $AUTOLOAD;
50

            
51
sub AUTOLOAD {
52
    my $self = shift;
53

            
54
    # Method
55
    my ($package, $method) = $AUTOLOAD =~ /^([\w\:]+)\:\:(\w+)$/;
56

            
57
    # Helper
58
    $self->{_helpers} ||= {};
59
    croak qq/Can't locate object method "$method" via "$package"/
60
      unless my $helper = $self->{_helpers}->{$method};
61

            
62
    # Run
63
    return $self->$helper(@_);
64
}
65

            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
66
sub apply_filter {
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
67
    my $self = shift;
68
    
cleanup
Yuki Kimoto authored on 2011-01-12
69
    $self->{filter} ||= {};
cleanup
Yuki Kimoto authored on 2010-12-22
70
    
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
71
    # Table and column informations
72
    my ($table, @cs) = @_;
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
73
    
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
74
    if (@cs) {
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
75
        
cleanup
Yuki Kimoto authored on 2010-12-22
76
        # Initialize filters
cleanup
Yuki Kimoto authored on 2011-01-12
77
        $self->{filter}{out} ||= {};
78
        $self->{filter}{in} ||= {};
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
79
        
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
80
        # Create filters
81
        for (my $i = 0; $i < @cs; $i += 2) {
cleanup
Yuki Kimoto authored on 2010-12-22
82
            
83
            # Column
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
84
            my $column = $cs[$i];
85
            
86
            # Filter
87
            my $filter = $cs[$i + 1] || {};
88
            my $in_filter = delete $filter->{in};
89
            my $out_filter = delete $filter->{out};
90
            croak "Usage \$dbi->apply_filter(" .
91
                  "TABLE, COLUMN, {in => INFILTER, out => OUTFILTER}, ...)"
92
              if ref $filter ne 'HASH' || keys %$filter;
cleanup
Yuki Kimoto authored on 2010-12-22
93
            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
94
            # Out filter
cleanup
Yuki Kimoto authored on 2011-01-12
95
            if (ref $out_filter eq 'CODE') {
cleanup
Yuki Kimoto authored on 2011-01-12
96
                $self->{filter}{out}{$table}{$column}
97
                  = $out_filter;
98
                $self->{filter}{out}{$table}{"$table.$column"}
99
                  = $out_filter;
cleanup
Yuki Kimoto authored on 2010-12-22
100
            }
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
101
            elsif (defined $out_filter) {
cleanup
Yuki Kimoto authored on 2011-01-12
102
                croak qq{"$out_filter" is not registered}
103
                  unless exists $self->filters->{$out_filter};
104
                
105
                $self->{filter}{out}{$table}{$column}
106
                  = $self->filters->{$out_filter};
107
                $self->{filter}{out}{$table}{"$table.$column"}
108
                  = $self->filters->{$out_filter};
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
109
            }
cleanup
Yuki Kimoto authored on 2010-12-22
110
            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
111
            # In filter
cleanup
Yuki Kimoto authored on 2011-01-12
112
            if (ref $in_filter eq 'CODE') {
cleanup
Yuki Kimoto authored on 2011-01-12
113
                $self->{filter}{in}{$table}{$column}
114
                  = $in_filter;
115
                $self->{filter}{in}{$table}{"$table.$column"}
116
                  = $in_filter;
cleanup
Yuki Kimoto authored on 2010-12-22
117
            }
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
118
            elsif (defined $in_filter) {
cleanup
Yuki Kimoto authored on 2011-01-12
119
                croak qq{"$in_filter" is not registered}
120
                  unless exists $self->filters->{$in_filter};
cleanup
Yuki Kimoto authored on 2011-01-12
121
                $self->{filter}{in}{$table}{$column}
cleanup
Yuki Kimoto authored on 2011-01-12
122
                  = $self->filters->{$in_filter};
cleanup
Yuki Kimoto authored on 2011-01-12
123
                $self->{filter}{in}{$table}{"$table.$column"}
cleanup
Yuki Kimoto authored on 2011-01-12
124
                  = $self->filters->{$in_filter};
cleanup
Yuki Kimoto authored on 2010-12-22
125
            }
cleanup
Yuki Kimoto authored on 2010-12-21
126
        }
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
127
        
cleanup
Yuki Kimoto authored on 2010-12-22
128
        return $self;
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
129
    }
130
    
cleanup
Yuki Kimoto authored on 2011-01-12
131
    return $self->{filter};
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
132
}
133

            
added helper method
yuki-kimoto authored on 2010-10-17
134
sub helper {
135
    my $self = shift;
136
    
137
    # Merge
138
    my $helpers = ref $_[0] eq 'HASH' ? $_[0] : {@_};
139
    $self->{_helpers} = {%{$self->{_helpers} || {}}, %$helpers};
140
    
141
    return $self;
142
}
143

            
packaging one directory
yuki-kimoto authored on 2009-11-16
144
sub connect {
removed register_format()
yuki-kimoto authored on 2010-05-26
145
    my $proto = shift;
146
    
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-01
147
    my $self;
removed register_format()
yuki-kimoto authored on 2010-05-26
148
    # Create
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-01
149
    if (my $class = ref $proto) {
150
        my $args = ref $_[0] eq 'HASH' ? $_[0] : {@_};
151
        $self = $proto;
152
        
153
        foreach my $attr (keys %$args) {
154
            $self->{$attr} = $args->{$attr};
155
        }
156
        
157
        # Check attribute names
158
        my @attrs = keys %$self;
159
        foreach my $attr (@attrs) {
160
            croak qq{"$attr" is invalid attribute name}
161
              unless $self->can($attr);
162
        }
163
    }
164
    else {
remove DBIx::Custom::Model
Yuki Kimoto authored on 2011-01-12
165
        $self = $proto->SUPER::new(@_);
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-01
166
    }
update document
yuki-kimoto authored on 2010-01-30
167
    
168
    # Information
packaging one directory
yuki-kimoto authored on 2009-11-16
169
    my $data_source = $self->data_source;
check arguments of connect m...
Yuki Kimoto authored on 2010-12-20
170
    
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-01
171
    croak qq{"data_source" must be specified to connect method"}
check arguments of connect m...
Yuki Kimoto authored on 2010-12-20
172
      unless $data_source;
173
    
packaging one directory
yuki-kimoto authored on 2009-11-16
174
    my $user        = $self->user;
175
    my $password    = $self->password;
added dbi_options attribute
kimoto authored on 2010-12-20
176
    my $dbi_options = $self->dbi_options || {};
177
    
update document
yuki-kimoto authored on 2010-01-30
178
    # Connect
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
179
    my $dbh = eval {DBI->connect(
packaging one directory
yuki-kimoto authored on 2009-11-16
180
        $data_source,
181
        $user,
182
        $password,
183
        {
184
            RaiseError => 1,
185
            PrintError => 0,
186
            AutoCommit => 1,
added dbi_options attribute
kimoto authored on 2010-12-20
187
            %$dbi_options
packaging one directory
yuki-kimoto authored on 2009-11-16
188
        }
189
    )};
190
    
update document
yuki-kimoto authored on 2010-01-30
191
    # Connect error
packaging one directory
yuki-kimoto authored on 2009-11-16
192
    croak $@ if $@;
193
    
update document
yuki-kimoto authored on 2010-01-30
194
    # Database handle
packaging one directory
yuki-kimoto authored on 2009-11-16
195
    $self->dbh($dbh);
update document
yuki-kimoto authored on 2010-01-30
196
    
packaging one directory
yuki-kimoto authored on 2009-11-16
197
    return $self;
198
}
199

            
cleanup
yuki-kimoto authored on 2010-10-17
200
sub create_query {
201
    my ($self, $source) = @_;
update document
yuki-kimoto authored on 2010-01-30
202
    
cleanup
yuki-kimoto authored on 2010-10-17
203
    # Cache
204
    my $cache = $self->cache;
update document
yuki-kimoto authored on 2010-01-30
205
    
cleanup
yuki-kimoto authored on 2010-10-17
206
    # Create query
207
    my $query;
208
    if ($cache) {
209
        
210
        # Get query
211
        my $q = $self->cache_method->($self, $source);
212
        
213
        # Create query
214
        $query = DBIx::Custom::Query->new($q) if $q;
215
    }
216
    
217
    unless ($query) {
cleanup insert
yuki-kimoto authored on 2010-04-28
218

            
cleanup
yuki-kimoto authored on 2010-10-17
219
        # Create SQL object
220
        my $builder = $self->query_builder;
221
        
222
        # Create query
223
        $query = $builder->build_query($source);
removed register_format()
yuki-kimoto authored on 2010-05-26
224

            
cleanup
yuki-kimoto authored on 2010-10-17
225
        # Cache query
226
        $self->cache_method->($self, $source,
227
                             {sql     => $query->sql, 
228
                              columns => $query->columns})
229
          if $cache;
cleanup insert
yuki-kimoto authored on 2010-04-28
230
    }
231
    
cleanup
yuki-kimoto authored on 2010-10-17
232
    # Prepare statement handle
233
    my $sth;
234
    eval { $sth = $self->dbh->prepare($query->{sql})};
235
    $self->_croak($@, qq{. SQL: "$query->{sql}"}) if $@;
packaging one directory
yuki-kimoto authored on 2009-11-16
236
    
cleanup
yuki-kimoto authored on 2010-10-17
237
    # Set statement handle
238
    $query->sth($sth);
packaging one directory
yuki-kimoto authored on 2009-11-16
239
    
cleanup
yuki-kimoto authored on 2010-10-17
240
    return $query;
packaging one directory
yuki-kimoto authored on 2009-11-16
241
}
242

            
cleanup
yuki-kimoto authored on 2010-10-17
243
our %VALID_DELETE_ARGS
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
244
  = map { $_ => 1 } qw/table where append filter allow_delete_all query/;
cleanup update and update_al...
yuki-kimoto authored on 2010-04-28
245

            
cleanup
yuki-kimoto authored on 2010-10-17
246
sub delete {
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
247
    my ($self, %args) = @_;
cleanup update and update_al...
yuki-kimoto authored on 2010-04-28
248
    
249
    # Check arguments
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
250
    foreach my $name (keys %args) {
add tests
yuki-kimoto authored on 2010-08-10
251
        croak qq{"$name" is invalid argument}
cleanup
yuki-kimoto authored on 2010-10-17
252
          unless $VALID_DELETE_ARGS{$name};
cleanup update and update_al...
yuki-kimoto authored on 2010-04-28
253
    }
254
    
255
    # Arguments
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
256
    my $table            = $args{table} || '';
257
    my $where            = $args{where} || {};
cleanup
yuki-kimoto authored on 2010-10-17
258
    my $append = $args{append};
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
259
    my $filter           = $args{filter};
cleanup
yuki-kimoto authored on 2010-10-17
260
    my $allow_delete_all = $args{allow_delete_all};
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
261

            
packaging one directory
yuki-kimoto authored on 2009-11-16
262
    # Where keys
removed register_format()
yuki-kimoto authored on 2010-05-26
263
    my @where_keys = keys %$where;
packaging one directory
yuki-kimoto authored on 2009-11-16
264
    
265
    # Not exists where keys
add tests
yuki-kimoto authored on 2010-08-10
266
    croak qq{"where" argument must be specified and } .
267
          qq{contains the pairs of column name and value}
cleanup
yuki-kimoto authored on 2010-10-17
268
      if !@where_keys && !$allow_delete_all;
packaging one directory
yuki-kimoto authored on 2009-11-16
269
    
270
    # Where clause
271
    my $where_clause = '';
272
    if (@where_keys) {
273
        $where_clause = 'where ';
add tests
yuki-kimoto authored on 2010-08-10
274
        $where_clause .= "{= $_} and " for @where_keys;
packaging one directory
yuki-kimoto authored on 2009-11-16
275
        $where_clause =~ s/ and $//;
276
    }
277
    
add tests
yuki-kimoto authored on 2010-08-10
278
    # Source of SQL
cleanup
yuki-kimoto authored on 2010-10-17
279
    my $source = "delete from $table $where_clause";
add tests
yuki-kimoto authored on 2010-08-10
280
    $source .= " $append" if $append;
packaging one directory
yuki-kimoto authored on 2009-11-16
281
    
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
282
    # Create query
283
    my $query = $self->create_query($source);
284
    return $query if $args{query};
285
    
packaging one directory
yuki-kimoto authored on 2009-11-16
286
    # Execute query
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
287
    my $ret_val = $self->execute(
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
288
        $query, param  => $where, filter => $filter,
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
289
        table => $table);
packaging one directory
yuki-kimoto authored on 2009-11-16
290
    
291
    return $ret_val;
292
}
293

            
cleanup
yuki-kimoto authored on 2010-10-17
294
sub delete_all { shift->delete(allow_delete_all => 1, @_) }
packaging one directory
yuki-kimoto authored on 2009-11-16
295

            
added helper method
yuki-kimoto authored on 2010-10-17
296
sub DESTROY { }
297

            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
298
our %VALID_EXECUTE_ARGS = map { $_ => 1 } qw/param filter table/;
refactoring delete and delet...
yuki-kimoto authored on 2010-04-28
299

            
cleanup
yuki-kimoto authored on 2010-10-17
300
sub execute{
301
    my ($self, $query, %args)  = @_;
refactoring delete and delet...
yuki-kimoto authored on 2010-04-28
302
    
303
    # Check arguments
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
304
    foreach my $name (keys %args) {
add tests
yuki-kimoto authored on 2010-08-10
305
        croak qq{"$name" is invalid argument}
cleanup
yuki-kimoto authored on 2010-10-17
306
          unless $VALID_EXECUTE_ARGS{$name};
refactoring delete and delet...
yuki-kimoto authored on 2010-04-28
307
    }
308
    
cleanup
yuki-kimoto authored on 2010-10-17
309
    my $params = $args{param} || {};
packaging one directory
yuki-kimoto authored on 2009-11-16
310
    
cleanup
yuki-kimoto authored on 2010-10-17
311
    # First argument is the soruce of SQL
312
    $query = $self->create_query($query)
313
      unless ref $query;
packaging one directory
yuki-kimoto authored on 2009-11-16
314
    
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
315
    # Auto filter
cleanup
Yuki Kimoto authored on 2011-01-12
316
    my $filter = {};
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
317
    my $tables = $args{table} || [];
318
    $tables = [$tables]
319
      unless ref $tables eq 'ARRAY';
320
    foreach my $table (@$tables) {
cleanup
Yuki Kimoto authored on 2011-01-12
321
        $filter = {
322
            %$filter,
323
            %{$self->{filter}{out}->{$table} || {}}
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
324
        }
325
    }
326
    
cleanup
Yuki Kimoto authored on 2011-01-12
327
    # Filter argument
328
    my $f = $args{filter} || $query->filter || {};
329
    foreach my $column (keys %$f) {
330
        my $fname = $f->{$column};
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
331
        if (!defined $fname) {
cleanup
Yuki Kimoto authored on 2011-01-12
332
            $f->{$column} = undef;
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
333
        }
334
        elsif (ref $fname ne 'CODE') {
cleanup
Yuki Kimoto authored on 2010-12-21
335
          croak qq{"$fname" is not registered"}
336
            unless exists $self->filters->{$fname};
337
          
cleanup
Yuki Kimoto authored on 2011-01-12
338
          $f->{$column} = $self->filters->{$fname};
cleanup
Yuki Kimoto authored on 2010-12-21
339
        }
340
    }
cleanup
Yuki Kimoto authored on 2011-01-12
341
    $filter = {%$filter, %$f};
packaging one directory
yuki-kimoto authored on 2009-11-16
342
    
cleanup
Yuki Kimoto authored on 2011-01-12
343
    # Create bind values
344
    my $binds = $self->_build_binds($params, $query->columns, $filter);
cleanup
yuki-kimoto authored on 2010-10-17
345
    
346
    # Execute
347
    my $sth      = $query->sth;
348
    my $affected;
cleanup
Yuki Kimoto authored on 2011-01-12
349
    eval {$affected = $sth->execute(@$binds)};
cleanup
yuki-kimoto authored on 2010-10-17
350
    $self->_croak($@) if $@;
351
    
352
    # Return resultset if select statement is executed
353
    if ($sth->{NUM_OF_FIELDS}) {
354
        
cleanup
Yuki Kimoto authored on 2011-01-12
355
        # Auto in filter
cleanup
Yuki Kimoto authored on 2011-01-12
356
        my $in_filter = {};
357
        foreach my $table (@$tables) {
358
            $in_filter = {
359
                %$in_filter,
360
                %{$self->{filter}{in}{$table} || {}}
361
            }
362
        }
363
        
364
        # Result
365
        my $result = $self->result_class->new(
cleanup
Yuki Kimoto authored on 2010-12-22
366
            sth            => $sth,
367
            filters        => $self->filters,
368
            filter_check   => $self->filter_check,
cleanup
Yuki Kimoto authored on 2011-01-12
369
            default_filter => $self->{default_in_filter},
cleanup
Yuki Kimoto authored on 2011-01-12
370
            filter         => $in_filter || {}
cleanup
yuki-kimoto authored on 2010-10-17
371
        );
372

            
373
        return $result;
374
    }
375
    return $affected;
376
}
377

            
added experimental expand me...
yuki-kimoto authored on 2010-10-20
378
sub expand {
379
    my $self = shift;
380
    my $source = ref $_[0] eq 'HASH' ? $_[0] : {@_};
381
    my $table = (keys %$source)[0];
382
    my $param = $source->{$table};
383
    
384
    # Expand table name
385
    my $expand = {};
386
    foreach my $column (keys %$param) {
387
        $expand->{"$table.$column"} = $param->{$column};
388
    }
389
    
390
    return %$expand;
391
}
392

            
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
393
our %VALID_INSERT_ARGS = map { $_ => 1 } qw/table param append
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
394
                                            filter query/;
cleanup
yuki-kimoto authored on 2010-10-17
395
sub insert {
396
    my ($self, %args) = @_;
397

            
398
    # Check arguments
399
    foreach my $name (keys %args) {
400
        croak qq{"$name" is invalid argument}
401
          unless $VALID_INSERT_ARGS{$name};
packaging one directory
yuki-kimoto authored on 2009-11-16
402
    }
403
    
cleanup
yuki-kimoto authored on 2010-10-17
404
    # Arguments
405
    my $table  = $args{table} || '';
406
    my $param  = $args{param} || {};
407
    my $append = $args{append} || '';
408
    my $filter = $args{filter};
409
    
410
    # Insert keys
411
    my @insert_keys = keys %$param;
412
    
413
    # Templte for insert
414
    my $source = "insert into $table {insert_param "
415
               . join(' ', @insert_keys) . '}';
add tests
yuki-kimoto authored on 2010-08-10
416
    $source .= " $append" if $append;
packaging one directory
yuki-kimoto authored on 2009-11-16
417
    
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
418
    # Create query
419
    my $query = $self->create_query($source);
420
    return $query if $args{query};
421
    
packaging one directory
yuki-kimoto authored on 2009-11-16
422
    # Execute query
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
423
    my $ret_val = $self->execute(
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
424
        $query,
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
425
        param  => $param,
426
        filter => $filter,
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
427
        table => $table
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
428
    );
packaging one directory
yuki-kimoto authored on 2009-11-16
429
    
430
    return $ret_val;
431
}
432

            
added experimental iterate_a...
Yuki Kimoto authored on 2010-12-22
433
sub iterate_all_columns {
434
    my ($self, $cb) = @_;
435
    
436
    # Iterate all tables
437
    my $sth_tables = $self->dbh->table_info;
438
    while (my $table_info = $sth_tables->fetchrow_hashref) {
439
        
440
        # Table
441
        my $table = $table_info->{TABLE_NAME};
442
        
443
        # Iterate all columns
444
        my $sth_columns = $self->dbh->column_info(undef, undef, $table, '%');
445
        while (my $column_info = $sth_columns->fetchrow_hashref) {
446
            my $column = $column_info->{COLUMN_NAME};
447
            $cb->($table, $column, $column_info);
448
        }
449
    }
450
}
451

            
added dbi_options attribute
kimoto authored on 2010-12-20
452
sub new {
453
    my $self = shift->SUPER::new(@_);
454
    
455
    # Check attribute names
456
    my @attrs = keys %$self;
457
    foreach my $attr (@attrs) {
458
        croak qq{"$attr" is invalid attribute name}
459
          unless $self->can($attr);
460
    }
461
    
462
    return $self;
463
}
464

            
experimental extended select...
Yuki Kimoto authored on 2011-01-17
465
sub or {
466
    my $self = shift;
467
    my $values = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
468
    return DBIx::Custom::Or->new(values => $values);
469
}
470

            
cleanup
yuki-kimoto authored on 2010-10-17
471
sub register_filter {
472
    my $invocant = shift;
473
    
474
    # Register filter
475
    my $filters = ref $_[0] eq 'HASH' ? $_[0] : {@_};
476
    $invocant->filters({%{$invocant->filters}, %$filters});
477
    
478
    return $invocant;
479
}
packaging one directory
yuki-kimoto authored on 2009-11-16
480

            
refactoring select
yuki-kimoto authored on 2010-04-28
481
our %VALID_SELECT_ARGS
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
482
  = map { $_ => 1 } qw/table column where append relation filter query/;
refactoring select
yuki-kimoto authored on 2010-04-28
483

            
packaging one directory
yuki-kimoto authored on 2009-11-16
484
sub select {
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
485
    my ($self, %args) = @_;
packaging one directory
yuki-kimoto authored on 2009-11-16
486
    
refactoring select
yuki-kimoto authored on 2010-04-28
487
    # Check arguments
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
488
    foreach my $name (keys %args) {
add tests
yuki-kimoto authored on 2010-08-10
489
        croak qq{"$name" is invalid argument}
refactoring select
yuki-kimoto authored on 2010-04-28
490
          unless $VALID_SELECT_ARGS{$name};
491
    }
packaging one directory
yuki-kimoto authored on 2009-11-16
492
    
refactoring select
yuki-kimoto authored on 2010-04-28
493
    # Arguments
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
494
    my $tables = $args{table} || [];
removed register_format()
yuki-kimoto authored on 2010-05-26
495
    $tables = [$tables] unless ref $tables eq 'ARRAY';
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
496
    my $columns  = $args{column} || [];
update document
yuki-kimoto authored on 2010-08-07
497
    my $where    = $args{where};
select, insert, update, upda...
yuki-kimoto authored on 2010-06-14
498
    my $relation = $args{relation};
499
    my $append   = $args{append};
500
    my $filter   = $args{filter};
packaging one directory
yuki-kimoto authored on 2009-11-16
501
    
add tests
yuki-kimoto authored on 2010-08-10
502
    # Source of SQL
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
503
    my $source = 'select ';
packaging one directory
yuki-kimoto authored on 2009-11-16
504
    
added commit method
yuki-kimoto authored on 2010-05-27
505
    # Column clause
packaging one directory
yuki-kimoto authored on 2009-11-16
506
    if (@$columns) {
507
        foreach my $column (@$columns) {
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
508
            $source .= "$column, ";
packaging one directory
yuki-kimoto authored on 2009-11-16
509
        }
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
510
        $source =~ s/, $/ /;
packaging one directory
yuki-kimoto authored on 2009-11-16
511
    }
512
    else {
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
513
        $source .= '* ';
packaging one directory
yuki-kimoto authored on 2009-11-16
514
    }
515
    
added commit method
yuki-kimoto authored on 2010-05-27
516
    # Table
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
517
    $source .= 'from ';
packaging one directory
yuki-kimoto authored on 2009-11-16
518
    foreach my $table (@$tables) {
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
519
        $source .= "$table, ";
packaging one directory
yuki-kimoto authored on 2009-11-16
520
    }
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
521
    $source =~ s/, $/ /;
packaging one directory
yuki-kimoto authored on 2009-11-16
522
    
added commit method
yuki-kimoto authored on 2010-05-27
523
    # Where clause
update document
yuki-kimoto authored on 2010-08-07
524
    my $param;
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
525
    my $wexists;
added experimental DBIx::Cus...
Yuki Kimoto authored on 2011-01-01
526
    if (ref $where eq 'HASH' && keys %$where) {
update document
yuki-kimoto authored on 2010-08-07
527
        $param = $where;
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
528
        $wexists = keys %$where;
529
        
530
        if ($wexists) {
531
            $source .= 'where (';
532
            foreach my $where_key (keys %$where) {
533
                $source .= "{= $where_key} and ";
534
            }
535
            $source =~ s/ and $//;
536
            $source .= ') ';
packaging one directory
yuki-kimoto authored on 2009-11-16
537
        }
update document
yuki-kimoto authored on 2010-08-07
538
    }
539
    elsif (ref $where eq 'ARRAY') {
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
540
        my $w = $where->[0] || '';
update document
yuki-kimoto authored on 2010-08-07
541
        $param = $where->[1];
542
        
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
543
        if (ref $w eq 'HASH') {
experimental extended select...
Yuki Kimoto authored on 2011-01-17
544
            $wexists = keys %$param;
545
            if ($wexists) {
546
                $source .= 'where (';
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
547
            
experimental extended select...
Yuki Kimoto authored on 2011-01-17
548
                foreach my $column (keys %$param) {
549
                    croak qq{"$column" don't correspond to where clause}
550
                      unless exists $w->{$column};
551
                    
552
                    my $value = $param->{$column};
553
                    if (ref $value eq 'DBIx::Custom::Or') {
554
                        my $values = $value->values;
555
                        
556
                        $source .= '( ';
557
                        foreach my $value (@$values) {
558
                            $source .= $w->{$column};
559
                            $source .= ' or ';
560
                        }
561
                        $source =~ s/ or $//;
562
                        $source .= ' )';
563
                        $source .= ' and ';
564
                        $param->{$column} = $values;
565
                    }
566
                    elsif ($w->{$column}) {
567
                        $source .= $w->{$column} . ' and ';
568
                    }
569
                }
570
                $source =~ s/ and $//;
571
                $source .= ') ';
572
            }
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
573
        }
574
        else {
575
            $wexists = $w =~ /\S/;
576
            $source .= "where ($w) " if $wexists;
577
        }
packaging one directory
yuki-kimoto authored on 2009-11-16
578
    }
579
    
added commit method
yuki-kimoto authored on 2010-05-27
580
    # Relation
581
    if ($relation) {
fix select method empty wher...
Yuki Kimoto authored on 2011-01-17
582
        $source .= $wexists ? "and " : "where ";
added commit method
yuki-kimoto authored on 2010-05-27
583
        foreach my $rkey (keys %$relation) {
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
584
            $source .= "$rkey = " . $relation->{$rkey} . " and ";
packaging one directory
yuki-kimoto authored on 2009-11-16
585
        }
586
    }
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
587
    $source =~ s/ and $//;
added commit method
yuki-kimoto authored on 2010-05-27
588
    
589
    # Append some statement
renamed default_query_filter...
yuki-kimoto authored on 2010-08-03
590
    $source .= " $append" if $append;
packaging one directory
yuki-kimoto authored on 2009-11-16
591
    
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
592
    # Create query
593
    my $query = $self->create_query($source);
594
    return $query if $args{query};
595
    
packaging one directory
yuki-kimoto authored on 2009-11-16
596
    # Execute query
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
597
    my $result = $self->execute(
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
598
        $query, param  => $param, filter => $filter,
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
599
        table => $tables);    
packaging one directory
yuki-kimoto authored on 2009-11-16
600
    
601
    return $result;
602
}
603

            
remove DBIx::Custom::Model
Yuki Kimoto authored on 2011-01-12
604
sub table {
605
    my $self = shift;
606
    my $name = shift;
607
    
608
    # Table class
609
    my $table_class = $self->table_class;
610
    croak qq{Invalid table class name "$table_class"}
611
      unless $table_class =~ /^[\w:]+$/;
612
    unless ($table_class->can('isa')) {
613
        eval "require $table_class";
614
        croak $@ if $@;
615
    }
616
    # Create table
617
    $self->{_tables} ||= {};
618
    $self->{_tables}->{$name}
619
        = $table_class->new(name => $name, dbi => $self)
620
      unless defined $self->{_tables}->{$name};
621
    
622
    # Helper
623
    $self->{_tables}->{$name}->helper(@_) if @_;
624
    
625
    return $self->{_tables}{$name};
626
}
627

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
628
sub txn_scope {
629
    my $self = shift;
630
    
631
    require DBIx::TransactionManager;
632
    
633
    $self->{_transaction_manager}
634
      ||= DBIx::TransactionManager->new($self->dbh);
635
    
636
    return $self->{_transaction_manager}->txn_scope;
637
}
638

            
cleanup
yuki-kimoto authored on 2010-10-17
639
our %VALID_UPDATE_ARGS
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
640
  = map { $_ => 1 } qw/table param
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
641
                       where append filter allow_update_all query/;
cleanup
yuki-kimoto authored on 2010-10-17
642

            
643
sub update {
644
    my ($self, %args) = @_;
version 0.0901
yuki-kimoto authored on 2009-12-17
645
    
cleanup
yuki-kimoto authored on 2010-10-17
646
    # Check arguments
647
    foreach my $name (keys %args) {
648
        croak qq{"$name" is invalid argument}
649
          unless $VALID_UPDATE_ARGS{$name};
removed reconnect method
yuki-kimoto authored on 2010-05-28
650
    }
added cache_method attribute
yuki-kimoto authored on 2010-06-25
651
    
cleanup
yuki-kimoto authored on 2010-10-17
652
    # Arguments
653
    my $table            = $args{table} || '';
654
    my $param            = $args{param} || {};
655
    my $where            = $args{where} || {};
656
    my $append = $args{append} || '';
657
    my $filter           = $args{filter};
658
    my $allow_update_all = $args{allow_update_all};
version 0.0901
yuki-kimoto authored on 2009-12-17
659
    
cleanup
yuki-kimoto authored on 2010-10-17
660
    # Update keys
661
    my @update_keys = keys %$param;
renamed fetch_rows to fetch_...
yuki-kimoto authored on 2010-05-01
662
    
cleanup
yuki-kimoto authored on 2010-10-17
663
    # Where keys
664
    my @where_keys = keys %$where;
removed reconnect method
yuki-kimoto authored on 2010-05-28
665
    
cleanup
yuki-kimoto authored on 2010-10-17
666
    # Not exists where keys
667
    croak qq{"where" argument must be specified and } .
668
          qq{contains the pairs of column name and value}
669
      if !@where_keys && !$allow_update_all;
removed experimental registe...
yuki-kimoto authored on 2010-08-24
670
    
cleanup
yuki-kimoto authored on 2010-10-17
671
    # Update clause
672
    my $update_clause = '{update_param ' . join(' ', @update_keys) . '}';
removed experimental registe...
yuki-kimoto authored on 2010-08-24
673
    
cleanup
yuki-kimoto authored on 2010-10-17
674
    # Where clause
675
    my $where_clause = '';
676
    my $new_where = {};
removed reconnect method
yuki-kimoto authored on 2010-05-28
677
    
cleanup
yuki-kimoto authored on 2010-10-17
678
    if (@where_keys) {
679
        $where_clause = 'where ';
680
        $where_clause .= "{= $_} and " for @where_keys;
681
        $where_clause =~ s/ and $//;
removed reconnect method
yuki-kimoto authored on 2010-05-28
682
    }
683
    
cleanup
yuki-kimoto authored on 2010-10-17
684
    # Source of SQL
685
    my $source = "update $table $update_clause $where_clause";
686
    $source .= " $append" if $append;
removed reconnect method
yuki-kimoto authored on 2010-05-28
687
    
cleanup
yuki-kimoto authored on 2010-10-17
688
    # Rearrange parameters
689
    foreach my $wkey (@where_keys) {
removed reconnect method
yuki-kimoto authored on 2010-05-28
690
        
cleanup
yuki-kimoto authored on 2010-10-17
691
        if (exists $param->{$wkey}) {
692
            $param->{$wkey} = [$param->{$wkey}]
693
              unless ref $param->{$wkey} eq 'ARRAY';
694
            
695
            push @{$param->{$wkey}}, $where->{$wkey};
696
        }
697
        else {
698
            $param->{$wkey} = $where->{$wkey};
699
        }
removed reconnect method
yuki-kimoto authored on 2010-05-28
700
    }
cleanup
yuki-kimoto authored on 2010-10-17
701
    
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
702
    # Create query
703
    my $query = $self->create_query($source);
704
    return $query if $args{query};
705
    
cleanup
yuki-kimoto authored on 2010-10-17
706
    # Execute query
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
707
    my $ret_val = $self->execute($query, param  => $param, 
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
708
                                 filter => $filter,
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
709
                                 table => $table);
cleanup
yuki-kimoto authored on 2010-10-17
710
    
711
    return $ret_val;
removed reconnect method
yuki-kimoto authored on 2010-05-28
712
}
713

            
cleanup
yuki-kimoto authored on 2010-10-17
714
sub update_all { shift->update(allow_update_all => 1, @_) };
715

            
cleanup
Yuki Kimoto authored on 2011-01-12
716
sub _build_binds {
717
    my ($self, $params, $columns, $filter) = @_;
removed reconnect method
yuki-kimoto authored on 2010-05-28
718
    
cleanup
Yuki Kimoto authored on 2011-01-12
719
    # bind values
720
    my @binds;
add tests
yuki-kimoto authored on 2010-08-08
721
    
removed reconnect method
yuki-kimoto authored on 2010-05-28
722
    # Build bind values
723
    my $count = {};
cleanup
Yuki Kimoto authored on 2011-01-12
724
    foreach my $column (@$columns) {
removed reconnect method
yuki-kimoto authored on 2010-05-28
725
        
726
        # Value
727
        my $value = ref $params->{$column} eq 'ARRAY'
728
                  ? $params->{$column}->[$count->{$column} || 0]
729
                  : $params->{$column};
730
        
cleanup
Yuki Kimoto authored on 2011-01-12
731
        # Filter
732
        my $f = $filter->{$column} || $self->{default_out_filter} || '';
cleanup
kimoto.yuki@gmail.com authored on 2010-12-21
733
        
cleanup
Yuki Kimoto authored on 2011-01-12
734
        push @binds, $f ? $f->($value) : $value;
removed reconnect method
yuki-kimoto authored on 2010-05-28
735
        
736
        # Count up 
737
        $count->{$column}++;
738
    }
739
    
cleanup
Yuki Kimoto authored on 2011-01-12
740
    return \@binds;
removed reconnect method
yuki-kimoto authored on 2010-05-28
741
}
742

            
cleanup
yuki-kimoto authored on 2010-10-17
743
sub _croak {
744
    my ($self, $error, $append) = @_;
745
    $append ||= "";
746
    
747
    # Verbose
748
    if ($Carp::Verbose) { croak $error }
749
    
750
    # Not verbose
751
    else {
752
        
753
        # Remove line and module infromation
754
        my $at_pos = rindex($error, ' at ');
755
        $error = substr($error, 0, $at_pos);
756
        $error =~ s/\s+$//;
757
        
758
        croak "$error$append";
759
    }
760
}
761

            
cleanup
Yuki Kimoto authored on 2011-01-12
762
# Deprecated
763
__PACKAGE__->attr(cache_method => sub {
764
    sub {
765
        my $self = shift;
766
        
767
        $self->{_cached} ||= {};
768
        
769
        if (@_ > 1) {
770
            $self->{_cached}{$_[0]} = $_[1] 
771
        }
772
        else {
773
            return $self->{_cached}{$_[0]}
774
        }
775
    }
776
});
777

            
778
sub default_bind_filter {
779
    my $self = shift;
780
    
781
    if (@_) {
782
        my $fname = $_[0];
783
        
784
        if (@_ && !$fname) {
785
            $self->{default_out_filter} = undef;
786
        }
787
        else {
788
            croak qq{"$fname" is not registered}
789
              unless exists $self->filters->{$fname};
790
        
791
            $self->{default_out_filter} = $self->filters->{$fname};
792
        }
793
        return $self;
794
    }
795
    
796
    return $self->{default_out_filter};
797
}
798

            
799
sub default_fetch_filter {
800
    my $self = shift;
801
    my $fname = $_[0];
802
    
803
    if (@_) {
804
        if (@_ && !$fname) {
805
            $self->{default_in_filter} = undef;
806
        }
807
        else {
808
            croak qq{"$fname" is not registered}
809
              unless exists $self->filters->{$fname};
810
        
811
            $self->{default_in_filter} = $self->filters->{$fname};
812
        }
813
        
814
        return $self;
815
    }
816
    
817
    return $self->{default_in_filter}
818
}
819

            
fixed DBIx::Custom::QueryBui...
yuki-kimoto authored on 2010-08-15
820
1;
821

            
removed reconnect method
yuki-kimoto authored on 2010-05-28
822
=head1 NAME
823

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
824
DBIx::Custom - DBI interface, having hash parameter binding and filtering system
removed reconnect method
yuki-kimoto authored on 2010-05-28
825

            
826
=head1 SYNOPSYS
cleanup
yuki-kimoto authored on 2010-08-05
827

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
828
Connect to the database.
829
    
830
    use DBIx::Custom;
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
831
    my $dbi = DBIx::Custom->connect(data_source => "dbi:mysql:database=dbname",
removed reconnect method
yuki-kimoto authored on 2010-05-28
832
                                    user => 'ken', password => '!LFKD%$&');
cleanup
yuki-kimoto authored on 2010-08-05
833

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
834
Insert, update, and delete
cleanup
yuki-kimoto authored on 2010-08-05
835

            
removed reconnect method
yuki-kimoto authored on 2010-05-28
836
    # Insert 
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
837
    $dbi->insert(table  => 'book',
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
838
                 param  => {title => 'Perl', author => 'Ken'},
removed reconnect method
yuki-kimoto authored on 2010-05-28
839
                 filter => {title => 'encode_utf8'});
840
    
841
    # Update 
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
842
    $dbi->update(table  => 'book', 
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
843
                 param  => {title => 'Perl', author => 'Ken'}, 
removed reconnect method
yuki-kimoto authored on 2010-05-28
844
                 where  => {id => 5},
845
                 filter => {title => 'encode_utf8'});
846
    
847
    # Update all
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
848
    $dbi->update_all(table  => 'book',
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
849
                     param  => {title => 'Perl'},
removed reconnect method
yuki-kimoto authored on 2010-05-28
850
                     filter => {title => 'encode_utf8'});
851
    
852
    # Delete
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
853
    $dbi->delete(table  => 'book',
removed reconnect method
yuki-kimoto authored on 2010-05-28
854
                 where  => {author => 'Ken'},
855
                 filter => {title => 'encode_utf8'});
856
    
857
    # Delete all
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
858
    $dbi->delete_all(table => 'book');
cleanup
yuki-kimoto authored on 2010-08-05
859

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
860
Select
cleanup
yuki-kimoto authored on 2010-08-05
861

            
removed reconnect method
yuki-kimoto authored on 2010-05-28
862
    # Select
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
863
    my $result = $dbi->select(table => 'book');
renamed fetch_rows to fetch_...
yuki-kimoto authored on 2010-05-01
864
    
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
865
    # Select, more complex
renamed fetch_rows to fetch_...
yuki-kimoto authored on 2010-05-01
866
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
867
        table  => 'book',
update document
yuki-kimoto authored on 2010-05-27
868
        column => [qw/author title/],
869
        where  => {author => 'Ken'},
updated document
yuki-kimoto authored on 2010-08-08
870
        append => 'order by id limit 5',
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
871
        filter => {title => 'encode_utf8'}
renamed fetch_rows to fetch_...
yuki-kimoto authored on 2010-05-01
872
    );
added commit method
yuki-kimoto authored on 2010-05-27
873
    
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
874
    # Select, join table
added commit method
yuki-kimoto authored on 2010-05-27
875
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
876
        table    => ['book', 'rental'],
877
        column   => ['book.name as book_name']
878
        relation => {'book.id' => 'rental.book_id'}
added commit method
yuki-kimoto authored on 2010-05-27
879
    );
updated document
yuki-kimoto authored on 2010-08-08
880
    
881
    # Select, more flexible where
882
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
883
        table  => 'book',
updated document
yuki-kimoto authored on 2010-08-08
884
        where  => ['{= author} and {like title}', 
885
                   {author => 'Ken', title => '%Perl%'}]
886
    );
cleanup
yuki-kimoto authored on 2010-08-05
887

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
888
Execute SQL
cleanup
yuki-kimoto authored on 2010-08-05
889

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
890
    # Execute SQL
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
891
    $dbi->execute("select title from book");
removed register_format()
yuki-kimoto authored on 2010-05-26
892
    
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
893
    # Execute SQL with hash binding and filtering
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
894
    $dbi->execute("select id from book where {= author} and {like title}",
removed register_format()
yuki-kimoto authored on 2010-05-26
895
                  param  => {author => 'ken', title => '%Perl%'},
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
896
                  filter => {title => 'encode_utf8'});
removed reconnect method
yuki-kimoto authored on 2010-05-28
897

            
898
    # Create query and execute it
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
899
    my $query = $dbi->create_query(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
900
        "select id from book where {= author} and {like title}"
removed reconnect method
yuki-kimoto authored on 2010-05-28
901
    );
updated document
yuki-kimoto authored on 2010-08-08
902
    $dbi->execute($query, param => {author => 'Ken', title => '%Perl%'})
cleanup
yuki-kimoto authored on 2010-08-05
903

            
updated document
yuki-kimoto authored on 2010-08-08
904
Other features.
cleanup
yuki-kimoto authored on 2010-08-05
905

            
906
    # Get DBI object
907
    my $dbh = $dbi->dbh;
908

            
909
Fetch row.
910

            
removed register_format()
yuki-kimoto authored on 2010-05-26
911
    # Fetch
912
    while (my $row = $result->fetch) {
913
        # ...
914
    }
915
    
916
    # Fetch hash
917
    while (my $row = $result->fetch_hash) {
918
        
919
    }
920
    
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
921
=head1 DESCRIPTIONS
removed reconnect method
yuki-kimoto authored on 2010-05-28
922

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
923
L<DBIx::Custom> is one of L<DBI> interface modules,
924
such as L<DBIx::Class>, L<DBIx::Simple>.
removed reconnect method
yuki-kimoto authored on 2010-05-28
925

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
926
This module is not O/R mapper. O/R mapper is useful,
927
but you must learn many syntax of the O/R mapper,
updated document
yuki-kimoto authored on 2010-08-08
928
which is almost another language.
929
Created SQL statement is offten not effcient and damage SQL performance.
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
930
so you have to execute raw SQL in the end.
removed reconnect method
yuki-kimoto authored on 2010-05-28
931

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
932
L<DBIx::Custom> is middle area between L<DBI> and O/R mapper.
updated document
yuki-kimoto authored on 2010-08-08
933
L<DBIx::Custom> provide flexible hash parameter binding and filtering system,
added experimental expand me...
yuki-kimoto authored on 2010-10-20
934
and suger methods, such as C<insert()>, C<update()>, C<delete()>, C<select()>
updated document
yuki-kimoto authored on 2010-08-08
935
to execute SQL easily.
removed reconnect method
yuki-kimoto authored on 2010-05-28
936

            
updated document
yuki-kimoto authored on 2010-08-08
937
L<DBIx::Custom> respects SQL. SQL is very complex and not beautiful,
938
but de-facto standard,
939
so all people learing database know it.
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
940
If you already know SQL,
941
you learn a little thing to use L<DBIx::Custom>.
removed reconnect method
yuki-kimoto authored on 2010-05-28
942

            
added DBIx::Custom::Guides
yuki-kimoto authored on 2010-10-17
943
See L<DBIx::Custom::Guides> for more details.
updated document
yuki-kimoto authored on 2010-08-08
944

            
update document
yuki-kimoto authored on 2010-01-30
945
=head1 ATTRIBUTES
packaging one directory
yuki-kimoto authored on 2009-11-16
946

            
cleanup
yuki-kimoto authored on 2010-10-17
947
=head2 C<cache>
packaging one directory
yuki-kimoto authored on 2009-11-16
948

            
cleanup
yuki-kimoto authored on 2010-10-17
949
    my $cache = $dbi->cache;
950
    $dbi      = $dbi->cache(1);
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
951

            
cleanup
yuki-kimoto authored on 2010-10-17
952
Enable parsed L<DBIx::Custom::Query> object caching.
953
Default to 1.
packaging one directory
yuki-kimoto authored on 2009-11-16
954

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
955
=head2 C<data_source>
packaging one directory
yuki-kimoto authored on 2009-11-16
956

            
cleanup
yuki-kimoto authored on 2010-08-03
957
    my $data_source = $dbi->data_source;
cleanup
yuki-kimoto authored on 2010-08-05
958
    $dbi            = $dbi->data_source("DBI:mysql:database=dbname");
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
959

            
cleanup
yuki-kimoto authored on 2010-08-05
960
Data source.
961
C<connect()> method use this value to connect the database.
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
962

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
963
=head2 C<dbh>
packaging one directory
yuki-kimoto authored on 2009-11-16
964

            
cleanup
yuki-kimoto authored on 2010-08-03
965
    my $dbh = $dbi->dbh;
966
    $dbi    = $dbi->dbh($dbh);
packaging one directory
yuki-kimoto authored on 2009-11-16
967

            
cleanup
yuki-kimoto authored on 2010-08-05
968
L<DBI> object. You can call all methods of L<DBI>.
packaging one directory
yuki-kimoto authored on 2009-11-16
969

            
added dbi_options attribute
kimoto authored on 2010-12-20
970
=head2 C<dbi_options>
971

            
972
    my $dbi_options = $dbi->dbi_options;
973
    $dbi            = $dbi->dbi_options($dbi_options);
974

            
975
DBI options.
976
C<connect()> method use this value to connect the database.
977

            
cleanup
yuki-kimoto authored on 2010-08-05
978
Default filter when row is fetched.
packaging one directory
yuki-kimoto authored on 2009-11-16
979

            
cleanup
yuki-kimoto authored on 2010-10-17
980
=head2 C<filters>
bind_filter argument is chan...
yuki-kimoto authored on 2009-11-19
981

            
cleanup
yuki-kimoto authored on 2010-10-17
982
    my $filters = $dbi->filters;
983
    $dbi        = $dbi->filters(\%filters);
packaging one directory
yuki-kimoto authored on 2009-11-16
984

            
cleanup
yuki-kimoto authored on 2010-10-17
985
Filter functions.
986
"encode_utf8" and "decode_utf8" is registered by default.
987

            
988
=head2 C<filter_check>
989

            
990
    my $filter_check = $dbi->filter_check;
991
    $dbi             = $dbi->filter_check(0);
992

            
cleanup
kimoto.yuki@gmail.com authored on 2010-12-21
993
B<this attribute is now deprecated and has no mean
994
because check is always done>. 
cleanup
yuki-kimoto authored on 2010-10-17
995

            
996
=head2 C<password>
997

            
998
    my $password = $dbi->password;
999
    $dbi         = $dbi->password('lkj&le`@s');
1000

            
1001
Password.
1002
C<connect()> method use this value to connect the database.
update document
yuki-kimoto authored on 2010-01-30
1003

            
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
1004
=head2 C<query_builder>
added commit method
yuki-kimoto authored on 2010-05-27
1005

            
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
1006
    my $sql_class = $dbi->query_builder;
1007
    $dbi          = $dbi->query_builder(DBIx::Custom::QueryBuilder->new);
added commit method
yuki-kimoto authored on 2010-05-27
1008

            
renamed update tag to update...
yuki-kimoto authored on 2010-08-09
1009
SQL builder. C<query_builder()> must be 
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1010
the instance of L<DBIx::Custom::QueryBuilder> subclass.
1011
Default to L<DBIx::Custom::QueryBuilder> object.
cleanup
yuki-kimoto authored on 2010-08-05
1012

            
cleanup
yuki-kimoto authored on 2010-10-17
1013
=head2 C<result_class>
cleanup
yuki-kimoto authored on 2010-08-05
1014

            
cleanup
yuki-kimoto authored on 2010-10-17
1015
    my $result_class = $dbi->result_class;
1016
    $dbi             = $dbi->result_class('DBIx::Custom::Result');
cleanup
yuki-kimoto authored on 2010-08-05
1017

            
cleanup
yuki-kimoto authored on 2010-10-17
1018
Result class for select statement.
1019
Default to L<DBIx::Custom::Result>.
cleanup
yuki-kimoto authored on 2010-08-05
1020

            
cleanup
yuki-kimoto authored on 2010-10-17
1021
=head2 C<user>
cleanup
yuki-kimoto authored on 2010-08-05
1022

            
cleanup
yuki-kimoto authored on 2010-10-17
1023
    my $user = $dbi->user;
1024
    $dbi     = $dbi->user('Ken');
cleanup
yuki-kimoto authored on 2010-08-05
1025

            
cleanup
yuki-kimoto authored on 2010-10-17
1026
User name.
1027
C<connect()> method use this value to connect the database.
1028
    
1029
=head1 METHODS
added commit method
yuki-kimoto authored on 2010-05-27
1030

            
cleanup
yuki-kimoto authored on 2010-10-17
1031
L<DBIx::Custom> inherits all methods from L<Object::Simple>
1032
and implements the following new ones.
added check_filter attribute
yuki-kimoto authored on 2010-08-08
1033

            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
1034
=head2 C<(experimental) apply_filter >
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1035

            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
1036
    $dbi->apply_filter(
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1037
        $table,
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
1038
        $column1 => {in => $infilter1, out => $outfilter1}
1039
        $column2 => {in => $infilter2, out => $outfilter2}
1040
        ...,
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1041
    );
1042

            
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
1043
C<apply_filter> is automatically filter for columns of table.
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1044
This have effect C<insert>, C<update>, C<delete>. C<select>
cleanup
Yuki Kimoto authored on 2010-12-21
1045
and L<DBIx::Custom::Result> object. but this has'nt C<execute> method.
1046

            
cleanup
Yuki Kimoto authored on 2011-01-12
1047
If you want to have effect C<execute()> method, use C<table>
cleanup
Yuki Kimoto authored on 2010-12-21
1048
arguments.
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1049

            
cleanup
Yuki Kimoto authored on 2010-12-21
1050
    $result = $dbi->execute(
1051
        "select * from table1 where {= key1} and {= key2};",
1052
         param => {key1 => 1, key2 => 2},
renamed auto_filter to apply...
Yuki Kimoto authored on 2011-01-12
1053
         table => ['table1']
cleanup
Yuki Kimoto authored on 2010-12-21
1054
    );
1055
    
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1056
=head2 C<begin_work>
added check_filter attribute
yuki-kimoto authored on 2010-08-08
1057

            
cleanup
yuki-kimoto authored on 2010-10-17
1058
    $dbi->begin_work;
added check_filter attribute
yuki-kimoto authored on 2010-08-08
1059

            
cleanup
yuki-kimoto authored on 2010-10-17
1060
Start transaction.
1061
This is same as L<DBI>'s C<begin_work>.
added commit method
yuki-kimoto authored on 2010-05-27
1062

            
cleanup
yuki-kimoto authored on 2010-08-05
1063
L<DBIx::Custom> inherits all methods from L<Object::Simple>
1064
and implements the following new ones.
added commit method
yuki-kimoto authored on 2010-05-27
1065

            
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1066
=head2 C<commit>
cleanup
yuki-kimoto authored on 2010-10-17
1067

            
1068
    $dbi->commit;
1069

            
1070
Commit transaction.
1071
This is same as L<DBI>'s C<commit>.
1072

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1073
=head2 C<connect>
packaging one directory
yuki-kimoto authored on 2009-11-16
1074

            
cleanup
yuki-kimoto authored on 2010-08-05
1075
    my $dbi = DBIx::Custom->connect(data_source => "dbi:mysql:database=dbname",
update document
yuki-kimoto authored on 2010-05-27
1076
                                    user => 'ken', password => '!LFKD%$&');
bind_filter argument is chan...
yuki-kimoto authored on 2009-11-19
1077

            
cleanup
yuki-kimoto authored on 2010-08-05
1078
Create a new L<DBIx::Custom> object and connect to the database.
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1079
L<DBIx::Custom> is a wrapper of L<DBI>.
cleanup
yuki-kimoto authored on 2010-08-09
1080
C<AutoCommit> and C<RaiseError> options are true, 
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1081
and C<PrintError> option is false by default. 
packaging one directory
yuki-kimoto authored on 2009-11-16
1082

            
cleanup
yuki-kimoto authored on 2010-10-17
1083
=head2 C<create_query>
1084
    
1085
    my $query = $dbi->create_query(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1086
        "select * from book where {= author} and {like title};"
cleanup
yuki-kimoto authored on 2010-10-17
1087
    );
update document
yuki-kimoto authored on 2009-11-19
1088

            
cleanup
yuki-kimoto authored on 2010-10-17
1089
Create the instance of L<DBIx::Custom::Query> from the source of SQL.
1090
If you want to get high performance,
1091
use C<create_query()> method and execute it by C<execute()> method
1092
instead of suger methods.
bind_filter argument is chan...
yuki-kimoto authored on 2009-11-19
1093

            
cleanup
yuki-kimoto authored on 2010-10-17
1094
    $dbi->execute($query, {author => 'Ken', title => '%Perl%'});
version 0.0901
yuki-kimoto authored on 2009-12-17
1095

            
cleanup
yuki-kimoto authored on 2010-10-17
1096
=head2 C<execute>
packaging one directory
yuki-kimoto authored on 2009-11-16
1097

            
cleanup
yuki-kimoto authored on 2010-10-17
1098
    my $result = $dbi->execute($query,  param => $params, filter => \%filter);
1099
    my $result = $dbi->execute($source, param => $params, filter => \%filter);
update document
yuki-kimoto authored on 2009-11-19
1100

            
cleanup
yuki-kimoto authored on 2010-10-17
1101
Execute query or the source of SQL.
1102
Query is L<DBIx::Custom::Query> object.
1103
Return value is L<DBIx::Custom::Result> if select statement is executed,
1104
or the count of affected rows if insert, update, delete statement is executed.
version 0.0901
yuki-kimoto authored on 2009-12-17
1105

            
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1106
B<Example:>
update document
yuki-kimoto authored on 2009-11-19
1107

            
cleanup
yuki-kimoto authored on 2010-10-17
1108
    my $result = $dbi->execute(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1109
        "select * from book where {= author} and {like title}", 
cleanup
yuki-kimoto authored on 2010-10-17
1110
        param => {author => 'Ken', title => '%Perl%'}
1111
    );
1112
    
1113
    while (my $row = $result->fetch) {
1114
        my $author = $row->[0];
1115
        my $title  = $row->[1];
1116
    }
packaging one directory
yuki-kimoto authored on 2009-11-16
1117

            
added experimental expand me...
yuki-kimoto authored on 2010-10-20
1118
=head2 C<(experimental) expand>
1119

            
1120
    my %expand = $dbi->expand($source);
1121

            
1122
The following hash
1123

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1124
    {book => {title => 'Perl', author => 'Ken'}}
added experimental expand me...
yuki-kimoto authored on 2010-10-20
1125

            
1126
is expanded to
1127

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1128
    ('book.title' => 'Perl', 'book.author' => 'Ken')
added experimental expand me...
yuki-kimoto authored on 2010-10-20
1129

            
1130
This is used in C<select()>
1131

            
1132

            
1133
    
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1134
=head2 C<delete>
packaging one directory
yuki-kimoto authored on 2009-11-16
1135

            
cleanup
yuki-kimoto authored on 2010-08-05
1136
    $dbi->delete(table  => $table,
1137
                 where  => \%where,
1138
                 append => $append,
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1139
                 filter => \%filter,
1140
                 query  => 1);
bind_filter argument is chan...
yuki-kimoto authored on 2009-11-19
1141

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1142
Execute delete statement.
1143
C<delete> method have C<table>, C<where>, C<append>, and C<filter> arguments.
1144
C<table> is a table name.
1145
C<where> is where clause. this must be hash reference.
1146
C<append> is a string added at the end of the SQL statement.
1147
C<filter> is filters when parameter binding is executed.
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1148
C<query> is if you don't execute sql and get L<DBIx::Custom::Query> object as return value.
1149
default to 0. This is experimental.
cleanup
yuki-kimoto authored on 2010-08-09
1150
Return value of C<delete()> is the count of affected rows.
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1151

            
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1152
B<Example:>
packaging one directory
yuki-kimoto authored on 2009-11-16
1153

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1154
    $dbi->delete(table  => 'book',
removed register_format()
yuki-kimoto authored on 2010-05-26
1155
                 where  => {id => 5},
1156
                 append => 'some statement',
removed reconnect method
yuki-kimoto authored on 2010-05-28
1157
                 filter => {id => 'encode_utf8'});
version 0.0901
yuki-kimoto authored on 2009-12-17
1158

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1159
=head2 C<delete_all>
packaging one directory
yuki-kimoto authored on 2009-11-16
1160

            
cleanup
yuki-kimoto authored on 2010-08-05
1161
    $dbi->delete_all(table => $table);
packaging one directory
yuki-kimoto authored on 2009-11-16
1162

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1163
Execute delete statement to delete all rows.
1164
Arguments is same as C<delete> method,
1165
except that C<delete_all> don't have C<where> argument.
cleanup
yuki-kimoto authored on 2010-08-09
1166
Return value of C<delete_all()> is the count of affected rows.
bind_filter argument is chan...
yuki-kimoto authored on 2009-11-19
1167

            
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1168
B<Example:>
removed register_format()
yuki-kimoto authored on 2010-05-26
1169
    
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1170
    $dbi->delete_all(table => 'book');
packaging one directory
yuki-kimoto authored on 2009-11-16
1171

            
added helper method
yuki-kimoto authored on 2010-10-17
1172
=head2 C<(experimental) helper>
1173

            
1174
    $dbi->helper(
1175
        update_or_insert => sub {
1176
            my $self = shift;
1177
            # do something
1178
        },
1179
        find_or_create   => sub {
1180
            my $self = shift;
1181
            # do something
1182
        }
1183
    );
1184

            
1185
Register helper methods. These method is called from L<DBIx::Custom> object directory.
1186

            
1187
    $dbi->update_or_insert;
1188
    $dbi->find_or_create;
1189

            
cleanup
yuki-kimoto authored on 2010-10-17
1190
=head2 C<insert>
1191

            
1192
    $dbi->insert(table  => $table, 
1193
                 param  => \%param,
1194
                 append => $append,
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1195
                 filter => \%filter,
1196
                 query  => 1);
cleanup
yuki-kimoto authored on 2010-10-17
1197

            
1198
Execute insert statement.
1199
C<insert> method have C<table>, C<param>, C<append>
1200
and C<filter> arguments.
1201
C<table> is a table name.
1202
C<param> is the pairs of column name value. this must be hash reference.
1203
C<append> is a string added at the end of the SQL statement.
1204
C<filter> is filters when parameter binding is executed.
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1205
C<query> is if you don't execute sql and get L<DBIx::Custom::Query> object as return value.
1206
default to 0. This is experimental.
cleanup
yuki-kimoto authored on 2010-10-17
1207
This is overwrites C<default_bind_filter>.
1208
Return value of C<insert()> is the count of affected rows.
1209

            
1210
B<Example:>
1211

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1212
    $dbi->insert(table  => 'book', 
cleanup
yuki-kimoto authored on 2010-10-17
1213
                 param  => {title => 'Perl', author => 'Taro'},
1214
                 append => "some statement",
1215
                 filter => {title => 'encode_utf8'})
1216

            
added dbi_options attribute
kimoto authored on 2010-12-20
1217
=head2 C<new>
1218

            
1219
    my $dbi = DBIx::Custom->connect(data_source => "dbi:mysql:database=dbname",
1220
                                    user => 'ken', password => '!LFKD%$&');
1221

            
1222
Create a new L<DBIx::Custom> object.
1223

            
added experimental iterate_a...
Yuki Kimoto authored on 2010-12-22
1224
=head2 C<(experimental) iterate_all_columns>
1225

            
1226
    $dbi->iterate_all_columns(
1227
        sub {
1228
            my ($table, $column, $column_info) = @_;
1229
            
1230
            # do something;
1231
        }
1232
    );
1233

            
1234
Iterate all columns of all tables. Argument is callback.
1235
You can do anything by callback.
1236

            
experimental extended select...
Yuki Kimoto authored on 2011-01-17
1237
=head2 C<(experimental) or>
1238

            
1239
    $or = $dbi->or(1, 5);
1240

            
1241
Create L<DBIx::Custom::Or> object. This is used with select method's
1242
where option.
1243

            
cleanup
yuki-kimoto authored on 2010-10-17
1244
=head2 C<register_filter>
1245

            
1246
    $dbi->register_filter(%filters);
1247
    $dbi->register_filter(\%filters);
1248
    
1249
Register filter. Registered filters is available in the following attributes
1250
or arguments.
1251

            
1252
=over 4
1253

            
1254
=item *
1255

            
1256
C<filter> argument of C<insert()>, C<update()>,
1257
C<update_all()>, C<delete()>, C<delete_all()>, C<select()>
1258
methods
1259

            
1260
=item *
1261

            
1262
C<execute()> method
1263

            
1264
=item *
1265

            
1266
C<default_filter> and C<filter> of C<DBIx::Custom::Query>
1267

            
1268
=item *
1269

            
1270
C<default_filter> and C<filter> of C<DBIx::Custom::Result>
1271

            
1272
=back
1273

            
1274
B<Example:>
1275

            
1276
    $dbi->register_filter(
1277
        encode_utf8 => sub {
1278
            my $value = shift;
1279
            
1280
            require Encode;
1281
            
1282
            return Encode::encode('UTF-8', $value);
1283
        },
1284
        decode_utf8 => sub {
1285
            my $value = shift;
1286
            
1287
            require Encode;
1288
            
1289
            return Encode::decode('UTF-8', $value)
1290
        }
1291
    );
1292

            
added auto_filter method
kimoto.yuki@gmail.com authored on 2010-12-21
1293
=head2 C<rollback>
cleanup
yuki-kimoto authored on 2010-10-17
1294

            
1295
    $dbi->rollback;
1296

            
1297
Rollback transaction.
1298
This is same as L<DBI>'s C<rollback>.
1299

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1300
=head2 C<select>
packaging one directory
yuki-kimoto authored on 2009-11-16
1301
    
cleanup
yuki-kimoto authored on 2010-08-05
1302
    my $result = $dbi->select(table    => $table,
1303
                              column   => [@column],
1304
                              where    => \%where,
1305
                              append   => $append,
1306
                              relation => \%relation,
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1307
                              filter   => \%filter,
1308
                              query    => 1);
update document
yuki-kimoto authored on 2009-11-19
1309

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1310
Execute select statement.
cleanup
yuki-kimoto authored on 2010-08-09
1311
C<select> method have C<table>, C<column>, C<where>, C<append>,
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1312
C<relation> and C<filter> arguments.
1313
C<table> is a table name.
cleanup
yuki-kimoto authored on 2010-08-09
1314
C<where> is where clause. this is normally hash reference.
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1315
C<append> is a string added at the end of the SQL statement.
1316
C<filter> is filters when parameter binding is executed.
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1317
C<query> is if you don't execute sql and get L<DBIx::Custom::Query> object as return value.
1318
default to 0. This is experimental.
update document
yuki-kimoto authored on 2009-11-19
1319

            
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1320
B<Example:>
update document
yuki-kimoto authored on 2009-11-19
1321

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1322
    # select * from book;
1323
    my $result = $dbi->select(table => 'book');
packaging one directory
yuki-kimoto authored on 2009-11-16
1324
    
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1325
    # select * from book where title = ?;
1326
    my $result = $dbi->select(table => 'book', where => {title => 'Perl'});
update document
yuki-kimoto authored on 2009-11-19
1327
    
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1328
    # select title, author from book where id = ? for update;
cleanup
yuki-kimoto authored on 2010-08-05
1329
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1330
        table  => 'book',
removed reconnect method
yuki-kimoto authored on 2010-05-28
1331
        column => ['title', 'author'],
removed register_format()
yuki-kimoto authored on 2010-05-26
1332
        where  => {id => 1},
1333
        appned => 'for update'
update document
yuki-kimoto authored on 2009-11-19
1334
    );
1335
    
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1336
    # select book.name as book_name from book, rental
1337
    # where book.id = rental.book_id;
added commit method
yuki-kimoto authored on 2010-05-27
1338
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1339
        table    => ['book', 'rental'],
1340
        column   => ['book.name as book_name']
1341
        relation => {'book.id' => 'rental.book_id'}
update document
yuki-kimoto authored on 2009-11-19
1342
    );
1343

            
cleanup
yuki-kimoto authored on 2010-08-09
1344
If you use more complex condition,
1345
you can specify a array reference to C<where> argument.
1346

            
1347
    my $result = $dbi->select(
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1348
        table  => 'book',
cleanup
yuki-kimoto authored on 2010-08-09
1349
        column => ['title', 'author'],
1350
        where  => ['{= title} or {like author}',
1351
                   {title => '%Perl%', author => 'Ken'}]
1352
    );
1353

            
1354
First element is a string. it contains tags,
1355
such as "{= title} or {like author}".
1356
Second element is paramters.
1357

            
cleanup
yuki-kimoto authored on 2010-10-17
1358
=head2 C<update>
removed reconnect method
yuki-kimoto authored on 2010-05-28
1359

            
cleanup
yuki-kimoto authored on 2010-10-17
1360
    $dbi->update(table  => $table, 
1361
                 param  => \%params,
1362
                 where  => \%where,
1363
                 append => $append,
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1364
                 filter => \%filter,
1365
                 query  => 1)
removed reconnect method
yuki-kimoto authored on 2010-05-28
1366

            
cleanup
yuki-kimoto authored on 2010-10-17
1367
Execute update statement.
1368
C<update> method have C<table>, C<param>, C<where>, C<append>
1369
and C<filter> arguments.
1370
C<table> is a table name.
1371
C<param> is column-value pairs. this must be hash reference.
1372
C<where> is where clause. this must be hash reference.
1373
C<append> is a string added at the end of the SQL statement.
1374
C<filter> is filters when parameter binding is executed.
added experimental sugar met...
Yuki Kimoto authored on 2011-01-17
1375
C<query> is if you don't execute sql and get L<DBIx::Custom::Query> object as return value.
1376
default to 0. This is experimental.
cleanup
yuki-kimoto authored on 2010-10-17
1377
This is overwrites C<default_bind_filter>.
1378
Return value of C<update()> is the count of affected rows.
removed reconnect method
yuki-kimoto authored on 2010-05-28
1379

            
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1380
B<Example:>
removed reconnect method
yuki-kimoto authored on 2010-05-28
1381

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1382
    $dbi->update(table  => 'book',
cleanup
yuki-kimoto authored on 2010-10-17
1383
                 param  => {title => 'Perl', author => 'Taro'},
1384
                 where  => {id => 5},
1385
                 append => "some statement",
1386
                 filter => {title => 'encode_utf8'});
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1387

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1388
=head2 C<(experimental) txn_scope>
1389

            
1390
    {
1391
        my $txn = $dbi->txn_scope;
1392
        $dbi->insert(table => 'book', param => {title => 'Perl'});
1393
        $dbi->insert(table => 'book', param => {title => 'Good days'});
1394
        $txn->commit;
1395
    }
1396

            
1397
Create transaction scope. If you escape scope(that is { .. }) and commited,
1398
Rollback is automatically done.
1399

            
1400
Note that this is feature of L<DBIx::TransactionManager>
1401
L<DBIx::TransactionManager> is required.
1402

            
cleanup
Yuki Kimoto authored on 2011-01-12
1403
=head2 C<(experimental) table>
remove DBIx::Custom::Model
Yuki Kimoto authored on 2011-01-12
1404

            
1405
    $dbi->table('book',
1406
        insert => sub { ... },
1407
        update => sub { ... }
1408
    );
1409
    
1410
    my $table = $dbi->table('book');
1411

            
1412
Create a L<DBIx::Custom::Table> object,
1413
or get a L<DBIx::Custom::Table> object.
1414

            
cleanup
yuki-kimoto authored on 2010-10-17
1415
=head2 C<update_all>
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1416

            
cleanup
yuki-kimoto authored on 2010-10-17
1417
    $dbi->update_all(table  => $table, 
1418
                     param  => \%params,
1419
                     filter => \%filter,
1420
                     append => $append);
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1421

            
cleanup
yuki-kimoto authored on 2010-10-17
1422
Execute update statement to update all rows.
1423
Arguments is same as C<update> method,
1424
except that C<update_all> don't have C<where> argument.
1425
Return value of C<update_all()> is the count of affected rows.
removed DBIx::Custom commit ...
yuki-kimoto authored on 2010-07-14
1426

            
1427
B<Example:>
packaging one directory
yuki-kimoto authored on 2009-11-16
1428

            
added insert, update, update...
Yuki Kimoto authored on 2011-01-04
1429
    $dbi->update_all(table  => 'book', 
cleanup
yuki-kimoto authored on 2010-10-17
1430
                     param  => {author => 'taro'},
1431
                     filter => {author => 'encode_utf8'});
removed reconnect method
yuki-kimoto authored on 2010-05-28
1432

            
cleanup
Yuki Kimoto authored on 2011-01-12
1433
=head2 C<(deprecated) default_bind_filter>
1434

            
1435
    my $default_bind_filter = $dbi->default_bind_filter;
1436
    $dbi                    = $dbi->default_bind_filter($fname);
1437

            
1438
Default filter when parameter binding is executed.
1439

            
1440
=head2 C<(deprecated) default_fetch_filter>
1441

            
1442
    my $default_fetch_filter = $dbi->default_fetch_filter;
1443
    $dbi = $dbi->default_fetch_filter($fname);
1444

            
1445
=head2 C<(deprecated) cache_method>
1446

            
1447
    $dbi          = $dbi->cache_method(\&cache_method);
1448
    $cache_method = $dbi->cache_method
1449

            
1450
Method to set and get caches.
1451

            
1452
B<Example:>
1453

            
1454
    $dbi->cache_method(
1455
        sub {
1456
            my $self = shift;
1457
            
1458
            $self->{_cached} ||= {};
1459
            
1460
            if (@_ > 1) {
1461
                $self->{_cached}{$_[0]} = $_[1] 
1462
            }
1463
            else {
1464
                return $self->{_cached}{$_[0]}
1465
            }
1466
        }
1467
    );
1468

            
DBIx::Custom is now stable
yuki-kimoto authored on 2010-09-07
1469
=head1 STABILITY
1470

            
1471
L<DBIx::Custom> is now stable. APIs keep backword compatible in the feature.
1472

            
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1473
=head1 BUGS
1474

            
renamed build_query to creat...
yuki-kimoto authored on 2010-08-06
1475
Please tell me bugs if found.
removed DESTROY method(not b...
yuki-kimoto authored on 2010-07-18
1476

            
1477
C<< <kimoto.yuki at gmail.com> >>
1478

            
1479
L<http://github.com/yuki-kimoto/DBIx-Custom>
1480

            
removed reconnect method
yuki-kimoto authored on 2010-05-28
1481
=head1 AUTHOR
1482

            
1483
Yuki Kimoto, C<< <kimoto.yuki at gmail.com> >>
version 0.0901
yuki-kimoto authored on 2009-12-17
1484

            
packaging one directory
yuki-kimoto authored on 2009-11-16
1485
=head1 COPYRIGHT & LICENSE
1486

            
1487
Copyright 2009 Yuki Kimoto, all rights reserved.
1488

            
1489
This program is free software; you can redistribute it and/or modify it
1490
under the same terms as Perl itself.
1491

            
1492
=cut
added cache_method attribute
yuki-kimoto authored on 2010-06-25
1493

            
1494