summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/base.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-07-20 11:54:58 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2010-07-20 11:54:58 -0400
commit199fb1dd3822001503c13de673fd2db1150a6d4b (patch)
treec663834939092d16014ee0ec9ef7a9c184d60760 /lib/sqlalchemy/engine/base.py
parent2bd3c795cfe39249aceb6b04ea4650a17788d9b6 (diff)
downloadsqlalchemy-199fb1dd3822001503c13de673fd2db1150a6d4b.tar.gz
document the crap out of text(), Session.execute()
Diffstat (limited to 'lib/sqlalchemy/engine/base.py')
-rw-r--r--lib/sqlalchemy/engine/base.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 81ef6a329..cf459f9e6 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -1667,7 +1667,14 @@ class Engine(Connectable, log.Identified):
return expression._FunctionGenerator(bind=self)
def text(self, text, *args, **kwargs):
- """Return a sql.text() object for performing literal queries."""
+ """Return a :func:`~sqlalchemy.sql.expression.text` construct,
+ bound to this engine.
+
+ This is equivalent to::
+
+ text("SELECT * FROM table", bind=engine)
+
+ """
return expression.text(text, bind=self, *args, **kwargs)
@@ -1711,6 +1718,8 @@ class Engine(Connectable, log.Identified):
conn.close()
def execute(self, statement, *multiparams, **params):
+ """Executes and returns a ResultProxy."""
+
connection = self.contextual_connect(close_with_result=True)
return connection.execute(statement, *multiparams, **params)