From: Mike Bayer Date: Sat, 25 Jan 2014 21:55:17 +0000 (-0500) Subject: tweak text X-Git-Tag: rel_0_9_2~24 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=505ce796900150e09fc6087a8381f1dca062b324;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git tweak text --- diff --git a/lib/sqlalchemy/sql/elements.py b/lib/sqlalchemy/sql/elements.py index 04165a083c..536058a503 100644 --- a/lib/sqlalchemy/sql/elements.py +++ b/lib/sqlalchemy/sql/elements.py @@ -1064,7 +1064,20 @@ class TypeClause(ClauseElement): class TextClause(Executable, ClauseElement): """Represent a literal SQL text fragment. - Public constructor is the :func:`text()` function. + E.g.:: + + from sqlalchemy import text + + t = text("SELECT * FROM users") + result = connection.execute(t) + + + The :class:`.Text` construct is produced using the :func:`.text` + function; see that function for full documentation. + + .. seealso:: + + :func:`.text` """ @@ -1162,7 +1175,8 @@ class TextClause(Executable, ClauseElement): to it as an :class:`.Executable` object, and it supports the :meth:`Executable.execution_options` method. For example, a :func:`.text` construct that should be subject to "autocommit" - can be set explicitly so using the ``autocommit`` option:: + can be set explicitly so using the :paramref:`.Connection.execution_options.autocommit` + option:: t = text("EXEC my_procedural_thing()").\\ execution_options(autocommit=True)