[Sqlalchemy-commits] [1531] sqlalchemy/trunk/doc/build: selectresults docs
Brought to you by:
zzzeek
Menu
▾
▴
[Sqlalchemy-commits] [1531] sqlalchemy/trunk/doc/build: selectresults docs
|
From: <co...@sq...> - 2006-05-28 05:53:09
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><style type="text/css"><!-- #msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; } #msg dt { float: left; width: 6em; font-weight: bold; } #msg dt:after { content:':';} #msg dl, #msg dt, #msg ul, #msg li { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; } #msg dl a { font-weight: bold} #msg dl a:link { color:#fc3; } #msg dl a:active { color:#ff0; } #msg dl a:visited { color:#cc6; } h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; } #msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; } #msg ul, pre { overflow: auto; } #patch { width: 100%; } #patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;} #patch .propset h4, #patch .binary h4 {margin:0;} #patch pre {padding:0;line-height:1.2em;margin:0;} #patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;} #patch .propset .diff, #patch .binary .diff {padding:10px 0;} #patch span {display:block;padding:0 10px;} #patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;} #patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;} #patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;} #patch .lines, .info {color:#888;background:#fff;} --></style> <title>[1531] sqlalchemy/trunk/doc/build: selectresults docs</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>1531</dd> <dt>Author</dt> <dd>zzzeek</dd> <dt>Date</dt> <dd>2006-05-28 00:52:52 -0500 (Sun, 28 May 2006)</dd> </dl> <h3>Log Message</h3> <pre>selectresults docs</pre> <h3>Modified Paths</h3> <ul> <li><a href="#sqlalchemytrunkdocbuildcompile_docstringspy">sqlalchemy/trunk/doc/build/compile_docstrings.py</a></li> <li><a href="#sqlalchemytrunkdocbuildcontentpluginstxt">sqlalchemy/trunk/doc/build/content/plugins.txt</a></li> <li><a href="#sqlalchemytrunklibsqlalchemyextselectresultspy">sqlalchemy/trunk/lib/sqlalchemy/ext/selectresults.py</a></li> <li><a href="#sqlalchemytrunklibsqlalchemymodsthreadlocalpy">sqlalchemy/trunk/lib/sqlalchemy/mods/threadlocal.py</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="sqlalchemytrunkdocbuildcompile_docstringspy"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/doc/build/compile_docstrings.py (1530 => 1531)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/doc/build/compile_docstrings.py 2006-05-28 01:01:45 UTC (rev 1530) +++ sqlalchemy/trunk/doc/build/compile_docstrings.py 2006-05-28 05:52:52 UTC (rev 1531) </span><span class="lines">@@ -15,6 +15,7 @@ </span><span class="cx"> import sqlalchemy.ext.proxy as proxy </span><span class="cx"> import sqlalchemy.ext.sessioncontext as sessioncontext </span><span class="cx"> import sqlalchemy.mods.threadlocal as threadlocal </span><ins>+import sqlalchemy.ext.selectresults as selectresults </ins><span class="cx"> </span><span class="cx"> objects = [] </span><span class="cx"> def make_doc(obj, classes=None, functions=None): </span><span class="lines">@@ -22,15 +23,16 @@ </span><span class="cx"> </span><span class="cx"> make_doc(obj=sql, classes=[sql.Engine, sql.AbstractDialect, sql.ClauseParameters, sql.Compiled, sql.ClauseElement, sql.TableClause, sql.ColumnClause]) </span><span class="cx"> make_doc(obj=schema) </span><del>-make_doc(obj=engine, classes=[engine.ComposedSQLEngine, engine.Connection, engine.Transaction, engine.Dialect, engine.ConnectionProvider, engine.ExecutionContext, engine.ResultProxy, engine.RowProxy]) </del><ins>+make_doc(obj=engine, classes=[engine.Connectable, engine.ComposedSQLEngine, engine.Connection, engine.Transaction, engine.Dialect, engine.ConnectionProvider, engine.ExecutionContext, engine.ResultProxy, engine.RowProxy]) </ins><span class="cx"> make_doc(obj=strategies) </span><span class="cx"> make_doc(obj=orm, classes=[orm.Mapper, orm.MapperExtension]) </span><span class="cx"> make_doc(obj=orm.query, classes=[orm.query.Query]) </span><span class="cx"> make_doc(obj=orm.session, classes=[orm.session.Session, orm.session.SessionTransaction]) </span><ins>+make_doc(obj=pool, classes=[pool.DBProxy, pool.Pool, pool.QueuePool, pool.SingletonThreadPool]) </ins><span class="cx"> make_doc(obj=sessioncontext) </span><span class="cx"> make_doc(obj=threadlocal) </span><ins>+make_doc(obj=selectresults) </ins><span class="cx"> make_doc(obj=exceptions) </span><del>-make_doc(obj=pool, classes=[pool.DBProxy, pool.Pool, pool.QueuePool, pool.SingletonThreadPool]) </del><span class="cx"> make_doc(obj=proxy) </span><span class="cx"> </span><span class="cx"> </span></span></pre></div> <a id="sqlalchemytrunkdocbuildcontentpluginstxt"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/doc/build/content/plugins.txt (1530 => 1531)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/doc/build/content/plugins.txt 2006-05-28 01:01:45 UTC (rev 1530) +++ sqlalchemy/trunk/doc/build/content/plugins.txt 2006-05-28 05:52:52 UTC (rev 1531) </span><span class="lines">@@ -292,7 +292,7 @@ </span><span class="cx"> </span><span class="cx"> **Author:** Jonas Borgström </span><span class="cx"> </span><del>-SelectResults gives generator-like behavior to the results returned from the `select` and `select_by` method of `Query`. It supports three modes of operation; per-query, per-mapper, and per-application. </del><ins>+SelectResults gives transformative behavior to the results returned from the `select` and `select_by` method of `Query`. It supports three modes of operation; per-query, per-mapper, and per-application. </ins><span class="cx"> </span><span class="cx"> {python title="SelectResults with a Query Object"} </span><span class="cx"> from sqlalchemy.ext.selectresults import SelectResults </span><span class="lines">@@ -326,3 +326,4 @@ </span><span class="cx"> mapper(MyClass, mytable) </span><span class="cx"> session.query(MyClass).select(mytable.c.column=="something").order_by([mytable.c.column])[2:7] </span><span class="cx"> </span><ins>+For a full listing of methods, see the [generated documentation](rel:docstrings_sqlalchemy.ext.selectresults). </ins><span class="cx">\ No newline at end of file </span></span></pre></div> <a id="sqlalchemytrunklibsqlalchemyextselectresultspy"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/lib/sqlalchemy/ext/selectresults.py (1530 => 1531)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/lib/sqlalchemy/ext/selectresults.py 2006-05-28 01:01:45 UTC (rev 1530) +++ sqlalchemy/trunk/lib/sqlalchemy/ext/selectresults.py 2006-05-28 05:52:52 UTC (rev 1531) </span><span class="lines">@@ -1,9 +1,10 @@ </span><span class="cx"> import sqlalchemy.sql as sql </span><del>- </del><span class="cx"> import sqlalchemy.orm as orm </span><span class="cx"> </span><span class="cx"> </span><span class="cx"> class SelectResultsExt(orm.MapperExtension): </span><ins>+ """a MapperExtension that provides SelectResults functionality for the + results of query.select_by() and query.select()""" </ins><span class="cx"> def select_by(self, query, *args, **params): </span><span class="cx"> return SelectResults(query, query.join_by(*args, **params)) </span><span class="cx"> def select(self, query, arg=None, **kwargs): </span><span class="lines">@@ -13,47 +14,65 @@ </span><span class="cx"> return SelectResults(query, arg, ops=kwargs) </span><span class="cx"> </span><span class="cx"> class SelectResults(object): </span><ins>+ """Builds a query one component at a time via separate method calls, + each call transforming the previous SelectResults instance into a new SelectResults + instance with further limiting criterion added. When interpreted + in an iterator context (such as via calling list(selectresults)), executes the query.""" + </ins><span class="cx"> def __init__(self, query, clause=None, ops={}): </span><ins>+ """constructs a new SelectResults using the given Query object and optional WHERE + clause. ops is an optional dictionary of bind parameter values.""" </ins><span class="cx"> self._query = query </span><span class="cx"> self._clause = clause </span><span class="cx"> self._ops = {} </span><span class="cx"> self._ops.update(ops) </span><span class="cx"> </span><span class="cx"> def count(self): </span><ins>+ """executes the SQL count() function against the SelectResults criterion.""" </ins><span class="cx"> return self._query.count(self._clause) </span><span class="cx"> </span><span class="cx"> def min(self, col): </span><ins>+ """executes the SQL min() function against the given column""" </ins><span class="cx"> return sql.select([sql.func.min(col)], self._clause, **self._ops).scalar() </span><span class="cx"> </span><span class="cx"> def max(self, col): </span><ins>+ """executes the SQL max() function against the given column""" </ins><span class="cx"> return sql.select([sql.func.max(col)], self._clause, **self._ops).scalar() </span><span class="cx"> </span><span class="cx"> def sum(self, col): </span><ins>+ """executes the SQL sum() function against the given column""" </ins><span class="cx"> return sql.select([sql.func.sum(col)], self._clause, **self._ops).scalar() </span><span class="cx"> </span><span class="cx"> def avg(self, col): </span><ins>+ """executes the SQL avg() function against the given column""" </ins><span class="cx"> return sql.select([sql.func.avg(col)], self._clause, **self._ops).scalar() </span><span class="cx"> </span><span class="cx"> def clone(self): </span><ins>+ """creates a copy of this SelectResults.""" </ins><span class="cx"> return SelectResults(self._query, self._clause, self._ops.copy()) </span><span class="cx"> </span><span class="cx"> def filter(self, clause): </span><ins>+ """applies an additional WHERE clause against the query.""" </ins><span class="cx"> new = self.clone() </span><span class="cx"> new._clause = sql.and_(self._clause, clause) </span><span class="cx"> return new </span><span class="cx"> </span><span class="cx"> def order_by(self, order_by): </span><ins>+ """applies an ORDER BY to the query.""" </ins><span class="cx"> new = self.clone() </span><span class="cx"> new._ops['order_by'] = order_by </span><span class="cx"> return new </span><span class="cx"> </span><span class="cx"> def limit(self, limit): </span><ins>+ """applies a LIMIT to the query.""" </ins><span class="cx"> return self[:limit] </span><span class="cx"> </span><span class="cx"> def offset(self, offset): </span><ins>+ """applies an OFFSET to the query.""" </ins><span class="cx"> return self[offset:] </span><span class="cx"> </span><span class="cx"> def list(self): </span><ins>+ """returns the results represented by this SelectResults as a list. this results in an execution of the underlying query.""" </ins><span class="cx"> return list(self) </span><span class="cx"> </span><span class="cx"> def __getitem__(self, item): </span></span></pre></div> <a id="sqlalchemytrunklibsqlalchemymodsthreadlocalpy"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/lib/sqlalchemy/mods/threadlocal.py (1530 => 1531)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/lib/sqlalchemy/mods/threadlocal.py 2006-05-28 01:01:45 UTC (rev 1530) +++ sqlalchemy/trunk/lib/sqlalchemy/mods/threadlocal.py 2006-05-28 05:52:52 UTC (rev 1531) </span><span class="lines">@@ -20,6 +20,8 @@ </span><span class="cx"> while this mod is installed will reference this global context when creating new mapped object instances. </span><span class="cx"> """ </span><span class="cx"> </span><ins>+__all__ = ['Objectstore', 'assign_mapper'] + </ins><span class="cx"> class Objectstore(SessionContext): </span><span class="cx"> def __getattr__(self, key): </span><span class="cx"> return getattr(self.current, key) </span></span></pre> </div> </div> </body> </html> |
