1 package SQL::Translator::Parser::DBI;
3 # -------------------------------------------------------------------
4 # $Id: DBI.pm,v 1.7 2005-06-27 19:14:45 duality72 Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 SQL::Translator::Parser::DBI - "parser" for DBI handles
32 my $dbh = DBI->connect('dsn', 'user', 'pass',
35 FetchHashKeyName => 'NAME_lc',
39 my $translator = SQL::Translator->new(
48 my $translator = SQL::Translator->new(
51 dsn => 'dbi:mysql:FOO',
53 db_password => 'password',
59 This parser accepts an open database handle (or the arguments to create
60 one) and queries the database directly for the information.
62 The following are acceptable arguments:
68 An open DBI database handle. NB: Be sure to create the database with the
69 "FetchHashKeyName => 'NAME_lc'" option as all the DBI parsers expect
70 lowercased column names.
74 The DSN to use for connecting to a database.
78 The user name to use for connecting to a database.
82 The password to use for connecting to a database.
86 There is no need to specify which type of database you are querying as
87 this is determined automatically by inspecting $dbh->{'Driver'}{'Name'}.
88 If a parser exists for your database, it will be used automatically;
89 if not, the code will fail automatically (and you can write the parser
90 and contribute it to the project!).
92 Currently parsers exist for the following databases:
102 =item * PostgreSQL (still experimental)
106 Most of these parsers are able to query the database directly for the
107 structure rather than parsing a text file. For large schemas, this is
108 probably orders of magnitude faster than traditional parsing (which
109 uses Parse::RecDescent, an amazing module but really quite slow).
111 Though no Oracle parser currently exists, it would be fairly easy to
112 query an Oracle database directly by using DDL::Oracle to generate a
113 DDL for the schema and then using the normal Oracle parser on this.
114 Perhaps future versions of SQL::Translator will include the ability to
115 query Oracle directly and skip the parsing of a text file, too.
119 # -------------------------------------------------------------------
123 use vars qw($VERSION @EXPORT);
124 $VERSION = sprintf "%d.%02d", q$Revision: 1.7 $ =~ /(\d+)\.(\d+)/;
126 use constant DRIVERS => {
136 use SQL::Translator::Utils qw(debug);
138 use SQL::Translator::Parser::DBI::MySQL;
139 use SQL::Translator::Parser::DBI::SQLServer;
140 use SQL::Translator::Parser::DBI::SQLite;
141 use SQL::Translator::Parser::DBI::Sybase;
142 use SQL::Translator::Parser::DBI::PostgreSQL;
144 use base qw(Exporter);
148 # Passed a SQL::Translator instance and a string containing the data
151 my ( $tr, $data ) = @_;
153 my $args = $tr->parser_args;
154 my $dbh = $args->{'dbh'};
155 my $dsn = $args->{'dsn'};
156 my $db_user = $args->{'db_user'};
157 my $db_password = $args->{'db_password'};
160 die 'No DSN' unless $dsn;
161 $dbh = DBI->connect( $dsn, $db_user, $db_password,
163 FetchHashKeyName => 'NAME_lc',
171 die 'No database handle' unless defined $dbh;
173 my $db_type = $dbh->{'Driver'}{'Name'} or die 'Cannot determine DBI type';
174 my $driver = DRIVERS->{ lc $db_type } or die "$db_type not supported";
175 my $pkg = "SQL::Translator::Parser::DBI::$driver";
176 my $sub = $pkg.'::parse';
179 # I can't get this to work. I seem to have to have the "use"
186 &{ $sub }( $tr, $dbh ) or die "No result from $pkg";
189 $dbh->disconnect if defined $dbh;
198 # -------------------------------------------------------------------
203 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
207 DBI, SQL::Translator.