fix MSSQL collation detection on freetds tds version 8.0

[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / MSSQL.pm

diff --git a/lib/DBIx/Class/Schema/Loader/DBI/MSSQL.pm b/lib/DBIx/Class/Schema/Loader/DBI/MSSQL.pm
index 1023ebd..7a019d9 100644 (file)
--- a/lib/DBIx/Class/Schema/Loader/DBI/MSSQL.pm
+++ b/lib/DBIx/Class/Schema/Loader/DBI/MSSQL.pm
@@ -6,7 +6,11 @@ use base 'DBIx::Class::Schema::Loader::DBI::Sybase::Common';
 use Carp::Clan qw/^DBIx::Class/;
 use Class::C3;
 
-our $VERSION = '0.05003';
+__PACKAGE__->mk_group_accessors('simple', qw/
+    case_sensitive_collation
+/);
+
+our $VERSION = '0.06000';
 
 =head1 NAME
 
@@ -23,15 +27,79 @@ L<DBD::ODBC>.
 See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base> for
 usage information.
 
+=head1 CASE SENSITIVITY
+
+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 set or unset case-sensitive mode, put:
+
+    case_sensitive_collation => 1
+
+in your Loader options.
+
 =cut
 
+sub _is_case_sensitive {
+    my $self = shift;
+
+    return $self->case_sensitive_collation ? 1 : 0;
+}
+
+sub _setup {
+    my $self = shift;
+
+    $self->next::method;
+
+    return if defined $self->case_sensitive_collation;
+
+    my $dbh = $self->schema->storage->dbh;
+
+    # 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 'case_sensitive_collation' attribute in your Loader options if
+needed.
+EOF
+        $self->case_sensitive_collation(0);
+        return;
+    }
+
+    my $case_sensitive = $collation_name =~ /_(?:CS|BIN2?)(?:_|\z)/;
+
+    $self->case_sensitive_collation($case_sensitive ? 1 : 0);
+}
+
+sub _lc {
+    my ($self, $name) = @_;
+
+    return $self->case_sensitive_collation ? $name : lc($name);
+}
+
 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
+FROM INFORMATION_SCHEMA.TABLES t
 WHERE lower(t.table_schema) = ?
 EOF
     $sth->execute(lc $self->db_schema);
@@ -50,7 +118,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;
@@ -59,15 +127,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};
     }
 
@@ -90,16 +160,16 @@ sub _table_uniq_info {
 
     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)
+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 lower(ccu.table_name) = @{[ $dbh->quote(lc $table) ]} AND constraint_type = 'UNIQUE' ORDER BY kcu.ordinal_position
     });
     $sth->execute;
     my $constraints;
     while (my $row = $sth->fetchrow_hashref) {
         my $name = $row->{constraint_name};
-        my $col  = lc $row->{column_name};
+        my $col  = $self->_lc($row->{column_name});
         push @{$constraints->{$name}}, $col;
     }
 
@@ -118,7 +188,7 @@ sub _columns_info_for {
 
         my $sth = $dbh->prepare(qq{
 SELECT column_name 
-FROM information_schema.columns
+FROM INFORMATION_SCHEMA.COLUMNS
 WHERE columnproperty(object_id(@{[ $dbh->quote(lc $table) ]}, 'U'), @{[ $dbh->quote(lc $col) ]}, 'IsIdentity') = 1
 AND lower(table_name) = @{[ $dbh->quote(lc $table) ]} AND lower(column_name) = @{[ $dbh->quote(lc $col) ]}
         });
@@ -131,7 +201,7 @@ AND lower(table_name) = @{[ $dbh->quote(lc $table) ]} AND lower(column_name) = @
 # get default
         $sth = $dbh->prepare(qq{
 SELECT column_default
-FROM information_schema.columns
+FROM INFORMATION_SCHEMA.COLUMNS
 wHERE lower(table_name) = @{[ $dbh->quote(lc $table) ]} AND lower(column_name) = @{[ $dbh->quote(lc $col) ]}
         });
         my ($default) = eval { $sth->execute; $sth->fetchrow_array };