From: Mike Bayer Date: Sun, 9 Dec 2012 22:08:16 +0000 (-0500) Subject: update sqla links for 0.8 docs X-Git-Tag: rel_0_4_1~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5ca6b47fcce25e5f343b6faf71a2c50ed9d023b;p=thirdparty%2Fsqlalchemy%2Falembic.git update sqla links for 0.8 docs --- diff --git a/alembic/environment.py b/alembic/environment.py index 7b0d16d0..c633c2b7 100644 --- a/alembic/environment.py +++ b/alembic/environment.py @@ -237,18 +237,18 @@ class EnvironmentContext(object): If the :meth:`.is_offline_mode` function returns ``True``, then no connection is needed here. Otherwise, the ``connection`` parameter should be present as an - instance of :class:`sqlalchemy.engine.base.Connection`. + instance of :class:`sqlalchemy.engine.Connection`. This function is typically called from the ``env.py`` script within a migration environment. It can be called multiple times for an invocation. The most recent - :class:`~sqlalchemy.engine.base.Connection` + :class:`~sqlalchemy.engine.Connection` for which it was called is the one that will be operated upon by the next call to :meth:`.run_migrations`. General parameters: - :param connection: a :class:`~sqlalchemy.engine.base.Connection` + :param connection: a :class:`~sqlalchemy.engine.Connection` to use for SQL execution in "online" mode. When present, is also used to determine the type of dialect in use. @@ -293,7 +293,7 @@ class EnvironmentContext(object): will be consulted during autogeneration. The tables present will be compared against what is locally available on the target - :class:`~sqlalchemy.engine.base.Connection` + :class:`~sqlalchemy.engine.Connection` to produce candidate upgrade/downgrade operations. :param compare_type: Indicates type comparison behavior during @@ -547,9 +547,9 @@ class EnvironmentContext(object): the output stream, as rendered by the target backend (e.g. SQL Server would emit ``BEGIN TRANSACTION``). - * Otherwise, calls :meth:`sqlalchemy.engine.base.Connection.begin` + * Otherwise, calls :meth:`sqlalchemy.engine.Connection.begin` on the current online connection, which - returns a :class:`sqlalchemy.engine.base.Transaction` + returns a :class:`sqlalchemy.engine.Transaction` object. This object demarcates a real transaction and is itself a context manager, which will roll back if an exception @@ -557,7 +557,7 @@ class EnvironmentContext(object): Note that a custom ``env.py`` script which has more specific transactional needs can of course - manipulate the :class:`~sqlalchemy.engine.base.Connection` + manipulate the :class:`~sqlalchemy.engine.Connection` directly to produce transactional state in "online" mode. @@ -593,7 +593,7 @@ class EnvironmentContext(object): """Return the current 'bind'. In "online" mode, this is the - :class:`sqlalchemy.engine.base.Connection` currently being used + :class:`sqlalchemy.engine.Connection` currently being used to emit SQL to the database. This function requires that a :class:`.MigrationContext` diff --git a/alembic/migration.py b/alembic/migration.py index 9bfcaebf..7a13e937 100644 --- a/alembic/migration.py +++ b/alembic/migration.py @@ -107,7 +107,7 @@ class MigrationContext(object): This is a factory method usually called by :meth:`.EnvironmentContext.configure`. - :param connection: a :class:`~sqlalchemy.engine.base.Connection` + :param connection: a :class:`~sqlalchemy.engine.Connection` to use for SQL execution in "online" mode. When present, is also used to determine the type of dialect in use. :param url: a string database url, or a @@ -243,7 +243,7 @@ class MigrationContext(object): """Return the current "bind". In online mode, this is an instance of - :class:`sqlalchemy.engine.base.Connection`, and is suitable + :class:`sqlalchemy.engine.Connection`, and is suitable for ad-hoc execution of any kind of usage described in :ref:`sqlexpression_toplevel` as well as for usage with the :meth:`sqlalchemy.schema.Table.create` diff --git a/alembic/operations.py b/alembic/operations.py index c31151d7..63f50bc6 100644 --- a/alembic/operations.py +++ b/alembic/operations.py @@ -563,7 +563,7 @@ class Operations(object): and :class:`~.sqlalchemy.schema.Index` objects. :param schema: Optional schema name to operate within. :param \**kw: Other keyword arguments are passed to the underlying - :class:`.Table` object created for the command. + :class:`sqlalchemy.schema.Table` object created for the command. """ self.impl.create_table( @@ -585,7 +585,7 @@ class Operations(object): .. versionadded:: 0.4.0 :param \**kw: Other keyword arguments are passed to the underlying - :class:`.Table` object created for the command. + :class:`sqlalchemy.schema.Table` object created for the command. """ self.impl.drop_table( @@ -803,7 +803,7 @@ class Operations(object): :param execution_options: Optional dictionary of execution options, will be passed to - :meth:`sqlalchemy.engine.base.Connection.execution_options`. + :meth:`sqlalchemy.engine.Connection.execution_options`. """ self.migration_context.impl.execute(sql, execution_options=execution_options) @@ -812,7 +812,7 @@ class Operations(object): """Return the current 'bind'. Under normal circumstances, this is the - :class:`~sqlalchemy.engine.base.Connection` currently being used + :class:`~sqlalchemy.engine.Connection` currently being used to emit SQL to the database. In a SQL script context, this value is ``None``. [TODO: verify this]