Fixed rendering of index expressions in MySQL

Fixed Python-side autogenerate rendering of index expressions in MySQL
dialect by aligning it with SQLAlchemy's MySQL index expression rules. Pull
request courtesy david-fed.

Fixes: #1492
Closes: #1695
Pull-request: https://github.com/sqlalchemy/alembic/pull/1695
Pull-request-sha: 8f9ed8f3189d2d99d9bea03cbaaabb937af40bba

Change-Id: I3b838b4b7a44e3d5a279ba30624c1552f99959d7

diff --git a/alembic/ddl/mysql.py b/alembic/ddl/mysql.py
index 3f8c0628e557ef244b06c5350ba23083c4af185d..8f5f9252663d967bfb29b5764dc63634f3f97a7e 100644 (file)
--- a/alembic/ddl/mysql.py
+++ b/alembic/ddl/mysql.py
@@ -11,6 +11,9 @@ from typing import Union
 
 from sqlalchemy import schema
 from sqlalchemy import types as sqltypes
 
 from sqlalchemy import schema
 from sqlalchemy import types as sqltypes

+from sqlalchemy.sql import elements
+from sqlalchemy.sql import functions
+from sqlalchemy.sql import operators

 
 from .base import alter_table
 from .base import AlterColumn
 
 from .base import alter_table
 from .base import AlterColumn


@@ -31,6 +34,7 @@ if TYPE_CHECKING:
 
     from sqlalchemy.dialects.mysql.base import MySQLDDLCompiler
     from sqlalchemy.sql.ddl import DropConstraint
 
     from sqlalchemy.dialects.mysql.base import MySQLDDLCompiler
     from sqlalchemy.sql.ddl import DropConstraint

+    from sqlalchemy.sql.elements import ClauseElement

     from sqlalchemy.sql.schema import Constraint
     from sqlalchemy.sql.type_api import TypeEngine
 
     from sqlalchemy.sql.schema import Constraint
     from sqlalchemy.sql.type_api import TypeEngine
 


@@ -47,6 +51,31 @@ class MySQLImpl(DefaultImpl):
     )
     type_arg_extract = [r"character set ([\w\-_]+)", r"collate ([\w\-_]+)"]
 
     )
     type_arg_extract = [r"character set ([\w\-_]+)", r"collate ([\w\-_]+)"]
 

+    def render_ddl_sql_expr(
+        self,
+        expr: ClauseElement,
+        is_server_default: bool = False,
+        is_index: bool = False,
+        **kw: Any,
+    ) -> str:
+        # apply Grouping to index expressions;
+        # see https://github.com/sqlalchemy/sqlalchemy/blob/
+        # 36da2eaf3e23269f2cf28420ae73674beafd0661/
+        # lib/sqlalchemy/dialects/mysql/base.py#L2191
+        if is_index and (
+            isinstance(expr, elements.BinaryExpression)
+            or (
+                isinstance(expr, elements.UnaryExpression)
+                and expr.modifier not in (operators.desc_op, operators.asc_op)
+            )
+            or isinstance(expr, functions.FunctionElement)
+        ):
+            expr = elements.Grouping(expr)
+
+        return super().render_ddl_sql_expr(
+            expr, is_server_default=is_server_default, is_index=is_index, **kw
+        )
+

     def alter_column(
         self,
         table_name: str,
     def alter_column(
         self,
         table_name: str,

diff --git a/docs/build/unreleased/1492.rst b/docs/build/unreleased/1492.rst
new file mode 100644 (file)
index 0000000..e963bd1
--- /dev/null
+++ b/docs/build/unreleased/1492.rst
@@ -0,0 +1,7 @@
+.. change::
+    :tags: bug, mysql
+    :tickets: 1492
+
+    Fixed Python-side autogenerate rendering of index expressions in MySQL
+    dialect by aligning it with SQLAlchemy's MySQL index expression rules. Pull
+    request courtesy david-fed.
\ No newline at end of file

diff --git a/tests/test_mysql.py b/tests/test_mysql.py
index e155077f486dfb7f21a86b22cce6bb0422cc658c..c15b70e3b69b6d293b23763f0d54470bc1ac4a10 100644 (file)
--- a/tests/test_mysql.py
+++ b/tests/test_mysql.py
@@ -6,6 +6,7 @@ from sqlalchemy import exc
 from sqlalchemy import Float
 from sqlalchemy import func
 from sqlalchemy import Identity
 from sqlalchemy import Float
 from sqlalchemy import func
 from sqlalchemy import Identity

+from sqlalchemy import Index

 from sqlalchemy import inspect
 from sqlalchemy import Integer
 from sqlalchemy import MetaData
 from sqlalchemy import inspect
 from sqlalchemy import Integer
 from sqlalchemy import MetaData


@@ -15,6 +16,7 @@ from sqlalchemy import text
 from sqlalchemy import TIMESTAMP
 from sqlalchemy.dialects.mysql import VARCHAR
 
 from sqlalchemy import TIMESTAMP
 from sqlalchemy.dialects.mysql import VARCHAR
 

+from alembic import autogenerate

 from alembic import op
 from alembic import util
 from alembic.autogenerate import api
 from alembic import op
 from alembic import util
 from alembic.autogenerate import api


@@ -24,6 +26,7 @@ from alembic.operations import ops
 from alembic.testing import assert_raises_message
 from alembic.testing import combinations
 from alembic.testing import config
 from alembic.testing import assert_raises_message
 from alembic.testing import combinations
 from alembic.testing import config

+from alembic.testing import eq_ignore_whitespace

 from alembic.testing.env import clear_staging_env
 from alembic.testing.env import staging_env
 from alembic.testing.fixtures import AlterColRoundTripFixture
 from alembic.testing.env import clear_staging_env
 from alembic.testing.env import staging_env
 from alembic.testing.fixtures import AlterColRoundTripFixture


@@ -692,3 +695,79 @@ class MySQLDefaultCompareTest(TestBase):
 
     def test_compare_boolean_diff(self):
         self._compare_default_roundtrip(Boolean(), "1", "0")
 
     def test_compare_boolean_diff(self):
         self._compare_default_roundtrip(Boolean(), "1", "0")

+
+
+class MySQLAutogenRenderTest(TestBase):
+    def setUp(self):
+        ctx_opts = {
+            "sqlalchemy_module_prefix": "sa.",
+            "alembic_module_prefix": "op.",
+            "target_metadata": MetaData(),
+        }
+        context = MigrationContext.configure(
+            dialect_name="mysql", opts=ctx_opts
+        )
+
+        self.autogen_context = api.AutogenContext(context)
+
+    def test_render_add_index_expr_binary(self):
+        m = MetaData()
+        t = Table(
+            "t",
+            m,
+            Column("x", Integer, primary_key=True),
+            Column("y", Integer),
+        )
+        idx = Index("foo_idx", t.c.x > 5)
+
+        eq_ignore_whitespace(
+            autogenerate.render_op_text(
+                self.autogen_context, ops.CreateIndexOp.from_index(idx)
+            ),
+            "op.create_index('foo_idx', 't', "
+            "[sa.literal_column('(x > 5)')], unique=False)",
+        )
+
+    def test_render_add_index_expr_unary(self):
+        m = MetaData()
+        t = Table(
+            "t",
+            m,
+            Column("x", Integer, primary_key=True),
+            Column("y", Integer),
+        )
+        idx1 = Index("foo_idx", -t.c.x)
+        idx2 = Index("foo_idx", t.c.x.desc())
+
+        eq_ignore_whitespace(
+            autogenerate.render_op_text(
+                self.autogen_context, ops.CreateIndexOp.from_index(idx1)
+            ),
+            "op.create_index('foo_idx', 't', "
+            "[sa.literal_column('(-x)')], unique=False)",
+        )
+        eq_ignore_whitespace(
+            autogenerate.render_op_text(
+                self.autogen_context, ops.CreateIndexOp.from_index(idx2)
+            ),
+            "op.create_index('foo_idx', 't', "
+            "[sa.literal_column('x DESC')], unique=False)",
+        )
+
+    def test_render_add_index_expr_func(self):
+        m = MetaData()
+        t = Table(
+            "t",
+            m,
+            Column("x", Integer, primary_key=True),
+            Column("y", Integer, nullable=True),
+        )
+        idx = Index("foo_idx", t.c.x, func.coalesce(t.c.y, 0))
+
+        eq_ignore_whitespace(
+            autogenerate.render_op_text(
+                self.autogen_context, ops.CreateIndexOp.from_index(idx)
+            ),
+            "op.create_index('foo_idx', 't', "
+            "['x', sa.literal_column('(coalesce(y, 0))')], unique=False)",
+        )