From: Lucas Taylor Date: Fri, 10 Oct 2014 19:21:18 +0000 (-0500) Subject: Update documentation for create_index parameters X-Git-Tag: rel_0_7_0~62^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=52e84dde009cdd7b5a833d8c5818886ca2b70442;p=thirdparty%2Fsqlalchemy%2Falembic.git Update documentation for create_index parameters --- diff --git a/alembic/operations.py b/alembic/operations.py index 2ea54cb3..a324a24b 100644 --- a/alembic/operations.py +++ b/alembic/operations.py @@ -759,7 +759,8 @@ class Operations(object): self._table(name, **kw) ) - def create_index(self, name, table_name, columns, schema=None, **kw): + def create_index(self, name, table_name, columns, schema=None, + unique=False, quote=None, **kw): """Issue a "create index" instruction using the current migration context. @@ -795,10 +796,26 @@ class Operations(object): .. versionadded:: 0.4.0 + :param unique: If True, create a unique index. + + :param quote: + Force quoting of this column's name on or off, corresponding + to ``True`` or ``False``. When left at its default + of ``None``, the column identifier will be quoted according to + whether the name is case sensitive (identifiers with at least one + upper case character are treated as case sensitive), or if it's a + reserved word. This flag is only needed to force quoting of a + reserved word which is not known by the SQLAlchemy dialect. + + :param \**kw: Additional keyword arguments not mentioned above are + dialect specific, and passed in the form ``_``. + See the documentation regarding an individual dialect at + :ref:`dialect_toplevel` for detail on documented arguments. """ self.impl.create_index( - self._index(name, table_name, columns, schema=schema, **kw) + self._index(name, table_name, columns, schema=schema, + unique=unique, quote=quote, **kw) ) @util._with_legacy_names([('tablename', 'table_name')])