.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Excel 3pm"
.TH Excel 3pm "2021-01-05" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
DBD::Excel \-  A class for DBI drivers that act on Excel File.
.PP
This is still alpha version.
.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 "\(bu" 4
Spreadsheet::ParseExcel
.Sp
reads Excel files.
.IP "\(bu" 4
Spreadsheet::WriteExcel
.Sp
writes Excel files.
.IP "\(bu" 4
SQL::Statement
.Sp
a simple \s-1SQL\s0 engine.
.IP "\(bu" 4
\&\s-1DBI\s0
.Sp
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.
.SS "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.
.SS "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 formatting.
.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)
\&
\&  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.