diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-08-13 17:35:27 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-08-13 17:35:27 -0400 |
| commit | 8c7914e1818961e8d3acee33bea8e006b13993fa (patch) | |
| tree | 506e17ff2f5dc2009cb9f98e9689204d2d9d4032 /lib/sqlalchemy | |
| parent | 96650157083f9c691a7a8a737724159cd6a1d668 (diff) | |
| download | sqlalchemy-8c7914e1818961e8d3acee33bea8e006b13993fa.tar.gz | |
- update engine docstrings due to move
- struggle with Operators class autodoc
Diffstat (limited to 'lib/sqlalchemy')
| -rw-r--r-- | lib/sqlalchemy/dialects/postgresql/psycopg2.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/engine/__init__.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/engine/reflection.py | 8 | ||||
| -rw-r--r-- | lib/sqlalchemy/ext/horizontal_shard.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/events.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/mapper.py | 2 |
6 files changed, 9 insertions, 9 deletions
diff --git a/lib/sqlalchemy/dialects/postgresql/psycopg2.py b/lib/sqlalchemy/dialects/postgresql/psycopg2.py index e572b49b0..8a4360b34 100644 --- a/lib/sqlalchemy/dialects/postgresql/psycopg2.py +++ b/lib/sqlalchemy/dialects/postgresql/psycopg2.py @@ -30,7 +30,7 @@ psycopg2-specific keyword arguments which are accepted by ``connection.cursor('some name')``, which has the effect that result rows are not immediately pre-fetched and buffered after statement execution, but are instead left on the server and only retrieved as needed. SQLAlchemy's - :class:`~sqlalchemy.engine.base.ResultProxy` uses special row-buffering + :class:`~sqlalchemy.engine.ResultProxy` uses special row-buffering behavior when this feature is enabled, such that groups of 100 rows at a time are fetched over the wire to reduce conversational overhead. Note that the ``stream_results=True`` execution option is a more targeted diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py index 279c037ee..eb9ef266b 100644 --- a/lib/sqlalchemy/engine/__init__.py +++ b/lib/sqlalchemy/engine/__init__.py @@ -228,7 +228,7 @@ def create_engine(*args, **kwargs): :param execution_options: Dictionary execution options which will be applied to all connections. See - :meth:`~sqlalchemy.engine.base.Connection.execution_options` + :meth:`~sqlalchemy.engine.Connection.execution_options` :param implicit_returning=True: When ``True``, a RETURNING- compatible construct, if available, will be used to diff --git a/lib/sqlalchemy/engine/reflection.py b/lib/sqlalchemy/engine/reflection.py index f991a4acd..613d73301 100644 --- a/lib/sqlalchemy/engine/reflection.py +++ b/lib/sqlalchemy/engine/reflection.py @@ -82,8 +82,8 @@ class Inspector(object): :param bind: a :class:`~sqlalchemy.engine.base.Connectable`, which is typically an instance of - :class:`~sqlalchemy.engine.base.Engine` or - :class:`~sqlalchemy.engine.base.Connection`. + :class:`~sqlalchemy.engine.Engine` or + :class:`~sqlalchemy.engine.Connection`. For a dialect-specific instance of :class:`.Inspector`, see :meth:`Inspector.from_engine` @@ -111,8 +111,8 @@ class Inspector(object): :param bind: a :class:`~sqlalchemy.engine.base.Connectable`, which is typically an instance of - :class:`~sqlalchemy.engine.base.Engine` or - :class:`~sqlalchemy.engine.base.Connection`. + :class:`~sqlalchemy.engine.Engine` or + :class:`~sqlalchemy.engine.Connection`. This method differs from direct a direct constructor call of :class:`.Inspector` in that the :class:`~sqlalchemy.engine.base.Dialect` is given a chance to provide diff --git a/lib/sqlalchemy/ext/horizontal_shard.py b/lib/sqlalchemy/ext/horizontal_shard.py index aa5bab2e2..f55cfae0a 100644 --- a/lib/sqlalchemy/ext/horizontal_shard.py +++ b/lib/sqlalchemy/ext/horizontal_shard.py @@ -92,7 +92,7 @@ class ShardedSession(Session): should be issued. Results from all shards returned will be combined together into a single listing. - :param shards: A dictionary of string shard names to :class:`~sqlalchemy.engine.base.Engine` + :param shards: A dictionary of string shard names to :class:`~sqlalchemy.engine.Engine` objects. """ diff --git a/lib/sqlalchemy/orm/events.py b/lib/sqlalchemy/orm/events.py index 53b42d051..05f640ab0 100644 --- a/lib/sqlalchemy/orm/events.py +++ b/lib/sqlalchemy/orm/events.py @@ -1056,7 +1056,7 @@ class SessionEvents(event.Events): :param session: The target :class:`.Session`. :param transaction: The :class:`.SessionTransaction`. - :param connection: The :class:`~.engine.base.Connection` object + :param connection: The :class:`~.engine.Connection` object which will be used for SQL statements. """ diff --git a/lib/sqlalchemy/orm/mapper.py b/lib/sqlalchemy/orm/mapper.py index 069de2597..bcc1a2454 100644 --- a/lib/sqlalchemy/orm/mapper.py +++ b/lib/sqlalchemy/orm/mapper.py @@ -1746,7 +1746,7 @@ class Mapper(_InspectionAttr): item from the identity map. row - A ``sqlalchemy.engine.base.RowProxy`` instance or a + A ``sqlalchemy.engine.RowProxy`` instance or a dictionary corresponding result-set ``ColumnElement`` instances to their values within a row. |
