[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Parser / DBI / SQLServer.pm

package SQL::Translator::Parser::DBI::SQLServer;

# -------------------------------------------------------------------
# $Id: SQLServer.pm 1440 2009-01-17 16:31:57Z jawnsy $
# -------------------------------------------------------------------
# Copyright (C) 2002-2009 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307  USA
# -------------------------------------------------------------------

=head1 NAME

SQL::Translator::Parser::DBI::SQLServer - parser for SQL Server through DBD::ODBC

=head1 SYNOPSIS

See SQL::Translator::Parser::DBI.

=head1 DESCRIPTION

Uses DBI Catalog Methods.

=cut

use strict;
use DBI;
use SQL::Translator::Schema;
use Data::Dumper;

use vars qw[ $DEBUG @EXPORT_OK ];
$DEBUG   = 0 unless defined $DEBUG;

no strict 'refs';

# -------------------------------------------------------------------
sub parse {
    my ( $tr, $dbh ) = @_;

    if ($dbh->{FetchHashKeyName} ne 'NAME_uc') {
        warn "setting dbh attribute {FetchHashKeyName} to NAME_uc";
        $dbh->{FetchHashKeyName} = 'NAME_uc';
    }

    if ($dbh->{ChopBlanks} != 1) {
        warn "setting dbh attribute {ChopBlanks} to 1";
        $dbh->{ChopBlanks} = 1;
    }

    my $schema = $tr->schema;

    my ($sth, @tables, $columns);
    my $stuff;

    ### Columns

    # it is much quicker to slurp back everything all at once rather
    # than make repeated calls

    $sth = $dbh->column_info(undef, undef, undef, undef);


    foreach my $c (@{$sth->fetchall_arrayref({})}) {
        $columns
            ->{$c->{TABLE_CAT}}
                ->{$c->{TABLE_SCHEM}}
                    ->{$c->{TABLE_NAME}}
                        ->{columns}
                            ->{$c->{COLUMN_NAME}}= $c;
    }

    ### Tables and views

    # Get a list of the tables and views.
    $sth = $dbh->table_info();
    @tables   = @{$sth->fetchall_arrayref({})};

    my $h = $dbh->selectall_arrayref(q{
SELECT o.name, colid,c.text
  FROM syscomments c
  JOIN sysobjects o
    ON c.id = o.id
 WHERE o.type ='V'
ORDER BY o.name,
         c.colid
}
);

    # View text
    # I had always thought there was something 'hard' about
    # reconstructing text from syscomments ..
    # this seems to work fine and is certainly not complicated!

    foreach (@{$h}) {
        $stuff->{view}->{$_->[0]}->{text} .= $_->[2];
    }

    #### objects with indexes.
    map {
        $stuff->{indexes}->{$_->[0]}++
            if defined;
    } @{$dbh->selectall_arrayref("SELECT DISTINCT object_name(id)
                                    FROM sysindexes
                                   WHERE indid > 0 and indid < 255 and
                                         name not like '_WA_Sys%'")};

    ## slurp objects
    map {
        $stuff->{$_->[1]}->{$_->[0]} = $_;
    } @{$dbh->selectall_arrayref("SELECT name,type, id FROM sysobjects")};


    ### Procedures

    # This gets legitimate procedures by used the 'supported' API: sp_stored_procedures
    map {
        my $n = $_->{PROCEDURE_NAME};
        $n =~ s/;\d+$//;        # Ignore versions for now
        $_->{name} = $n;
        $stuff->{procedures}->{$n} = $_;
    } values %{$dbh->selectall_hashref("sp_stored_procedures", 'PROCEDURE_NAME')};


    # And this blasts in the text of 'legit' stored procedures.  Do
    # this rather than calling sp_helptext in a loop.

    $h = $dbh->selectall_arrayref(q{
SELECT o.name, colid,c.text
  FROM syscomments c
  JOIN sysobjects o
    ON c.id = o.id
 WHERE o.type in ('P', 'FN', 'TF', 'IF')
}
);

    foreach (@{$h}) {
        $stuff->{procedures}->{$_->[0]}->{text} .= $_->[2]
            if (defined($stuff->{procedures}->{$_->[0]}));
    }

    ### Defaults
    ### Rules
    ### Bind Defaults
    ### Bind Rules

    ### Triggers
    # Since the 'target' of the trigger is defined in the text, we will
    # just create them independently for now rather than associating them
    # with a table.

    $h = $dbh->selectall_arrayref(q{
SELECT o.name, colid,c.text
  FROM syscomments c
  JOIN sysobjects o
    ON c.id = o.id
  JOIN sysobjects o1
    ON (o.id = o1.instrig OR o.id = o1.deltrig or o.id = o1.updtrig)
 WHERE o.type ='TR'
ORDER BY o.name,
         c.colid
}
);
    foreach (@{$h}) {
        $stuff->{triggers}->{$_->[0]}->{text} .= $_->[2];
    }

    ### References
    ### Keys

    ### Types
    # Not sure what to do with these?
    $stuff->{type_info_all} = $dbh->type_info_all;

    ### Tables
    # According to the DBI docs, these can be

    # "TABLE"
    # "VIEW"
    # "SYSTEM TABLE"
    # "GLOBAL TEMPORARY",
    # "LOCAL TEMPORARY"
    # "ALIAS"
    # "SYNONYM"

    foreach my $table_info (@tables) {
        next
            unless (defined($table_info->{TABLE_TYPE}));

        if ($table_info->{TABLE_TYPE} eq "TABLE") {
            my $table = $schema->add_table(
                                           name =>
$table_info->{TABLE_NAME},
                                           type =>
$table_info->{TABLE_TYPE},
                                          ) || die $schema->error;

            # find the associated columns

            my $cols =
                $columns->{$table_info->{TABLE_CAT}}
                    ->{$table_info->{TABLE_SCHEM}}
                        ->{$table_info->{TABLE_NAME}}
                            ->{columns};

            foreach my $c (values %{$cols}) {
				my $is_auto_increment = $c->{TYPE_NAME} =~ s#(\(\))? identity##i;
                my $f = $table->add_field(
                                          name        => $c->{COLUMN_NAME},
                                          data_type   => $c->{TYPE_NAME},
                                          order       => $c->{ORDINAL_POSITION},
                                          size        => $c->{COLUMN_SIZE},
                                         ) || die $table->error;
                $f->is_nullable($c->{NULLABLE} == 1);
                $f->is_auto_increment($is_auto_increment);
                if ( defined $c->{COLUMN_DEF}) {
                	$c->{COLUMN_DEF} =~ s#\('?(.*?)'?\)#$1#;
                	$f->default_value($c->{COLUMN_DEF});
                }
            }

            # add in primary key
            my $h = $dbh->selectall_hashref("sp_pkeys
$table_info->{TABLE_NAME}", 'COLUMN_NAME');
            if (scalar keys %{$h} >= 1) {
                my @c = map {
                    $_->{COLUMN_NAME}
                } sort {
                    $a->{KEY_SEQ} <=> $b->{KEY_SEQ}
                } values %{$h};

                $table->primary_key(@c)
                    if (scalar @c);
            }

            # add in foreign keys
            $h = $dbh->selectall_hashref("sp_fkeys NULL,
\@fktable_name = '$table_info->{TABLE_NAME}'", 'FK_NAME');
			foreach my $fk ( values %{$h} ) {
				my $constraint = $table->add_constraint( name => $fk->{FK_NAME},
					fields => [$fk->{FKCOLUMN_NAME}],
				);
				$constraint->type("FOREIGN_KEY");
				$constraint->on_delete(
					$fk->{DELETE_RULE} == 0 ? "CASCADE" :
					$fk->{DELETE_RULE} == 1 ? "NO ACTION" : "SET_NULL"
				);
				$constraint->on_update(
					$fk->{UPDATE_RULE} == 0 ? "CASCADE" :
					$fk->{UPDATE_RULE} == 1 ? "NO ACTION" : "SET_NULL"
				);
				$constraint->reference_table($fk->{PKTABLE_NAME});
			}

            # add in any indexes ... how do we tell if the index has
            # already been created as part of a primary key or other
            # constraint?

            if (defined($stuff->{indexes}->{$table_info->{TABLE_NAME}})){
                my $h = $dbh->selectall_hashref("sp_helpindex
$table_info->{TABLE_NAME}", 'INDEX_NAME');
                foreach (values %{$h}) {
                    my $fields = $_->{'INDEX_KEYS'};
                    $fields =~ s/\s*//g;
                    my $i = $table->add_index(
                                              name   =>
$_->{INDEX_NAME},
                                              fields => $fields,
                                             );
                    if ($_->{'INDEX_DESCRIPTION'} =~ /unique/i) {
                        $i->type('unique');

                        # we could make this a primary key if there
                        # isn't already one defined and if there
                        # aren't any nullable columns in thisindex.

                        if (!defined($table->primary_key())) {
                            $table->primary_key($fields)
                                unless grep {
                                    $table->get_field($_)->is_nullable()
                                } split(/,\s*/, $fields);
                        }
                    }
                }
            }
        } elsif ($table_info->{TABLE_TYPE} eq 'VIEW') {
        	next if $table_info->{TABLE_NAME} eq 'sysconstraints'
        		|| $table_info->{TABLE_NAME} eq 'syssegments';
        	next if !$stuff->{view}->{$table_info->{TABLE_NAME}}->{text};
            my $view =  $schema->add_view(
                                          name =>
$table_info->{TABLE_NAME},
                                          );


            my $cols =
                $columns->{$table_info->{TABLE_CAT}}
                    ->{$table_info->{TABLE_SCHEM}}
                        ->{$table_info->{TABLE_NAME}}
                            ->{columns};

            $view->fields(map {
                $_->{COLUMN_NAME}
            } sort {
                $a->{ORDINAL_POSITION} <=> $b->{ORDINAL_POSITION}
                } values %{$cols}
                         );

            $view->sql($stuff->{view}->{$table_info->{TABLE_NAME}}->{text})
                if (defined($stuff->{view}->{$table_info->{TABLE_NAME}}->{text}));
        }
    }

    foreach my $p (values %{$stuff->{procedures}}) {
    	next if !$p->{text};
        my $proc = $schema->add_procedure(
                               name      => $p->{name},
                               owner     => $p->{PROCEDURE_OWNER},
                               comments  => $p->{REMARKS},
                               sql       => $p->{text},
                               );

    }

    ### Permissions
    ### Groups
    ### Users
    ### Aliases
    ### Logins
    return 1;
}

1;

# -------------------------------------------------------------------

=pod

=head1 AUTHOR

Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
DBI-Sybase parser, I just tweaked it for SQLServer. Thanks.

=head1 SEE ALSO

DBI, DBD::ODBC, SQL::Translator::Schema.

=cut
Commit	Line	Data
4eb28bc3	1	package SQL::Translator::Parser::DBI::SQLServer;
	2
	3	# -------------------------------------------------------------------
d4f84dd1	4	# $Id: SQLServer.pm 1440 2009-01-17 16:31:57Z jawnsy $
4eb28bc3	5	# -------------------------------------------------------------------
478f608d	6	# Copyright (C) 2002-2009 SQLFairy Authors
4eb28bc3	7	#
	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.
	11	#
	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.
	16	#
	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
	20	# 02111-1307 USA
	21	# -------------------------------------------------------------------
	22
	23	=head1 NAME
	24
	25	SQL::Translator::Parser::DBI::SQLServer - parser for SQL Server through DBD::ODBC
	26
	27	=head1 SYNOPSIS
	28
	29	See SQL::Translator::Parser::DBI.
	30
	31	=head1 DESCRIPTION
	32
	33	Uses DBI Catalog Methods.
	34
	35	=cut
	36
	37	use strict;
	38	use DBI;
	39	use SQL::Translator::Schema;
	40	use Data::Dumper;
	41
478f608d	42	use vars qw[ $DEBUG @EXPORT_OK ];
4eb28bc3	43	$DEBUG = 0 unless defined $DEBUG;
	44
	45	no strict 'refs';
	46
	47	# -------------------------------------------------------------------
	48	sub parse {
	49	my ( $tr, $dbh ) = @_;
	50
	51	if ($dbh->{FetchHashKeyName} ne 'NAME_uc') {
	52	warn "setting dbh attribute {FetchHashKeyName} to NAME_uc";
	53	$dbh->{FetchHashKeyName} = 'NAME_uc';
	54	}
	55
	56	if ($dbh->{ChopBlanks} != 1) {
	57	warn "setting dbh attribute {ChopBlanks} to 1";
	58	$dbh->{ChopBlanks} = 1;
	59	}
	60
	61	my $schema = $tr->schema;
	62
	63	my ($sth, @tables, $columns);
	64	my $stuff;
	65
	66	### Columns
	67
	68	# it is much quicker to slurp back everything all at once rather
	69	# than make repeated calls
	70
	71	$sth = $dbh->column_info(undef, undef, undef, undef);
	72
	73
	74	foreach my $c (@{$sth->fetchall_arrayref({})}) {
	75	$columns
	76	->{$c->{TABLE_CAT}}
	77	->{$c->{TABLE_SCHEM}}
	78	->{$c->{TABLE_NAME}}
	79	->{columns}
	80	->{$c->{COLUMN_NAME}}= $c;
	81	}
	82
	83	### Tables and views
	84
	85	# Get a list of the tables and views.
	86	$sth = $dbh->table_info();
	87	@tables = @{$sth->fetchall_arrayref({})};
	88
	89	my $h = $dbh->selectall_arrayref(q{
	90	SELECT o.name, colid,c.text
	91	FROM syscomments c
	92	JOIN sysobjects o
	93	ON c.id = o.id
	94	WHERE o.type ='V'
	95	ORDER BY o.name,
	96	c.colid
	97	}
	98	);
	99
	100	# View text
	101	# I had always thought there was something 'hard' about
	102	# reconstructing text from syscomments ..
	103	# this seems to work fine and is certainly not complicated!
	104
	105	foreach (@{$h}) {
	106	$stuff->{view}->{$_->[0]}->{text} .= $_->[2];
107	}
108
109	#### objects with indexes.
110	map {
111	$stuff->{indexes}->{$_->[0]}++
112	if defined;
113	} @{$dbh->selectall_arrayref("SELECT DISTINCT object_name(id)
114	FROM sysindexes
d4f02954	115	WHERE indid > 0 and indid < 255 and
4eb28bc3	116	name not like '_WA_Sys%'")};
	117
	118	## slurp objects
	119	map {
	120	$stuff->{$_->[1]}->{$_->[0]} = $_;
	121	} @{$dbh->selectall_arrayref("SELECT name,type, id FROM sysobjects")};
	122
	123
	124	### Procedures
	125
	126	# This gets legitimate procedures by used the 'supported' API: sp_stored_procedures
	127	map {
	128	my $n = $_->{PROCEDURE_NAME};
	129	$n =~ s/;\d+$//; # Ignore versions for now
	130	$_->{name} = $n;
	131	$stuff->{procedures}->{$n} = $_;
	132	} values %{$dbh->selectall_hashref("sp_stored_procedures", 'PROCEDURE_NAME')};
	133
	134
	135	# And this blasts in the text of 'legit' stored procedures. Do
	136	# this rather than calling sp_helptext in a loop.
	137
	138	$h = $dbh->selectall_arrayref(q{
	139	SELECT o.name, colid,c.text
	140	FROM syscomments c
	141	JOIN sysobjects o
	142	ON c.id = o.id
8b3a5e87	143	WHERE o.type in ('P', 'FN', 'TF', 'IF')
4eb28bc3	144	}
	145	);
	146
	147	foreach (@{$h}) {
	148	$stuff->{procedures}->{$_->[0]}->{text} .= $_->[2]
	149	if (defined($stuff->{procedures}->{$_->[0]}));
	150	}
	151
	152	### Defaults
	153	### Rules
	154	### Bind Defaults
	155	### Bind Rules
	156
	157	### Triggers
	158	# Since the 'target' of the trigger is defined in the text, we will
	159	# just create them independently for now rather than associating them
	160	# with a table.
	161
	162	$h = $dbh->selectall_arrayref(q{
	163	SELECT o.name, colid,c.text
	164	FROM syscomments c
	165	JOIN sysobjects o
	166	ON c.id = o.id
	167	JOIN sysobjects o1
	168	ON (o.id = o1.instrig OR o.id = o1.deltrig or o.id = o1.updtrig)
	169	WHERE o.type ='TR'
	170	ORDER BY o.name,
	171	c.colid
	172	}
	173	);
	174	foreach (@{$h}) {
	175	$stuff->{triggers}->{$_->[0]}->{text} .= $_->[2];
	176	}
	177
	178	### References
	179	### Keys
	180
	181	### Types
	182	# Not sure what to do with these?
	183	$stuff->{type_info_all} = $dbh->type_info_all;
	184
	185	### Tables
	186	# According to the DBI docs, these can be
	187
	188	# "TABLE"
	189	# "VIEW"
	190	# "SYSTEM TABLE"
	191	# "GLOBAL TEMPORARY",
	192	# "LOCAL TEMPORARY"
	193	# "ALIAS"
	194	# "SYNONYM"
	195
	196	foreach my $table_info (@tables) {
	197	next
	198	unless (defined($table_info->{TABLE_TYPE}));
	199
	200	if ($table_info->{TABLE_TYPE} eq "TABLE") {
	201	my $table = $schema->add_table(
	202	name =>
	203	$table_info->{TABLE_NAME},
	204	type =>
	205	$table_info->{TABLE_TYPE},
	206	) \|\| die $schema->error;
	207
208	# find the associated columns
209
210	my $cols =
211	$columns->{$table_info->{TABLE_CAT}}
212	->{$table_info->{TABLE_SCHEM}}
213	->{$table_info->{TABLE_NAME}}
214	->{columns};
215
216	foreach my $c (values %{$cols}) {
217	my $is_auto_increment = $c->{TYPE_NAME} =~ s#(\(\))? identity##i;
218	my $f = $table->add_field(
219	name => $c->{COLUMN_NAME},
220	data_type => $c->{TYPE_NAME},
221	order => $c->{ORDINAL_POSITION},
222	size => $c->{COLUMN_SIZE},
223	) \|\| die $table->error;
224	$f->is_nullable($c->{NULLABLE} == 1);
225	$f->is_auto_increment($is_auto_increment);
4e0de84c	226	if ( defined $c->{COLUMN_DEF}) {
	227	$c->{COLUMN_DEF} =~ s#\('?(.*?)'?\)#$1#;
	228	$f->default_value($c->{COLUMN_DEF});
	229	}
4eb28bc3	230	}
	231
	232	# add in primary key
	233	my $h = $dbh->selectall_hashref("sp_pkeys
	234	$table_info->{TABLE_NAME}", 'COLUMN_NAME');
	235	if (scalar keys %{$h} >= 1) {
	236	my @c = map {
	237	$_->{COLUMN_NAME}
	238	} sort {
	239	$a->{KEY_SEQ} <=> $b->{KEY_SEQ}
	240	} values %{$h};
	241
	242	$table->primary_key(@c)
	243	if (scalar @c);
	244	}
	245
	246	# add in foreign keys
11b7c9a4	247	$h = $dbh->selectall_hashref("sp_fkeys NULL,
4eb28bc3	248	\@fktable_name = '$table_info->{TABLE_NAME}'", 'FK_NAME');
	249	foreach my $fk ( values %{$h} ) {
	250	my $constraint = $table->add_constraint( name => $fk->{FK_NAME},
	251	fields => [$fk->{FKCOLUMN_NAME}],
	252	);
	253	$constraint->type("FOREIGN_KEY");
	254	$constraint->on_delete(
	255	$fk->{DELETE_RULE} == 0 ? "CASCADE" :
	256	$fk->{DELETE_RULE} == 1 ? "NO ACTION" : "SET_NULL"
	257	);
	258	$constraint->on_update(
	259	$fk->{UPDATE_RULE} == 0 ? "CASCADE" :
	260	$fk->{UPDATE_RULE} == 1 ? "NO ACTION" : "SET_NULL"
	261	);
	262	$constraint->reference_table($fk->{PKTABLE_NAME});
	263	}
	264
	265	# add in any indexes ... how do we tell if the index has
	266	# already been created as part of a primary key or other
	267	# constraint?
	268
	269	if (defined($stuff->{indexes}->{$table_info->{TABLE_NAME}})){
	270	my $h = $dbh->selectall_hashref("sp_helpindex
	271	$table_info->{TABLE_NAME}", 'INDEX_NAME');
	272	foreach (values %{$h}) {
	273	my $fields = $_->{'INDEX_KEYS'};
	274	$fields =~ s/\s*//g;
	275	my $i = $table->add_index(
	276	name =>
	277	$_->{INDEX_NAME},
	278	fields => $fields,
	279	);
	280	if ($_->{'INDEX_DESCRIPTION'} =~ /unique/i) {
	281	$i->type('unique');
	282
	283	# we could make this a primary key if there
	284	# isn't already one defined and if there
	285	# aren't any nullable columns in thisindex.
	286
	287	if (!defined($table->primary_key())) {
	288	$table->primary_key($fields)
	289	unless grep {
	290	$table->get_field($_)->is_nullable()
	291	} split(/,\s*/, $fields);
	292	}
	293	}
	294	}
	295	}
	296	} elsif ($table_info->{TABLE_TYPE} eq 'VIEW') {
	297	next if $table_info->{TABLE_NAME} eq 'sysconstraints'
	298	\|\| $table_info->{TABLE_NAME} eq 'syssegments';
2d02c5e9	299	next if !$stuff->{view}->{$table_info->{TABLE_NAME}}->{text};
4eb28bc3	300	my $view = $schema->add_view(
	301	name =>
	302	$table_info->{TABLE_NAME},
	303	);
	304
	305
	306	my $cols =
	307	$columns->{$table_info->{TABLE_CAT}}
	308	->{$table_info->{TABLE_SCHEM}}
	309	->{$table_info->{TABLE_NAME}}
	310	->{columns};
	311
	312	$view->fields(map {
	313	$_->{COLUMN_NAME}
	314	} sort {
	315	$a->{ORDINAL_POSITION} <=> $b->{ORDINAL_POSITION}
	316	} values %{$cols}
	317	);
	318
	319	$view->sql($stuff->{view}->{$table_info->{TABLE_NAME}}->{text})
	320	if (defined($stuff->{view}->{$table_info->{TABLE_NAME}}->{text}));
	321	}
	322	}
	323
	324	foreach my $p (values %{$stuff->{procedures}}) {
2d02c5e9	325	next if !$p->{text};
4eb28bc3	326	my $proc = $schema->add_procedure(
	327	name => $p->{name},
	328	owner => $p->{PROCEDURE_OWNER},
	329	comments => $p->{REMARKS},
	330	sql => $p->{text},
	331	);
	332
	333	}
	334
	335	### Permissions
	336	### Groups
	337	### Users
	338	### Aliases
	339	### Logins
	340	return 1;
	341	}
	342
	343	1;
	344
	345	# -------------------------------------------------------------------
	346
	347	=pod
	348
	349	=head1 AUTHOR
	350
	351	Chris Hilton E<lt>chris@dctank.comE<gt> - Bulk of code from
	352	DBI-Sybase parser, I just tweaked it for SQLServer. Thanks.
	353
	354	=head1 SEE ALSO
	355
	356	DBI, DBD::ODBC, SQL::Translator::Schema.
	357
	358	=cut