.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32

.\"

.\" Standard preamble:

.\" ========================================================================

.de Sh \" Subsection heading

.br

.if t .Sp

.ne 5

.PP

\fB\\$1\fR

.PP

..

.de Sp \" Vertical space (when we can't use .PP)

.if t .sp .5v

.if n .sp

..

.de Vb \" Begin verbatim text

.ft CW

.nf

.ne \\$1

..

.de Ve \" End verbatim text

.ft R

.fi

..

.\" Set up some character translations and predefined strings.  \*(-- will

.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left

.\" double quote, and \*(R" will give a right double quote.  | will give a

.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to

.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'

.\" expand to `' in nroff, nothing in troff, for use with C<>.

.tr \(*W-|\(bv\*(Tr

.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'

.ie n \{\

.    ds -- \(*W-

.    ds PI pi

.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch

.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch

.    ds L" ""

.    ds R" ""

.    ds C` ""

.    ds C' ""

'br\}

.el\{\

.    ds -- \|\(em\|

.    ds PI \(*p

.    ds L" ``

.    ds R" ''

'br\}

.\"

.\" If the F register is turned on, we'll generate index entries on stderr for

.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index

.\" entries marked with X<> in POD.  Of course, you'll have to process the

.\" output yourself in some meaningful fashion.

.if \nF \{\

.    de IX

.    tm Index:\\$1\t\\n%\t"\\$2"

..

.    nr % 0

.    rr F

.\}

.\"

.\" For nroff, turn off justification.  Always turn off hyphenation; it makes

.\" way too many mistakes in technical documents.

.hy 0

.if n .na

.\"

.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).

.\" Fear.  Run.  Save yourself.  No user-serviceable parts.

.    \" fudge factors for nroff and troff

.if n \{\

.    ds #H 0

.    ds #V .8m

.    ds #F .3m

.    ds #[ \f1

.    ds #] \fP

.\}

.if t \{\

.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)

.    ds #V .6m

.    ds #F 0

.    ds #[ \&

.    ds #] \&

.\}

.    \" simple accents for nroff and troff

.if n \{\

.    ds ' \&

.    ds ` \&

.    ds ^ \&

.    ds , \&

.    ds ~ ~

.    ds /

.\}

.if t \{\

.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"

.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'

.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'

.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'

.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'

.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'

.\}

.    \" troff and (daisy-wheel) nroff accents

.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'

.ds 8 \h'\*(#H'\(*b\h'-\*(#H'

.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]

.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'

.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'

.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]

.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]

.ds ae a\h'-(\w'a'u*4/10)'e

.ds Ae A\h'-(\w'A'u*4/10)'E

.    \" corrections for vroff

.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'

.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'

.    \" for low resolution devices (crt and lpr)

.if \n(.H>23 .if \n(.V>19 \

\{\

.    ds : e

.    ds 8 ss

.    ds o a

.    ds d- d\h'-1'\(ga

.    ds D- D\h'-1'\(hy

.    ds th \o'bp'

.    ds Th \o'LP'

.    ds ae ae

.    ds Ae AE

.\}

.rm #[ #] #H #V #F C

.\" ========================================================================

.\"

.IX Title "DBIx::Custom::Result 3"

.TH DBIx::Custom::Result 3 "2009-11-16" "perl v5.8.8" "User Contributed Perl Documentation"

.SH "NAME"

DBIx::Custom::Result \- Resultset for DBIx::Custom

.SH "VERSION"

.IX Header "VERSION"

Version 0.0301

.SH "SYNOPSIS"

.IX Header "SYNOPSIS"

.Vb 3

\&    # $result is DBIx::Custom::Result object

\&    my $dbi = DBIx::Custom->new;

\&    my $result = $dbi->query($sql_template, $param);

.Ve

.PP

.Vb 3

\&    while (my ($val1, $val2) = $result->fetch) {

\&        # do something

\&    }

.Ve

.SH "OBJECT ACCESSORS"

.IX Header "OBJECT ACCESSORS"

.Sh "sth"

.IX Subsection "sth"

.Vb 3

\&    # Set and Get statement handle

\&    $self = $result->sth($sth);

\&    $sth  = $reuslt->sth

.Ve

.PP

Statement handle is automatically set by DBIx::Custom.

so you do not set statement handle.

.PP

If you need statement handle, you can get statement handle by using this method.

.Sh "fetch_filter"

.IX Subsection "fetch_filter"

.Vb 3

\&    # Set and Get fetch filter

\&    $self         = $result->fetch_filter($sth);

\&    $fetch_filter = $result->fech_filter;

.Ve

.PP

Statement handle is automatically set by DBIx::Custom.

If you want to set your fetch filter, you set it.

.Sh "no_fetch_filters"

.IX Subsection "no_fetch_filters"

.Vb 3

\&    # Set and Get no filter keys when fetching

\&    $self             = $result->no_fetch_filters($no_fetch_filters);

\&    $no_fetch_filters = $result->no_fetch_filters;

.Ve

.SH "METHODS"

.IX Header "METHODS"

.Sh "fetch"

.IX Subsection "fetch"

.Vb 2

\&    # Fetch row as array reference (Scalar context)

\&    $row = $result->fetch;

.Ve

.PP

.Vb 2

\&    # Fetch row as array (List context)

\&    @row = $result->fecth

.Ve

.PP

.Vb 6

\&    # Sample

\&    while (my $row = $result->fetch) {

\&        # do something

\&        my $val1 = $row->[0];

\&        my $val2 = $row->[1];

\&    }

.Ve

.PP

fetch method is fetch resultset and get row as array or array reference.

.Sh "fetch_hash"

.IX Subsection "fetch_hash"

.Vb 2

\&    # Fetch row as hash reference (Scalar context)

\&    $row = $result->fetch_hash;

.Ve

.PP

.Vb 2

\&    # Fetch row as hash (List context)

\&    %row = $result->fecth_hash

.Ve

.PP

.Vb 6

\&    # Sample

\&    while (my $row = $result->fetch_hash) {

\&        # do something

\&        my $val1 = $row->{key1};

\&        my $val2 = $row->{key2};

\&    }

.Ve

.PP

fetch_hash method is fetch resultset and get row as hash or hash reference.

.Sh "fetch_first"

.IX Subsection "fetch_first"

.Vb 2

\&    # Fetch only first (Scalar context)

\&    $row = $result->fetch_first;

.Ve

.PP

.Vb 2

\&    # Fetch only first (List context)

\&    @row = $result->fetch_first;

.Ve

.PP

This method fetch only first and finish statement handle

.Sh "fetch_hash_first"

.IX Subsection "fetch_hash_first"

.Vb 2

\&    # Fetch only first as hash (Scalar context)

\&    $row = $result->fetch_hash_first;

.Ve

.PP

.Vb 2

\&    # Fetch only first as hash (Scalar context)

\&    @row = $result->fetch_hash_first;

.Ve

.PP

This method fetch only first and finish statement handle

.Sh "fetch_rows"

.IX Subsection "fetch_rows"

.Vb 2

\&    # Fetch multi rows (Scalar context)

\&    $rows = $result->fetch_rows($row_count);

.Ve

.PP

.Vb 2

\&    # Fetch multi rows (List context)

\&    @rows = $result->fetch_rows($row_count);

.Ve

.PP

.Vb 2

\&    # Sapmle 

\&    $rows = $result->fetch_rows(10);

.Ve

.Sh "fetch_hash_rows"

.IX Subsection "fetch_hash_rows"

.Vb 2

\&    # Fetch multi rows as hash (Scalar context)

\&    $rows = $result->fetch_hash_rows($row_count);

.Ve

.PP

.Vb 2

\&    # Fetch multi rows as hash (List context)

\&    @rows = $result->fetch_hash_rows($row_count);

.Ve

.PP

.Vb 2

\&    # Sapmle 

\&    $rows = $result->fetch_hash_rows(10);

.Ve

.Sh "fetch_all"

.IX Subsection "fetch_all"

.Vb 2

\&    # Fetch all row as array ref of array ref (Scalar context)

\&    $rows = $result->fetch_all;

.Ve

.PP

.Vb 2

\&    # Fetch all row as array of array ref (List context)

\&    @rows = $result->fecth_all;

.Ve

.PP

.Vb 4

\&    # Sample

\&    my $rows = $result->fetch_all;

\&    my $val0_0 = $rows->[0][0];

\&    my $val1_1 = $rows->[1][1];

.Ve

.PP

fetch_all method is fetch resultset and get all rows as array or array reference.

.Sh "fetch_hash_all"

.IX Subsection "fetch_hash_all"

.Vb 2

\&    # Fetch all row as array ref of hash ref (Scalar context)

\&    $rows = $result->fetch_hash_all;

.Ve

.PP

.Vb 2

\&    # Fetch all row as array of hash ref (List context)

\&    @rows = $result->fecth_all_hash;

.Ve

.PP

.Vb 4

\&    # Sample

\&    my $rows = $result->fetch_hash_all;

\&    my $val0_key1 = $rows->[0]{key1};

\&    my $val1_key2 = $rows->[1]{key2};

.Ve

.Sh "error"

.IX Subsection "error"

.Vb 3

\&    # Get error infomation

\&    $error_messege = $result->error;

\&    ($error_message, $error_number, $error_state) = $result->error;

.Ve

.PP

You can get get information. This is crenspond to the following.

.PP

.Vb 3

\&    $error_message : $result->sth->errstr

\&    $error_number  : $result->sth->err

\&    $error_state   : $result->sth->state

.Ve

.Sh "finish"

.IX Subsection "finish"

.Vb 2

\&    # Finish statement handle

\&    $result->finish

.Ve

.PP

.Vb 3

\&    # Sample

\&    my $row = $reuslt->fetch; # fetch only one row

\&    $result->finish

.Ve

.PP

You can finish statement handle.This is equel to

.PP

.Vb 1

\&    $result->sth->finish;

.Ve

.SH "AUTHOR"

.IX Header "AUTHOR"

Yuki Kimoto, \f(CW\*(C`<kimoto.yuki at gmail.com>\*(C'\fR

.PP

Github <http://github.com/yuki\-kimoto>

.SH "COPYRIGHT & LICENSE"

.IX Header "COPYRIGHT & LICENSE"

Copyright 2009 Yuki Kimoto, all rights reserved.

.PP

This program is free software; you can redistribute it and/or modify it

under the same terms as Perl itself.