Skip to content

Commit

Permalink
update sqla links for 0.8 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zzzeek committed Dec 9, 2012
1 parent 0ed2080 commit d5ca6b4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
16 changes: 8 additions & 8 deletions alembic/environment.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,18 +237,18 @@ def configure(self,
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.
Expand Down Expand Up @@ -293,7 +293,7 @@ def configure(self,
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
Expand Down Expand Up @@ -547,17 +547,17 @@ def begin_transaction(self):
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
is raised.
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.
Expand Down Expand Up @@ -593,7 +593,7 @@ def get_bind(self):
"""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`
Expand Down
4 changes: 2 additions & 2 deletions alembic/migration.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ def configure(cls,
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
Expand Down Expand Up @@ -243,7 +243,7 @@ def bind(self):
"""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`
Expand Down
8 changes: 4 additions & 4 deletions alembic/operations.py
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ def create_table(self, name, *columns, **kw):
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(
Expand All @@ -585,7 +585,7 @@ def drop_table(self, name, **kw):
.. 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(
Expand Down Expand Up @@ -803,7 +803,7 @@ def execute(self, sql, execution_options=None):
: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)
Expand All @@ -812,7 +812,7 @@ def get_bind(self):
"""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]
Expand Down

0 comments on commit d5ca6b4

Please sign in to comment.