diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-03-09 18:45:30 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-03-09 18:45:30 -0500 |
| commit | 53832b9fb25afa89f36234d86a09b4414feada3a (patch) | |
| tree | e22a3adbf03174569c06cb21a963ebda3d6e9891 /lib/sqlalchemy/engine | |
| parent | dcd65902523f08dc1027d4d5a013b2c1f95bc230 (diff) | |
| download | sqlalchemy-53832b9fb25afa89f36234d86a09b4414feada3a.tar.gz | |
fixed up docs for execution_options() across all three locations.
Diffstat (limited to 'lib/sqlalchemy/engine')
| -rw-r--r-- | lib/sqlalchemy/engine/base.py | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py index 46907dfcf..ea6282954 100644 --- a/lib/sqlalchemy/engine/base.py +++ b/lib/sqlalchemy/engine/base.py @@ -767,15 +767,20 @@ class Connection(Connectable): return self.engine.Connection(self.engine, self.__connection, _branch=True) def execution_options(self, **opt): - """Add keyword options to a Connection generatively. + """ Set non-SQL options for the connection which take effect during execution. - Experimental. May change the name/signature at - some point. - - If made public, strongly consider the name - "options()" so as to be consistent with - orm.Query.options(). + The method returns a copy of this :class:`Connection` which references + the same underlying DBAPI connection, but also defines the given execution + options which will take effect for a call to :meth:`execute`. As the new + :class:`Connection` references the same underlying resource, it is probably + best to ensure that the copies would be discarded immediately, which + is implicit if used as in:: + result = connection.execution_options(stream_results=True).execute(stmt) + + The options are the same as those accepted by + :meth:`sqlalchemy.sql.expression.Executable.execution_options`. + """ return self.engine.Connection( self.engine, self.__connection, |
