.\" 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.  \*(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-
.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 "Excel 3pm"
.TH Excel 3pm "2008-03-01" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
DBD::Excel \-  A class for DBI drivers that act on Excel File.
.PP
This is still \fBalpha version\fR.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&    use DBI;
\&    $hDb = DBI\->connect("DBI:Excel:file=test.xls")
\&        or die "Cannot connect: " . $DBI::errstr;
\&    $hSt = $hDb\->prepare("CREATE TABLE a (id INTEGER, name CHAR(10))")
\&        or die "Cannot prepare: " . $hDb\->errstr();
\&    $hSt\->execute() or die "Cannot execute: " . $hSt\->errstr();
\&    $hSt\->finish();
\&    $hDb\->disconnect();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is still \fBalpha version\fR.
.PP
The DBD::Excel module is a \s-1DBI\s0 driver.
The module is based on these modules:
.IP "* Spreadsheet::ParseExcel" 4
.IX Item "Spreadsheet::ParseExcel"
reads Excel files.
.IP "* Spreadsheet::WriteExcel" 4
.IX Item "Spreadsheet::WriteExcel"
writes Excel files.
.IP "* SQL::Statement" 4
.IX Item "SQL::Statement"
a simple \s-1SQL\s0 engine.
.IP "* \s-1DBI\s0" 4
.IX Item "DBI"
Of course. :\-)
.PP
This module assumes \s-1TABLE\s0 = Worksheet.
The contents of first row of each worksheet as column name.
.PP
Adding that, this module accept temporary table definition at \*(L"connect\*(R" method 
with \*(L"xl_vtbl\*(R".
.PP
ex.
    my \f(CW$hDb\fR = \s-1DBI\-\s0>connect(
            \*(L"DBI:Excel:file=dbdtest.xls\*(R", undef, undef, 
                        {xl_vtbl => 
                            {\s-1TESTV\s0 => 
                                {
                                    sheetName => '\s-1TEST_V\s0',
                                    ttlRow    => 5,
                                    startCol  => 1,
                                    colCnt    => 4,
                                    datRow    => 6,
                                    datLmt    => 4,
                                }
                            }
                        });
.PP
For more information please refer sample/tex.pl included in this distribution.
.Sh "Metadata"
.IX Subsection "Metadata"
The following attributes are handled by \s-1DBI\s0 itself and not by DBD::Excel,
thus they all work like expected:
.PP
.Vb 9
\&    Active
\&    ActiveKids
\&    CachedKids
\&    CompatMode             (Not used)
\&    InactiveDestroy
\&    Kids
\&    PrintError
\&    RaiseError
\&    Warn                   (Not used)
.Ve
.PP
The following \s-1DBI\s0 attributes are handled by DBD::Excel:
.IP "AutoCommit" 4
.IX Item "AutoCommit"
Always on
.IP "ChopBlanks" 4
.IX Item "ChopBlanks"
Works
.IP "\s-1NUM_OF_FIELDS\s0" 4
.IX Item "NUM_OF_FIELDS"
Valid after \f(CW\*(C`$hSt\->execute\*(C'\fR
.IP "\s-1NUM_OF_PARAMS\s0" 4
.IX Item "NUM_OF_PARAMS"
Valid after \f(CW\*(C`$hSt\->prepare\*(C'\fR
.IP "\s-1NAME\s0" 4
.IX Item "NAME"
Valid after \f(CW\*(C`$hSt\->execute\*(C'\fR; undef for Non-Select statements.
.IP "\s-1NULLABLE\s0" 4
.IX Item "NULLABLE"
Not really working, always returns an array ref of one's.
Valid after \f(CW\*(C`$hSt\->execute\*(C'\fR; undef for Non-Select statements.
.PP
These attributes and methods are not supported:
.PP
.Vb 4
\&    bind_param_inout
\&    CursorName
\&    LongReadLen
\&    LongTruncOk
.Ve
.PP
Additional to the \s-1DBI\s0 attributes, you can use the following dbh
attribute:
.IP "xl_fmt" 4
.IX Item "xl_fmt"
This attribute is used for setting the formatter class for parsing.
.IP "xl_dir" 4
.IX Item "xl_dir"
This attribute is used only with \f(CW\*(C`data_sources\*(C'\fR on setting the directory where 
Excel files ('*.xls') are searched. It defaults to the current directory (\*(L".\*(R").
.IP "xl_vtbl" 4
.IX Item "xl_vtbl"
assumes specified area as a table.
\&\fISee sample/tex.pl\fR.
.IP "xl_skiphidden" 4
.IX Item "xl_skiphidden"
skip hidden rows(=row height is 0) and hidden columns(=column width is 0).
\&\fISee sample/thidden.pl\fR.
.IP "xl_ignorecase" 4
.IX Item "xl_ignorecase"
set casesensitive or not about table name and columns. 
Default is sensitive (maybe as SQL::Statement).
\&\fISee sample/thidden.pl\fR.
.Sh "Driver private methods"
.IX Subsection "Driver private methods"
.IP "data_sources" 4
.IX Item "data_sources"
The \f(CW\*(C`data_sources\*(C'\fR method returns a list of '*.xls' files of the current
directory in the form \*(L"DBI:Excel:xl_dir=$dirname\*(R".
.Sp
If you want to read the subdirectories of another directory, use
.Sp
.Vb 3
\&    my($hDr) = DBI\->install_driver("Excel");
\&    my(@list) = $hDr\->data_sources( 
\&                    { xl_dir => \(aq/usr/local/xl_data\(aq } );
.Ve
.IP "list_tables" 4
.IX Item "list_tables"
This method returns a list of sheet names contained in the \f(CW$hDb\fR\->{file}.
Example:
.Sp
.Vb 2
\&    my $hDb = DBI\->connect("DBI:Excel:file=test.xls");
\&    my @list = $hDb\->func(\(aqlist_tables\(aq);
.Ve
.SH "TODO"
.IX Header "TODO"
.IP "More tests" 4
.IX Item "More tests"
First of all...
.IP "Type and Format" 4
.IX Item "Type and Format"
The current version not support date/time and text formating.
.IP "Joins" 4
.IX Item "Joins"
The current version of the module works with single table \s-1SELECT\s0's
only, although the basic design of the SQL::Statement module allows
joins and the likes.
.SH "KNOWN BUGS"
.IX Header "KNOWN BUGS"
.IP "\(bu" 8
There are too many \s-1TODO\s0 things. So I can't determind what is \s-1BUG\s0. :\-)
.SH "AUTHOR"
.IX Header "AUTHOR"
Kawai Takanori (Hippo2000) kwitknr@cpan.org
.PP
.Vb 3
\&  Homepage:
\&    http://member.nifty.ne.jp/hippo2000/            (Japanese)
\&    http://member.nifty.ne.jp/hippo2000/index_e.htm (English)
.Ve
.PP
.Vb 3
\&  Wiki:
\&    http://www.hippo2000.net/cgi\-bin/KbWiki/KbWiki.pl  (Japanese)
\&    http://www.hippo2000.net/cgi\-bin/KbWikiE/KbWiki.pl (English)
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1DBI\s0, Spreadsheet::WriteExcel, Spreadsheet::ParseExcel, SQL::Statement
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001 \s-1KAWAI\s0,Takanori
All rights reserved.
.PP
You may distribute under the terms of either the \s-1GNU\s0 General Public
License or the Artistic License, as specified in the Perl \s-1README\s0 file.