WIP

Author: Zurga

integration_test/myxql/migrations_test.exs

@@ -29,21 +29,31 @@ defmodule Ecto.Integration.MigrationsTest do
     end
   end
 
-  text_types =  ~w/tinytext text mediumtext longtext/a
-  @text_types text_types
+  text_variants = ~w/tinytext text mediumtext longtext/a
+  @text_variants text_variants
+
+  collation = "utf8mb4_bin"
+  @collation collation
 
   defmodule CollateMigration do
     use Ecto.Migration
 
-    @text_types text_types
+    @text_variants text_variants
     def change do
+      create table(:collate_reference) do
+        add :name, :string, collation: @collation
+      end
+
+      create unique_index(:collate_reference, :name)
+
       create table(:collate) do
-        add :string, :string, collation: "utf8mb4_bin"
-        add :varchar, :varchar, size: 255, collation: "utf8mb4_bin"
-        add :integer, :integer, collation: "utf8mb4_bin"
+        add :string, :string, collation: @collation
+        add :varchar, :varchar, size: 255, collation: @collation
+        add :integer, :integer, collation: @collation
+        add :name_string, references(:collate_reference, type: :string, column: :name), collation: @collation
 
-        for type <- @text_types do
-          add type, type, collation: "utf8mb4_bin"
+        for type <- @text_variants do
+          add type, type, collation: @collation
         end
       end
 
@@ -150,7 +160,7 @@ defmodule Ecto.Integration.MigrationsTest do
         rows: [["utf8mb4_bin"]]
       } = Ecto.Adapters.SQL.query!(PoolRepo, query.("text"), [])
 
-      for type <- @text_types do
+      for type <- @text_variants do
         assert %{
           rows: [["utf8mb4_bin"]]
         } = Ecto.Adapters.SQL.query!(PoolRepo, query.(to_string(type)), [])

integration_test/pg/migrations_test.exs

@@ -40,16 +40,33 @@ defmodule Ecto.Integration.MigrationsTest do
     end
   end
 
+  collation = "POSIX"
+  @collation collation
+
+  text_types = ~w/char varchar text/a
+  @text_types text_types
+
   defmodule CollateMigration do
     use Ecto.Migration
 
+    @collation collation
+    @text_types text_types
+
     def change do
+      create table(:collate_reference) do
+        add :name, :string, primary_key: true, collation: @collation
+      end
+      create unique_index(:collate_reference, :name)
+
       create table(:collate) do
-        add :string, :string, collation: "POSIX"
-        add :char, :char, collation: "POSIX"
-        add :varchar, :varchar, collation: "POSIX"
-        add :text, :text, collation: "POSIX"
-        add :integer, :integer, collation: "POSIX"
+        add :string, :string, collation: @collation
+
+        for type <- @text_types do
+          add type, type, collation: @collation
+        end
+
+        add :integer, :integer, collation: @collation
+        add :name_string, references(:collate_reference, type: :string, column: :name),  collation: @collation
       end
 
       alter table(:collate) do
@@ -178,18 +195,12 @@ defmodule Ecto.Integration.MigrationsTest do
         rows: [["C"]]
       } = Ecto.Adapters.SQL.query!(PoolRepo, query.("string"), [])
 
-      assert %{
-        rows: [["POSIX"]]
-      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("varchar"), [])
-
-      assert %{
-        rows: [["POSIX"]]
-      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("char"), [])
-
-      assert %{
-        rows: [["POSIX"]]
-      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("text"), [])
-      
+      for type <- @text_types do
+        assert %{
+          rows: [[@collation]]
+        } = Ecto.Adapters.SQL.query!(PoolRepo, query.(type), [])
+      end
+     
       assert %{
         rows: [[nil]]
       } = Ecto.Adapters.SQL.query!(PoolRepo, query.("integer"), [])

integration_test/tds/migrations_test.exs

@@ -15,6 +15,38 @@ defmodule Ecto.Integration.MigrationsTest do
     end
   end
 
+  collation = "Latin1_General_CS_AS"
+  @collation collation
+
+  defmodule CollateMigration do
+    use Ecto.Migration
+    @collation collation
+
+    def change do
+      create table(:collate_reference) do
+        add :name, :string, collation: @collation
+      end
+
+      create unique_index(:collate_reference, :name)
+
+      create table(:collate) do
+        add :string, :string, collation: @collation
+        add :char, :char, size: 255, collation: @collation
+        add :nchar, :nchar, size: 255, collation: @collation
+        add :varchar, :varchar, size: 255, collation: @collation
+        add :nvarchar, :nvarchar, size: 255, collation: @collation
+        add :text, :text,  collation: @collation
+        add :ntext, :ntext, collation: @collation
+        add :integer, :integer, collation: @collation
+        add :name_string, references(:collate_reference, type: :string, column: :name), collation: @collation
+      end
+
+      alter table(:collate) do
+        modify :string, :string, collation: "Japanese_Bushu_Kakusu_100_CS_AS_KS_WS"
+      end
+    end
+  end
+
   describe "Migrator" do
     @get_lock_command ~s(sp_getapplock @Resource = 'ecto_Ecto.Integration.PoolRepo', @LockMode = 'Exclusive', @LockOwner = 'Transaction', @LockTimeout = -1)
     @create_table_sql ~s(CREATE TABLE [log_mode_table])
@@ -77,5 +109,50 @@ defmodule Ecto.Integration.MigrationsTest do
       refute down_log =~ @version_delete
       refute down_log =~ "commit []"
     end
+
+    test "collation can be set on a column" do
+      num = @base_migration + System.unique_integer([:positive])
+      up_log = capture_log(fn ->
+       Ecto.Migrator.up(PoolRepo, num, CollateMigration, log: :info)
+      end)
+      IO.puts(up_log)
+      query = fn column -> """
+        SELECT collation_name
+        FROM information_schema.columns
+        WHERE table_name = 'collate' AND column_name = '#{column}';
+      """
+      end
+
+      assert %{
+        rows: [["Japanese_Bushu_Kakusu_100_CS_AS_KS_WS"]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("string"), [])
+
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("char"), [])
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("varchar"), [])
+
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("nchar"), [])
+
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("nvarchar"), [])
+
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("text"), [])
+
+      assert %{
+        rows: [[@collation]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("ntext"), [])
+      
+      assert %{
+        rows: [[nil]]
+      } = Ecto.Adapters.SQL.query!(PoolRepo, query.("integer"), [])
+    end
   end
 end

lib/ecto/adapters/myxql/connection.ex

@@ -1274,7 +1274,7 @@ if Code.ensure_loaded?(MyXQL) do
 
       [
         default_expr(default),
-        collation(collation, type),
+        collation_expr(collation, type),
         null_expr(null),
         comment_expr(comment),
         after_expr(after_column)
@@ -1299,12 +1299,12 @@ if Code.ensure_loaded?(MyXQL) do
     defp null_expr(true), do: " NULL"
     defp null_expr(_), do: []
 
-    defp collation({:ok, collation_name}, text_type)
+    defp collation_expr({:ok, collation_name}, text_type)
          when text_type in ~w/string char varchar text tinytext mediumtext longtext/a do
       " COLLATE \"#{collation_name}\""
     end
 
-    defp collation(_, _), do: []
+    defp collation_expr(_, _), do: []
 
     defp new_constraint_expr(%Constraint{check: check} = constraint) when is_binary(check) do
       [

lib/ecto/adapters/postgres/connection.ex

@@ -1567,7 +1567,7 @@ if Code.ensure_loaded?(Postgrex) do
         reference_expr(ref, table, name),
         modify_null(name, opts),
         modify_default(name, ref.type, opts),
-        collation(collation, ref.type)
+        collation_expr(collation, ref.type)
       ]
     end
 
@@ -1582,7 +1582,7 @@ if Code.ensure_loaded?(Postgrex) do
         column_type(type, opts),
         modify_null(name, opts),
         modify_default(name, type, opts),
-        collation(collation, type)
+        collation_expr(collation, type)
       ]
     end
 
@@ -1632,19 +1632,19 @@ if Code.ensure_loaded?(Postgrex) do
       null = Keyword.get(opts, :null)
       collation = Keyword.fetch(opts, :collation)
 
-      [default_expr(default, type), null_expr(null), collation(collation, type)]
+      [default_expr(default, type), null_expr(null), collation_expr(collation, type)]
     end
 
     defp null_expr(false), do: " NOT NULL"
     defp null_expr(true), do: " NULL"
     defp null_expr(_), do: []
 
-    defp collation({:ok, collation_name}, text_type)
+    defp collation_expr({:ok, collation_name}, text_type)
          when text_type in ~w/string text char varchar/a do
       " COLLATE \"#{collation_name}\""
     end
 
-    defp collation(_, _), do: []
+    defp collation_expr(_, _), do: []
 
     defp new_constraint_expr(%Constraint{check: check} = constraint) when is_binary(check) do
       [

lib/ecto/adapters/tds/connection.ex

@@ -1369,13 +1369,13 @@ if Code.ensure_loaded?(Tds) do
         quote_name(name),
         " ",
         reference_column_type(ref.type, opts),
-        column_options(table, name, opts),
+        column_options(table, name, ref.type, opts),
         reference_expr(ref, table, name)
       ]
     end
 
     defp column_definition(table, {:add, name, type, opts}) do
-      [quote_name(name), " ", column_type(type, opts), column_options(table, name, opts)]
+      [quote_name(name), " ", column_type(type, opts), column_options(table, name, type, opts)]
     end
 
     defp column_changes(statement, table, columns) do
@@ -1396,7 +1396,7 @@ if Code.ensure_loaded?(Tds) do
           quote_name(name),
           " ",
           reference_column_type(ref.type, opts),
-          column_options(table, name, opts),
+          column_options(table, name, ref.type, opts),
           "; "
         ],
         [statement_prefix, "ADD", constraint_expr(ref, table, name), "; "]
@@ -1411,7 +1411,7 @@ if Code.ensure_loaded?(Tds) do
           quote_name(name),
           " ",
           column_type(type, opts),
-          column_options(table, name, opts),
+          column_options(table, name, type, opts),
           "; "
         ]
       ]
@@ -1430,7 +1430,7 @@ if Code.ensure_loaded?(Tds) do
           quote_name(column_name),
           " ",
           column_type(type, opts),
-          column_options(table, column_name, opts),
+          column_options(table, column_name, type, opts),
           "; "
         ]
       ]
@@ -1446,7 +1446,7 @@ if Code.ensure_loaded?(Tds) do
           quote_name(name),
           " ",
           reference_column_type(ref.type, opts),
-          column_options(table, name, opts),
+          column_options(table, name, ref.type, opts),
           "; "
         ],
         [statement_prefix, "ADD", constraint_expr(ref, table, name), "; "],
@@ -1455,6 +1455,8 @@ if Code.ensure_loaded?(Tds) do
     end
 
     defp column_change(statement_prefix, table, {:modify, name, type, opts}) do
+      collation = Keyword.fetch(opts, :collation)
+
       [
         drop_constraint_from_expr(opts[:from], table, name, statement_prefix),
         maybe_drop_default_expr(statement_prefix, table, name, opts),
@@ -1465,6 +1467,7 @@ if Code.ensure_loaded?(Tds) do
           " ",
           column_type(type, opts),
           null_expr(Keyword.get(opts, :null)),
+          collation_expr(collation, type),
           "; "
         ],
         [column_default_value(statement_prefix, table, name, opts)]
@@ -1497,10 +1500,14 @@ if Code.ensure_loaded?(Tds) do
       ]
     end
 
-    defp column_options(table, name, opts) do
+    defp column_options(table, name, type, opts) do
       default = Keyword.fetch(opts, :default)
       null = Keyword.get(opts, :null)
-      [null_expr(null), default_expr(table, name, default)]
+
+      collation =
+        Keyword.fetch(opts, :collation)
+
+      [null_expr(null), default_expr(table, name, default), collation_expr(collation, type)]
     end
 
     defp column_default_value(statement_prefix, table, name, opts) do
@@ -1516,6 +1523,13 @@ if Code.ensure_loaded?(Tds) do
     defp null_expr(true), do: [" NULL"]
     defp null_expr(_), do: []
 
+    defp collation_expr({:ok, collation_name}, text_type)
+         when text_type in ~w/string char varchar nchar nvarchar text ntext/a do
+      " COLLATE #{collation_name}"
+    end
+
+    defp collation_expr(_, _), do: []
+
     defp default_expr(_table, _name, {:ok, nil}),
       do: []
 

lib/ecto/migration.ex

@@ -282,12 +282,19 @@ defmodule Ecto.Migration do
   are not known by `ecto_sql` and specifying an incorrect collation might cause
   a migration to fail.
 
+  ### N.B. be sure to match the collation on any columns that reference other text columns. See example below
+
       def change do
+        create table(:collate_reference) do
+          add :name, :string, collation: "POSIX"
+        end
+
         create table(:collate) do
           add :string, :string, collation: "POSIX"
+          add :name_ref, references(:collate_reference, type: :string, column: :name), collation: "POSIX"
         end
       end
-  
+
   ## Comments
 
   Migrations where you create or alter a table support specifying table