From 1f407c2a47150ddd550d3167015a9315e018d7bc Mon Sep 17 00:00:00 2001 From: Joseph Schorr Date: Tue, 17 Jan 2017 10:02:17 -0500 Subject: Add support for prefixes on CREATE INDEX statements in MySQL Added a new parameter ``mysql_prefix`` supported by the :class:`.Index` construct, allows specification of MySQL-specific prefixes such as "FULLTEXT". Pull request courtesy Joseph Schorr. Change-Id: I5a21fa466fdfd4d9e39e1fb4ecec1eab93b92c36 Pull-request: https://github.com/zzzeek/sqlalchemy/pull/339 --- lib/sqlalchemy/dialects/mysql/base.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'lib') diff --git a/lib/sqlalchemy/dialects/mysql/base.py b/lib/sqlalchemy/dialects/mysql/base.py index 1654ff327..8b0d00a63 100644 --- a/lib/sqlalchemy/dialects/mysql/base.py +++ b/lib/sqlalchemy/dialects/mysql/base.py @@ -391,6 +391,25 @@ BLOB. .. versionadded:: 0.8.2 ``mysql_length`` may now be specified as a dictionary for use with composite indexes. +Index Prefixes +~~~~~~~~~~~~~~ + +MySQL storage engines permit you to specify an index prefix when creating +an index. SQLAlchemy provides this feature via the +``mysql_prefix`` parameter on :class:`.Index`:: + + Index('my_index', my_table.c.data, mysql_prefix='FULLTEXT') + +The value passed to the keyword argument will be simply passed through to the +underlying CREATE INDEX, so it *must* be a valid index prefix for your MySQL +storage engine. + +.. versionadded:: 1.1.5 + +.. seealso:: + + `CREATE INDEX `_ - MySQL documentation + Index Types ~~~~~~~~~~~~~ @@ -1039,6 +1058,11 @@ class MySQLDDLCompiler(compiler.DDLCompiler): text = "CREATE " if index.unique: text += "UNIQUE " + + index_prefix = index.kwargs.get('mysql_prefix', None) + if index_prefix: + text += index_prefix + ' ' + text += "INDEX %s ON %s " % (name, table) length = index.dialect_options['mysql']['length'] @@ -1468,6 +1492,7 @@ class MySQLDialect(default.DefaultDialect): (sa_schema.Index, { "using": None, "length": None, + "prefix": None, }) ] -- cgit v1.2.1