From b44ece0789742f2552355497efacd895392d2145 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Fri, 20 Jan 2006 01:03:55 +0000 Subject: [PATCH] some docstrings --- lib/sqlalchemy/sql.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/lib/sqlalchemy/sql.py b/lib/sqlalchemy/sql.py index 3a0e32de13..cf67abbe50 100644 --- a/lib/sqlalchemy/sql.py +++ b/lib/sqlalchemy/sql.py @@ -179,7 +179,25 @@ def text(text, engine=None, *args, **kwargs): When constructing a query from a select(), update(), insert() or delete(), using plain strings for argument values will usually result in text objects being created automatically. Use this function when creating textual clauses outside of other - ClauseElement objects, or optionally wherever plain text is to be used.""" + ClauseElement objects, or optionally wherever plain text is to be used. + + Arguments include: + + text - the text of the SQL statement to be created. use : to specify + bind parameters; they will be compiled to their engine-specific format. + + engine - the engine to be used for this text query. Alternatively, call the + text() method off the engine directly. + + bindparams - a list of bindparam() instances which can be used to define the + types and/or initial values for the bind parameters within the textual statement; + the keynames of the bindparams must match those within the text of the statement. + The types will be used for pre-processing on bind values. + + typemap - a dictionary mapping the names of columns represented in the SELECT + clause of the textual statement to type objects, which will be used to perform + post-processing on columns within the result set (for textual statements that + produce result sets).""" return TextClause(text, engine=engine, *args, **kwargs) def null(): -- 2.47.2