Changeset - 0ccdb52079e9
[Not reviewed]
default
0 1 0
timeless@gmail.com - 10 years ago 2016-05-03 14:12:24
timeless@gmail.com
spelling: referred
1 file changed with 1 insertions and 1 deletions:
0 comments (0 inline, 0 general)
kallithea/lib/dbmigrate/migrate/changeset/schema.py
Show inline comments
 
@@ -32,97 +32,97 @@ __all__ = [
 
def create_column(column, table=None, *p, **kw):
 
    """Create a column, given the table.
 

	
 
    API to :meth:`ChangesetColumn.create`.
 
    """
 
    if table is not None:
 
        return table.create_column(column, *p, **kw)
 
    return column.create(*p, **kw)
 

	
 

	
 
def drop_column(column, table=None, *p, **kw):
 
    """Drop a column, given the table.
 

	
 
    API to :meth:`ChangesetColumn.drop`.
 
    """
 
    if table is not None:
 
        return table.drop_column(column, *p, **kw)
 
    return column.drop(*p, **kw)
 

	
 

	
 
def rename_table(table, name, engine=None, **kw):
 
    """Rename a table.
 

	
 
    If Table instance is given, engine is not used.
 

	
 
    API to :meth:`ChangesetTable.rename`.
 

	
 
    :param table: Table to be renamed.
 
    :param name: New name for Table.
 
    :param engine: Engine instance.
 
    :type table: string or Table instance
 
    :type name: string
 
    :type engine: obj
 
    """
 
    table = _to_table(table, engine)
 
    table.rename(name, **kw)
 

	
 

	
 
def rename_index(index, name, table=None, engine=None, **kw):
 
    """Rename an index.
 

	
 
    If Index instance is given,
 
    table and engine are not used.
 

	
 
    API to :meth:`ChangesetIndex.rename`.
 

	
 
    :param index: Index to be renamed.
 
    :param name: New name for index.
 
    :param table: Table to which Index is reffered.
 
    :param table: Table to which Index is referred.
 
    :param engine: Engine instance.
 
    :type index: string or Index instance
 
    :type name: string
 
    :type table: string or Table instance
 
    :type engine: obj
 
    """
 
    index = _to_index(index, table, engine)
 
    index.rename(name, **kw)
 

	
 

	
 
def alter_column(*p, **k):
 
    """Alter a column.
 

	
 
    This is a helper function that creates a :class:`ColumnDelta` and
 
    runs it.
 

	
 
    :argument column:
 
      The name of the column to be altered or a
 
      :class:`ChangesetColumn` column representing it.
 

	
 
    :param table:
 
      A :class:`~sqlalchemy.schema.Table` or table name to
 
      for the table where the column will be changed.
 

	
 
    :param engine:
 
      The :class:`~sqlalchemy.engine.base.Engine` to use for table
 
      reflection and schema alterations.
 

	
 
    :returns: A :class:`ColumnDelta` instance representing the change.
 

	
 

	
 
    """
 

	
 
    if 'table' not in k and isinstance(p[0], sqlalchemy.Column):
 
        k['table'] = p[0].table
 
    if 'engine' not in k:
 
        k['engine'] = k['table'].bind
 

	
 
    # deprecation
 
    if len(p) >= 2 and isinstance(p[1], sqlalchemy.Column):
 
        warnings.warn(
 
            "Passing a Column object to alter_column is deprecated."
 
            " Just pass in keyword parameters instead.",
 
            MigrateDeprecationWarning
 
            )
 
    engine = k['engine']
 

	
 
    # enough tests seem to break when metadata is always altered
0 comments (0 inline, 0 general)