]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- Changed the scheme used to generate truncated
authorMike Bayer <mike_mp@zzzcomputing.com>
Wed, 21 Jul 2010 15:33:47 +0000 (11:33 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Wed, 21 Jul 2010 15:33:47 +0000 (11:33 -0400)
"auto" index names when using the "index=True"
flag on Column.   The truncation only takes
place with the auto-generated name, not one
that is user-defined (an error would be
raised instead), and the truncation scheme
itself is now based on a fragment of an md5
hash of the identifier name, so that multiple
indexes on columns with similar names still
have unique names.  [ticket:1855]

12 files changed:
CHANGES
lib/sqlalchemy/__init__.py
lib/sqlalchemy/dialects/access/base.py
lib/sqlalchemy/dialects/mssql/base.py
lib/sqlalchemy/dialects/mysql/base.py
lib/sqlalchemy/dialects/postgresql/base.py
lib/sqlalchemy/dialects/sqlite/base.py
lib/sqlalchemy/dialects/sybase/base.py
lib/sqlalchemy/schema.py
lib/sqlalchemy/sql/compiler.py
lib/sqlalchemy/util.py
test/sql/test_constraints.py

diff --git a/CHANGES b/CHANGES
index 12730f9540cdcff3eeafbaa140fef3eb69a81284..3aaff9b001c65c5ca4b7807776e2b307c89eebc8 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -3,6 +3,20 @@
 =======
 CHANGES
 =======
+0.6.4
+=====
+- sql
+  - Changed the scheme used to generate truncated
+    "auto" index names when using the "index=True"
+    flag on Column.   The truncation only takes
+    place with the auto-generated name, not one
+    that is user-defined (an error would be 
+    raised instead), and the truncation scheme 
+    itself is now based on a fragment of an md5
+    hash of the identifier name, so that multiple
+    indexes on columns with similar names still
+    have unique names.  [ticket:1855]
+
 0.6.3
 =====
 - orm
@@ -38,7 +52,7 @@ CHANGES
     naming/typing information about the entities
     the Query will return.  Can be helpful for 
     building GUIs on top of ORM queries.
-
+    
 - mysql
 
   - The _extract_error_code() method now works 
index 35f91a5c1a09fb7fe5f789fe9a69bee75c5d79b3..2d809e3396c2caa89bf253ec1c130aaffa86dbb2 100644 (file)
@@ -114,6 +114,6 @@ from sqlalchemy.engine import create_engine, engine_from_config
 __all__ = sorted(name for name, obj in locals().items()
                  if not (name.startswith('_') or inspect.ismodule(obj)))
                  
-__version__ = '0.6.3'
+__version__ = '0.6.4'
 
 del inspect, sys
index 8efea5941ec1d77a4b160374e1b770cd8bb75b4d..75ea912874f0781118698fbe26697ca659337317 100644 (file)
@@ -436,7 +436,7 @@ class AccessDDLCompiler(compiler.DDLCompiler):
         index = drop.element
         self.append("\nDROP INDEX [%s].[%s]" % \
                         (index.table.name,
-                        self._validate_identifier(index.name, False)))
+                        self._index_identifier(index.name)))
 
 class AccessIdentifierPreparer(compiler.IdentifierPreparer):
     reserved_words = compiler.RESERVED_WORDS.copy()
index 820b3a0c24c2deaf91549dc786a1eddeda620c3d..395015c774d376dd7567620f4fd75c620be4fbec 100644 (file)
@@ -967,7 +967,7 @@ class MSDDLCompiler(compiler.DDLCompiler):
         return "\nDROP INDEX %s.%s" % (
             self.preparer.quote_identifier(drop.element.table.name),
             self.preparer.quote(
-                        self._validate_identifier(drop.element.name, False),
+                        self._index_identifier(drop.element.name),
                         drop.element.quote)
             )
 
index af18ae551e03be35f972a938af91daeb02ace2cf..08978dfe3bb6e824ac916b92ef9b6e362ca9c880 100644 (file)
@@ -1358,7 +1358,7 @@ class MySQLDDLCompiler(compiler.DDLCompiler):
         index = drop.element
         
         return "\nDROP INDEX %s ON %s" % \
-                    (self.preparer.quote(self._validate_identifier(index.name, False), index.quote),
+                    (self.preparer.quote(self._index_identifier(index.name), index.quote),
                      self.preparer.format_table(index.table))
 
     def visit_drop_constraint(self, drop):
index c260e5f684e2152ed716e10f253d846bf4d3b4ce..5eba1637262a9fd0323789555d85487800b51439 100644 (file)
@@ -480,7 +480,7 @@ class PGDDLCompiler(compiler.DDLCompiler):
             text += "UNIQUE "
         text += "INDEX %s ON %s (%s)" \
                 % (preparer.quote(
-                    self._validate_identifier(index.name, True), index.quote),
+                    self._index_identifier(index.name), index.quote),
                    preparer.format_table(index.table),
                    ', '.join([preparer.format_column(c) 
                                 for c in index.columns]))
index 030b45afff6f161521d1f1ea30b3b5103d796a24..2d9e56baf2fdd4a83a20fd70a432c3f9a8bb4ced 100644 (file)
@@ -280,7 +280,7 @@ class SQLiteDDLCompiler(compiler.DDLCompiler):
             text += "UNIQUE "
         text += "INDEX %s ON %s (%s)" \
                     % (preparer.format_index(index,
-                       name=self._validate_identifier(index.name, True)),
+                       name=self._index_identifier(index.name)),
                        preparer.format_table(index.table, use_schema=False),
                        ', '.join(preparer.quote(c.name, c.quote)
                                  for c in index.columns))
index 53ceedc2bf36bd32677cb403040ab108ebdd6c4b..b0b1bbff4d167a0385cce967a3eb6c1127020f02 100644 (file)
@@ -356,7 +356,7 @@ class SybaseDDLCompiler(compiler.DDLCompiler):
         return "\nDROP INDEX %s.%s" % (
             self.preparer.quote_identifier(index.table.name),
             self.preparer.quote(
-                    self._validate_identifier(index.name, False), index.quote)
+                    self._index_identifier(index.name), index.quote)
             )
 
 class SybaseIdentifierPreparer(compiler.IdentifierPreparer):
index a2f6979371bb3c58693b6bb5ba9f9136045e2999..75bbfd070a010df09163ebbe2557117dfe6f3f78 100644 (file)
@@ -825,7 +825,7 @@ class Column(SchemaItem, expression.ColumnClause):
                     "The 'index' keyword argument on Column is boolean only. "
                     "To create indexes with a specific name, create an "
                     "explicit Index object external to the Table.")
-            Index('ix_%s' % self._label, self, unique=self.unique)
+            Index(expression._generated_label('ix_%s' % self._label), self, unique=self.unique)
         elif self.unique:
             if isinstance(self.unique, basestring):
                 raise exc.ArgumentError(
index c54931b87b0046877de24795ffb31c2bea39f2be..0383f9690f5abd0e3c0ec382c1453d21228aa62a 100644 (file)
@@ -1179,7 +1179,18 @@ class DDLCompiler(engine.Compiled):
         
     def visit_drop_table(self, drop):
         return "\nDROP TABLE " + self.preparer.format_table(drop.element)
-        
+
+    def _index_identifier(self, ident):
+        if isinstance(ident, sql._generated_label):
+            if len(ident) > self.dialect.max_identifier_length:
+                return ident[0:self.dialect.max_identifier_length - 8] + \
+                                "_" + util.md5_hex(ident)[-4:]
+            else:
+                return ident
+        else:
+            self.dialect.validate_identifier(ident)
+            return ident
+
     def visit_create_index(self, create):
         index = create.element
         preparer = self.preparer
@@ -1187,7 +1198,8 @@ class DDLCompiler(engine.Compiled):
         if index.unique:
             text += "UNIQUE "   
         text += "INDEX %s ON %s (%s)" \
-                    % (preparer.quote(self._validate_identifier(index.name, True), index.quote),
+                    % (preparer.quote(self._index_identifier(index.name), 
+                        index.quote),
                        preparer.format_table(index.table),
                        ', '.join(preparer.quote(c.name, c.quote)
                                  for c in index.columns))
@@ -1196,7 +1208,7 @@ class DDLCompiler(engine.Compiled):
     def visit_drop_index(self, drop):
         index = drop.element
         return "\nDROP INDEX " + \
-                    self.preparer.quote(self._validate_identifier(index.name, False), index.quote)
+                    self.preparer.quote(self._index_identifier(index.name), index.quote)
 
     def visit_add_constraint(self, create):
         preparer = self.preparer
@@ -1238,18 +1250,6 @@ class DDLCompiler(engine.Compiled):
     def post_create_table(self, table):
         return ''
 
-    def _validate_identifier(self, ident, truncate):
-        if truncate:
-            if len(ident) > self.dialect.max_identifier_length:
-                counter = getattr(self, 'counter', 0)
-                self.counter = counter + 1
-                return ident[0:self.dialect.max_identifier_length - 6] + "_" + hex(self.counter)[2:]
-            else:
-                return ident
-        else:
-            self.dialect.validate_identifier(ident)
-            return ident
-
     def get_column_default_string(self, column):
         if isinstance(column.server_default, schema.DefaultClause):
             if isinstance(column.server_default.arg, basestring):
index efbb4c653721a07999e8fcab470e2f45b8c59518..7ed11ca96423406ac54ff767cc6f1d3954a12f0e 100644 (file)
@@ -216,6 +216,18 @@ except:
             return func(*(args + fargs), **newkeywords)
         return newfunc
 
+try:
+    import hashlib
+    _md5 = hashlib.md5
+except ImportError:
+    import md5
+    _md5 = md5.new
+
+def md5_hex(x):
+    m = _md5()
+    m.update(x)
+    return m.hexdigest()
+
 
 def accepts_a_list_as_starargs(list_deprecation=None):
     def decorate(fn):
index 33e4b8d764cff473d8d3701726ec2be55810027f..5624c0ec6d9de6aba3ade77f28041244db135815 100644 (file)
@@ -183,18 +183,31 @@ class ConstraintTest(TestBase, AssertsExecutionResults, AssertsCompiledSQL):
 
     def test_too_long_idx_name(self):
         dialect = testing.db.dialect.__class__()
-        dialect.max_identifier_length = 20
+        dialect.max_identifier_length = 22
 
-        t1 = Table("sometable", MetaData(), Column("foo", Integer))
-        self.assert_compile(
-            schema.CreateIndex(Index("this_name_is_too_long_for_what_were_doing", t1.c.foo)),
-            "CREATE INDEX this_name_is_t_1 ON sometable (foo)",
-            dialect=dialect
-        )
+        for tname, cname, exp in [
+            ('sometable', 'this_name_is_too_long', 'ix_sometable_t_09aa'),
+            ('sometable', 'this_name_alsois_long', 'ix_sometable_t_3cf1'),
+        ]:
         
-        self.assert_compile(
-            schema.CreateIndex(Index("this_other_name_is_too_long_for_what_were_doing", t1.c.foo)),
-            "CREATE INDEX this_other_nam_1 ON sometable (foo)",
+            t1 = Table(tname, MetaData(), 
+                        Column(cname, Integer, index=True),
+                    )
+            ix1 = list(t1.indexes)[0]
+        
+            self.assert_compile(
+                schema.CreateIndex(ix1),
+                "CREATE INDEX %s "
+                "ON %s (%s)" % (exp, tname, cname),
+                dialect=dialect
+            )
+        
+        t1 = Table('t', MetaData(), Column('c', Integer))
+        assert_raises(
+            exc.IdentifierError,
+            schema.CreateIndex(Index(
+                        "this_other_name_is_too_long_for_what_were_doing", 
+                        t1.c.c)).compile,
             dialect=dialect
         )