release 0.07010
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / MSSQL.pm
index 7792ba2..c657349 100644 (file)
@@ -2,31 +2,49 @@ package DBIx::Class::Schema::Loader::DBI::MSSQL;
 
 use strict;
 use warnings;
-use base qw/
-    DBIx::Class::Schema::Loader::DBI
-    DBIx::Class::Schema::Loader::DBI::Sybase::Common
-/;
+use base 'DBIx::Class::Schema::Loader::DBI::Sybase::Common';
+use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
-use Class::C3;
+use Try::Tiny;
+use namespace::clean;
 
-our $VERSION = '0.04999_12';
+our $VERSION = '0.07010';
 
 =head1 NAME
 
 DBIx::Class::Schema::Loader::DBI::MSSQL - DBIx::Class::Schema::Loader::DBI MSSQL Implementation.
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-  package My::Schema;
-  use base qw/DBIx::Class::Schema::Loader/;
+Base driver for Microsoft SQL Server, used by
+L<DBIx::Class::Schema::Loader::DBI::Sybase::Microsoft_SQL_Server> for support
+via L<DBD::Sybase> and
+L<DBIx::Class::Schema::Loader::DBI::ODBC::Microsoft_SQL_Server> for support via
+L<DBD::ODBC>.
 
-  __PACKAGE__->loader_options( debug => 1 );
+See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base> for
+usage information.
 
-  1;
+=head1 CASE SENSITIVITY
 
-=head1 DESCRIPTION
+Most MSSQL databases use C<CI> (case-insensitive) collation, for this reason
+generated column names are lower-cased as this makes them easier to work with
+in L<DBIx::Class>.
+
+We attempt to detect the database collation at startup, and set the column
+lowercasing behavior accordingly, as lower-cased column names do not work on
+case-sensitive databases.
+
+To manually control case-sensitive mode, put:
+
+    preserve_case => 1|0
 
-See L<DBIx::Class::Schema::Loader::Base>.
+in your Loader options.
+
+See L<preserve_case|DBIx::Class::Schema::Loader::Base/preserve_case>.
+
+B<NOTE:> this option used to be called C<case_sensitive_collation>, but has
+been renamed to a more generic option.
 
 =cut
 
@@ -34,20 +52,54 @@ sub _setup {
     my $self = shift;
 
     $self->next::method(@_);
-    $self->{db_schema} ||= $self->_build_db_schema;
-    $self->_set_quote_char_and_name_sep;
-}
 
-# remove 'IDENTITY' from column data_type
-sub _columns_info_for {
-    my $self   = shift;
-    my $result = $self->next::method(@_);
+    return if defined $self->preserve_case;
+
+    my $dbh = $self->schema->storage->dbh;
 
-    for my $col (keys %$result) {
-        $result->{$col}->{data_type} =~ s/\s* identity \s*//ix;
+    # We use the sys.databases query for the general case, and fallback to
+    # databasepropertyex() if for some reason sys.databases is not available,
+    # which does not work over DBD::ODBC with unixODBC+FreeTDS.
+    #
+    # XXX why does databasepropertyex() not work over DBD::ODBC ?
+    #
+    # more on collations here: http://msdn.microsoft.com/en-us/library/ms143515.aspx
+    my ($collation_name) =
+           eval { $dbh->selectrow_array('SELECT collation_name FROM sys.databases WHERE name = DB_NAME()') }
+        || eval { $dbh->selectrow_array("SELECT CAST(databasepropertyex(DB_NAME(), 'Collation') AS VARCHAR)") };
+
+    if (not $collation_name) {
+        warn <<'EOF';
+
+WARNING: MSSQL Collation detection failed. Defaulting to case-insensitive mode.
+Override the 'preserve_case' attribute in your Loader options if needed.
+
+See 'preserve_case' in
+perldoc DBIx::Class::Schema::Loader::Base
+EOF
+        $self->preserve_case(0);
+        return;
     }
 
-    return $result;
+    my $case_sensitive = $collation_name =~ /_(?:CS|BIN2?)(?:_|\z)/;
+
+    $self->preserve_case($case_sensitive ? 1 : 0);
+}
+
+sub _tables_list {
+    my ($self, $opts) = @_;
+
+    my $dbh = $self->schema->storage->dbh;
+    my $sth = $dbh->prepare(<<'EOF');
+SELECT t.table_name
+FROM INFORMATION_SCHEMA.TABLES t
+WHERE t.table_schema = ?
+EOF
+    $sth->execute($self->db_schema);
+
+    my @tables = map @$_, @{ $sth->fetchall_arrayref };
+
+    return $self->_filter_tables(\@tables, $opts);
 }
 
 sub _table_pk_info {
@@ -59,7 +111,7 @@ sub _table_pk_info {
     my @keydata;
 
     while (my $row = $sth->fetchrow_hashref) {
-        push @keydata, lc $row->{COLUMN_NAME};
+        push @keydata, $self->_lc($row->{COLUMN_NAME});
     }
 
     return \@keydata;
@@ -68,15 +120,17 @@ sub _table_pk_info {
 sub _table_fk_info {
     my ($self, $table) = @_;
 
-    my ($local_cols, $remote_cols, $remote_table, @rels);
+    my ($local_cols, $remote_cols, $remote_table, @rels, $sth);
     my $dbh = $self->schema->storage->dbh;
-    my $sth = $dbh->prepare(qq{sp_fkeys \@FKTABLE_NAME = '$table'});
-    $sth->execute;
+    eval {
+        $sth = $dbh->prepare(qq{sp_fkeys \@fktable_name = '$table'});
+        $sth->execute;
+    };
 
-    while (my $row = $sth->fetchrow_hashref) {
+    while (my $row = eval { $sth->fetchrow_hashref }) {
         my $fk = $row->{FK_NAME};
-        push @{$local_cols->{$fk}}, lc $row->{FKCOLUMN_NAME};
-        push @{$remote_cols->{$fk}}, lc $row->{PKCOLUMN_NAME};
+        push @{$local_cols->{$fk}}, $self->_lc($row->{FKCOLUMN_NAME});
+        push @{$remote_cols->{$fk}}, $self->_lc($row->{PKCOLUMN_NAME});
         $remote_table->{$fk} = $row->{PKTABLE_NAME};
     }
 
@@ -95,15 +149,20 @@ sub _table_uniq_info {
     my ($self, $table) = @_;
 
     my $dbh = $self->schema->storage->dbh;
-    my $sth = $dbh->prepare(qq{SELECT CCU.CONSTRAINT_NAME, CCU.COLUMN_NAME FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE CCU
-                               JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS TC ON (CCU.CONSTRAINT_NAME = TC.CONSTRAINT_NAME)
-                               JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE KCU ON (CCU.CONSTRAINT_NAME = KCU.CONSTRAINT_NAME AND CCU.COLUMN_NAME = KCU.COLUMN_NAME)
-                               WHERE CCU.TABLE_NAME = @{[ $dbh->quote($table) ]} AND CONSTRAINT_TYPE = 'UNIQUE' ORDER BY KCU.ORDINAL_POSITION});
+    local $dbh->{FetchHashKeyName} = 'NAME_lc';
+
+    my $sth = $dbh->prepare(qq{
+SELECT ccu.constraint_name, ccu.column_name
+FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE ccu
+JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS tc on (ccu.constraint_name = tc.constraint_name)
+JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE kcu on (ccu.constraint_name = kcu.constraint_name and ccu.column_name = kcu.column_name)
+wHERE ccu.table_name = @{[ $dbh->quote($table) ]} AND constraint_type = 'UNIQUE' ORDER BY kcu.ordinal_position
+    });
     $sth->execute;
     my $constraints;
     while (my $row = $sth->fetchrow_hashref) {
-        my $name = lc $row->{CONSTRAINT_NAME};
-        my $col  = lc $row->{COLUMN_NAME};
+        my $name = $row->{constraint_name};
+        my $col  = $self->_lc($row->{column_name});
         push @{$constraints->{$name}}, $col;
     }
 
@@ -111,56 +170,128 @@ sub _table_uniq_info {
     return \@uniqs;
 }
 
-sub _extra_column_info {
-    my ($self, $info) = @_;
-    my %extra_info;
+sub _columns_info_for {
+    my $self    = shift;
+    my ($table) = @_;
 
-    my ($table, $column) = @$info{qw/TABLE_NAME COLUMN_NAME/};
+    my $result = $self->next::method(@_);
 
     my $dbh = $self->schema->storage->dbh;
-    my $sth = $dbh->prepare(qq{
-        SELECT COLUMN_NAME 
-        FROM INFORMATION_SCHEMA.COLUMNS
-        WHERE COLUMNPROPERTY(object_id(@{[ $dbh->quote($table) ]}, 'U'), '$column', 'IsIdentity') = 1
-          AND TABLE_NAME = @{[ $dbh->quote($table) ]} AND COLUMN_NAME = @{[ $dbh->quote($column) ]}
-    });
-    $sth->execute();
 
-    if ($sth->fetchrow_array) {
-        $extra_info{is_auto_increment} = 1;
-    }
+    while (my ($col, $info) = each %$result) {
+# get type info
+        my $sth = $dbh->prepare(qq{
+SELECT character_maximum_length, data_type, datetime_precision
+FROM INFORMATION_SCHEMA.COLUMNS
+WHERE table_name = @{[ $dbh->quote($table) ]} AND column_name = @{[ $dbh->quote($col) ]}
+        });
+        $sth->execute;
+        my ($char_max_length, $data_type, $datetime_precision) = $sth->fetchrow_array;
+
+        $info->{data_type} = $data_type;
+
+        if (defined $char_max_length) {
+            $info->{size} = $char_max_length;
+            $info->{size} = 0 if $char_max_length < 0;
+        }
+
+# find identities
+        $sth = $dbh->prepare(qq{
+SELECT column_name 
+FROM INFORMATION_SCHEMA.COLUMNS
+WHERE columnproperty(object_id(@{[ $dbh->quote($table) ]}, 'U'), @{[ $dbh->quote($col) ]}, 'IsIdentity') = 1
+AND table_name = @{[ $dbh->quote($table) ]} AND column_name = @{[ $dbh->quote($col) ]}
+        });
+        if (try { $sth->execute; $sth->fetchrow_array }) {
+            $info->{is_auto_increment} = 1;
+            $info->{data_type} =~ s/\s*identity//i;
+            delete $info->{size};
+        }
+
+# fix types
+        if ($data_type eq 'int') {
+            $info->{data_type} = 'integer';
+        }
+        elsif ($data_type eq 'timestamp') {
+            $info->{inflate_datetime} = 0;
+        }
+        elsif ($data_type =~ /^(?:numeric|decimal)\z/) {
+            if (ref($info->{size}) && $info->{size}[0] == 18 && $info->{size}[1] == 0) {
+                delete $info->{size};
+            }
+        }
+        elsif ($data_type eq 'float') {
+            $info->{data_type} = 'double precision';
+            delete $info->{size};
+        }
+        elsif ($data_type =~ /^(?:small)?datetime\z/) {
+            # fixup for DBD::Sybase
+            if ($info->{default_value} && $info->{default_value} eq '3') {
+                delete $info->{default_value};
+            }
+        }
+        elsif ($data_type =~ /^(?:datetime(?:2|offset)|time)\z/) {
+            $info->{size} = $datetime_precision;
+
+            delete $info->{size} if $info->{size} == 7;
+        }
+        elsif ($data_type eq 'varchar'   && $info->{size} == 0) {
+            $info->{data_type} = 'text';
+            delete $info->{size};
+        }
+        elsif ($data_type eq 'nvarchar'  && $info->{size} == 0) {
+            $info->{data_type} = 'ntext';
+            delete $info->{size};
+        }
+        elsif ($data_type eq 'varbinary' && $info->{size} == 0) {
+            $info->{data_type} = 'image';
+            delete $info->{size};
+        }
+
+        if ($data_type !~ /^(?:n?char|n?varchar|binary|varbinary|numeric|decimal|float|datetime(?:2|offset)|time)\z/) {
+            delete $info->{size};
+        }
 
 # get default
-    $sth = $dbh->prepare(qq{
-        SELECT COLUMN_DEFAULT
-        FROM INFORMATION_SCHEMA.COLUMNS
-        WHERE TABLE_NAME = @{[ $dbh->quote($table) ]} AND COLUMN_NAME = @{[ $dbh->quote($column) ]}
-    });
-    $sth->execute;
-    my ($default) = $sth->fetchrow_array;
-
-    if (defined $default) {
-        # strip parens
-        $default =~ s/^\( (.*) \)\z/$1/x;
-
-        # Literal strings are in ''s, numbers are in ()s (in some versions of
-        # MSSQL, in others they are unquoted) everything else is a function.
-        $extra_info{default_value} =
-            $default =~ /^['(] (.*) [)']\z/x ? $1 :
-                $default =~ /^\d/ ? $default : \$default;
+        $sth = $dbh->prepare(qq{
+SELECT column_default
+FROM INFORMATION_SCHEMA.COLUMNS
+wHERE table_name = @{[ $dbh->quote($table) ]} AND column_name = @{[ $dbh->quote($col) ]}
+        });
+        my ($default) = eval { $sth->execute; $sth->fetchrow_array };
+
+        if (defined $default) {
+            # strip parens
+            $default =~ s/^\( (.*) \)\z/$1/x;
+
+            # Literal strings are in ''s, numbers are in ()s (in some versions of
+            # MSSQL, in others they are unquoted) everything else is a function.
+            $info->{default_value} =
+                $default =~ /^['(] (.*) [)']\z/x ? $1 :
+                    $default =~ /^\d/ ? $default : \$default;
+
+            if ((eval { lc ${ $info->{default_value} } }||'') eq 'getdate()') {
+                ${ $info->{default_value} } = 'current_timestamp';
+
+                my $getdate = 'getdate()';
+                $info->{original}{default_value} = \$getdate;
+            }
+        }
     }
 
-    return \%extra_info;
+    return $result;
 }
 
 =head1 SEE ALSO
 
+L<DBIx::Class::Schema::Loader::DBI::Sybase::Microsoft_SQL_Server>,
+L<DBIx::Class::Schema::Loader::DBI::ODBC::Microsoft_SQL_Server>,
 L<DBIx::Class::Schema::Loader>, L<DBIx::Class::Schema::Loader::Base>,
 L<DBIx::Class::Schema::Loader::DBI>
 
 =head1 AUTHOR
 
-See L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
 
 =head1 LICENSE
 
@@ -170,3 +301,4 @@ the same terms as Perl itself.
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: