lib/SQL/Translator/Parser/Excel.pm

   1 package SQL::Translator::Parser::Excel;
   2
   3 # -------------------------------------------------------------------
   4 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
   5 #                    darren chamberlain <darren@cpan.org>,
   6 #                    Chris Mungall <cjm@fruitfly.org>,
   7 #                    Mike Mellilo <mmelillo@users.sourceforge.net>
   8 #
   9 # This program is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License as
  11 # published by the Free Software Foundation; version 2.
  12 #
  13 # This program is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  21 # 02111-1307  USA
  22 # -------------------------------------------------------------------
  23
  24 =head1 NAME
  25
  26 SQL::Translator::Parser::Excel - parser for Excel
  27
  28 =head1 SYNOPSIS
  29
  30   use SQL::Translator;
  31   use SQL::Translator::Parser::Excel;
  32
  33   my $translator = SQL::Translator->new;
  34   $translator->parser("SQL::Translator::Parser::Excel");
  35
  36 =head1 DESCRIPTION
  37
  38 Parses an Excel spreadsheet file for SQL::Translator.  You can then
  39 turn the data into a database tables or graphs.
  40
  41 =cut
  42
  43 use strict;
  44 use vars qw($DEBUG $VERSION @EXPORT_OK);
  45 $DEBUG = 0 unless defined $DEBUG;
  46
  47 use Spreadsheet::ParseExcel;
  48 use Exporter;
  49 use SQL::Translator::Utils qw(debug normalize_name);
  50
  51 use base qw(Exporter);
  52
  53 @EXPORT_OK = qw(parse);
  54
  55 my %ET_to_ST  = (
  56     'Text'    => 'VARCHAR',
  57     'Date'    => 'DATETIME',
  58     'Numeric' => 'DOUBLE',
  59 );
  60
  61 # -------------------------------------------------------------------
  62 # parse($tr, $data)
  63 #
  64 # Note that $data, in the case of this parser, is unuseful.
  65 # Spreadsheet::ParseExcel works on files, not data streams.
  66 # -------------------------------------------------------------------
  67 sub parse {
  68     my ($tr, $data) = @_;
  69     my $filename    = $tr->filename || return;
  70     my $wb          = Spreadsheet::ParseExcel::Workbook->Parse( $filename );
  71     my $schema      = $tr->schema;
  72     my $table_no    = 0;
  73
  74     my $wb_count = $wb->{'SheetCount'} || 0;
  75     for my $num ( 0 .. $wb_count - 1 ) {
  76         $table_no++;
  77         my $ws         = $wb->Worksheet( $num );
  78         my $table_name = normalize_name( $ws->{'Name'} || "Table$table_no" );
  79
  80         my @cols = $ws->ColRange;
  81         next unless $cols[1] > 0;
  82
  83         my $table = $schema->add_table( name => $table_name );
  84
  85         for my $col ( $cols[0] .. $cols[1] ) {
  86             my $cell      = $ws->Cell(0, $col);
  87             my $col_name  = normalize_name( $cell->{'Val'} );
  88             my $data_type = ET_to_ST( $cell->{'Type'} );
  89
  90             my $field = $table->add_field(
  91                 name              => $col_name,
  92                 data_type         => $data_type,
  93                 default_value     => '',
  94                 size              => 255,
  95                 is_nullable       => 1,
  96                 is_auto_increment => undef,
  97             ) or die $table->error;
  98
  99             if ( $col == 0 ) {
 100                 $table->primary_key( $field->name );
 101                 $field->is_primary_key(1);
 102             }
 103         }
 104     }
 105
 106     return 1;
 107 }
 108
 109 sub ET_to_ST {
 110     my $et = shift;
 111     $ET_to_ST{$et} || $ET_to_ST{'Text'};
 112 }
 113
 114 1;
 115
 116 # -------------------------------------------------------------------
 117 # Education is an admirable thing,
 118 # but it is as well to remember that
 119 # nothing that is worth knowing can be taught.
 120 # Oscar Wilde
 121 # -------------------------------------------------------------------
 122
 123 =pod
 124
 125 =head1 AUTHORS
 126
 127 Mike Mellilo <mmelillo@users.sourceforge.net>,
 128 darren chamberlain E<lt>dlc@users.sourceforge.netE<gt>
 129 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
 130
 131 =head1 SEE ALSO
 132
 133 perl(1), Spreadsheet::ParseExcel.
 134
 135 =cut