diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-09-05 14:44:58 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-09-05 14:44:58 -0400 |
commit | 703ce7f1791c1143eb983c38e3bd627984ea1953 (patch) | |
tree | d52e3cc51041b96985e96b58f2340be233fc3600 /lib/sqlalchemy/sql/expression.py | |
parent | 1f65ac6679298c7f18e8ff3b13d6694e357ed5d5 (diff) | |
download | sqlalchemy-703ce7f1791c1143eb983c38e3bd627984ea1953.tar.gz |
- rewrote the "connections" section
- improved pool docs
- typos etc.
- ClauseElement.execute() and scalar() make no sense - these are depreacted.
The official home is Executable.
- alias() is not executable, allowing it is sloppy so this goes under
the deprecated umbrella
Diffstat (limited to 'lib/sqlalchemy/sql/expression.py')
-rw-r--r-- | lib/sqlalchemy/sql/expression.py | 34 |
1 files changed, 30 insertions, 4 deletions
diff --git a/lib/sqlalchemy/sql/expression.py b/lib/sqlalchemy/sql/expression.py index d184816ab..5235a696b 100644 --- a/lib/sqlalchemy/sql/expression.py +++ b/lib/sqlalchemy/sql/expression.py @@ -1269,10 +1269,13 @@ class ClauseElement(Visitable): return engine else: return None - + + @util.deprecated("0.7", "Only SQL expressions which subclass :class:`.Executable` " + "may provide the :func:`.execute` method.") def execute(self, *multiparams, **params): - """Compile and execute this :class:`ClauseElement`.""" - + """Compile and execute this :class:`ClauseElement`. + + """ e = self.bind if e is None: label = getattr(self, 'description', self.__class__.__name__) @@ -1284,6 +1287,8 @@ class ClauseElement(Visitable): raise exc.UnboundExecutionError(msg) return e._execute_clauseelement(self, multiparams, params) + @util.deprecated("0.7", "Only SQL expressions which subclass :class:`.Executable` " + "may provide the :func:`.scalar` method.") def scalar(self, *multiparams, **params): """Compile and execute this :class:`ClauseElement`, returning the result's scalar representation. @@ -2401,7 +2406,7 @@ class Executable(_Generative): COMMIT will be invoked in order to provide its "autocommit" feature. Typically, all INSERT/UPDATE/DELETE statements as well as CREATE/DROP statements have autocommit behavior enabled; SELECT - constructs do not. Use this option when invokving a SELECT or other + constructs do not. Use this option when invoking a SELECT or other specific SQL construct where COMMIT is desired (typically when calling stored procedures and such). @@ -2436,6 +2441,27 @@ class Executable(_Generative): """ self._execution_options = self._execution_options.union(kw) + def execute(self, *multiparams, **params): + """Compile and execute this :class:`.Executable`.""" + + e = self.bind + if e is None: + label = getattr(self, 'description', self.__class__.__name__) + msg = ('This %s is not bound and does not support direct ' + 'execution. Supply this statement to a Connection or ' + 'Engine for execution. Or, assign a bind to the statement ' + 'or the Metadata of its underlying tables to enable ' + 'implicit execution via this method.' % label) + raise exc.UnboundExecutionError(msg) + return e._execute_clauseelement(self, multiparams, params) + + def scalar(self, *multiparams, **params): + """Compile and execute this :class:`.Executable`, returning the + result's scalar representation. + + """ + return self.execute(*multiparams, **params).scalar() + # legacy, some outside users may be calling this _Executable = Executable |