]> git.ipfire.org Git - thirdparty/sqlalchemy/alembic.git/commitdiff
Merged in ltvolks/alembic/docs-153 (pull request #28)
authorMike Bayer <classic@zzzcomputing.com>
Fri, 10 Oct 2014 19:25:15 +0000 (15:25 -0400)
committerMike Bayer <classic@zzzcomputing.com>
Fri, 10 Oct 2014 19:25:15 +0000 (15:25 -0400)
Update documentation for create_index parameters

1  2 
alembic/operations.py

index 9124f328e4df1129e0cbffe4698412f29d938b3a,a324a24bd82cd8c5c13883b7f548fa46782a0458..11319f733bb2a5da3ff7638461f24622388e4418
@@@ -854,16 -792,25 +855,31 @@@ class Operations(object)
  
          :param columns: a list consisting of string column names and/or
           :func:`~sqlalchemy.sql.expression.text` constructs.
 -        :param schema: Optional schema name to operate within.
 +        :param schema: Optional schema name to operate within.  To control
 +         quoting of the schema outside of the default behavior, use
 +         the SQLAlchemy construct
 +         :class:`~sqlalchemy.sql.elements.quoted_name`.
  
 -         .. versionadded:: 0.4.0
 +         .. versionadded:: 0.4.0 support for 'schema'
 +
 +         .. versionadded:: 0.7.0 'schema' can now accept a
 +            :class:`~sqlalchemy.sql.elements.quoted_name` construct.
  
+         :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 ``<dialectname>_<argname>``.
+             See the documentation regarding an individual dialect at
+             :ref:`dialect_toplevel` for detail on documented arguments.
          """
  
          self.impl.create_index(