<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <h1 class="pudge-member-page-heading"> <tt>SelectResults</tt> </h1> <p class="pudge-member-parent-link"> <small> The SelectResults class is accessible via the <a href="module-sqlobject.sresults.html"> <tt>sqlobject.sresults</tt> </a> module. </small> </p> <div id="pudge-section-nav"> <ul> <li> <a href="#attributes" class="pudge-section-link"> Attributes (1) </a> </li><li> <a href="#methods" class="pudge-section-link"> Methods (26) </a> </li> <li> <a href="sqlobject/sresults.py.html?f=8&l=347#8" class="pudge-section-link"> Source </a> </li> </ul> </div> <div style="clear: left"></div> <hr> <a name="attributes"></a> <h2>Attributes</h2> <div class="pudge-member name"> <a name="throughTo"></a> <h4 class="pudge-member-name"><span class="prefix">a</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#throughTo" class="pudge-obj-link">throughTo</a></tt></h4> <div class="pudge-section rst"> <pre><property object at 0xb54375c></pre> </div> </div> <a name="methods"></a> <h2>Methods</h2> <div class="pudge-member routine alias"> <a name="__sizeof__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__sizeof__" class="pudge-obj-link">__sizeof__</a>(...)</tt> <a href="__builtin__.py.html" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> __sizeof__() -> int size of object in memory, in bytes </p> </div> </div><div class="pudge-member routine alias"> <a name="__format__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__format__" class="pudge-obj-link">__format__</a>(...)</tt> <a href="__builtin__.py.html" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> default object formatter </p> </div> </div><div class="pudge-member routine alias"> <a name="__subclasshook__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__subclasshook__" class="pudge-obj-link">__subclasshook__</a>(...)</tt> <a href="None.html" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Abstract classes can override this to customize issubclass(). </p> <p>This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).</p> </div> </div><div class="pudge-member routine "> <a name="__init__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__init__" class="pudge-obj-link">__init__</a>(self, sourceClass, clause, clauseTables=None, **ops)</tt> <a href="sqlobject/sresults.py.html?f=11&l=43#11" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="queryForSelect"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#queryForSelect" class="pudge-obj-link">queryForSelect</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=44&l=58#44" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="clone"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#clone" class="pudge-obj-link">clone</a>(self, **newOps)</tt> <a href="sqlobject/sresults.py.html?f=91&l=96#91" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="orderBy"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#orderBy" class="pudge-obj-link">orderBy</a>(self, orderBy)</tt> <a href="sqlobject/sresults.py.html?f=97&l=99#97" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="connection"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#connection" class="pudge-obj-link">connection</a>(self, conn)</tt> <a href="sqlobject/sresults.py.html?f=100&l=102#100" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="limit"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#limit" class="pudge-obj-link">limit</a>(self, limit)</tt> <a href="sqlobject/sresults.py.html?f=103&l=105#103" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="lazyColumns"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#lazyColumns" class="pudge-obj-link">lazyColumns</a>(self, value)</tt> <a href="sqlobject/sresults.py.html?f=106&l=108#106" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="reversed"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#reversed" class="pudge-obj-link">reversed</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=109&l=111#109" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="distinct"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#distinct" class="pudge-obj-link">distinct</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=112&l=114#112" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="newClause"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#newClause" class="pudge-obj-link">newClause</a>(self, new_clause)</tt> <a href="sqlobject/sresults.py.html?f=115&l=118#115" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="filter"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#filter" class="pudge-obj-link">filter</a>(self, filter_clause)</tt> <a href="sqlobject/sresults.py.html?f=119&l=127#119" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="__getitem__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__getitem__" class="pudge-obj-link">__getitem__</a>(self, value)</tt> <a href="sqlobject/sresults.py.html?f=128&l=176#128" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="__iter__"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#__iter__" class="pudge-obj-link">__iter__</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=177&l=182#177" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="lazyIter"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#lazyIter" class="pudge-obj-link">lazyIter</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=183&l=190#183" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Returns an iterator that will lazily pull rows out of the database and return SQLObject instances </p> </div> </div><div class="pudge-member routine "> <a name="accumulate"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#accumulate" class="pudge-obj-link">accumulate</a>(self, *expressions)</tt> <a href="sqlobject/sresults.py.html?f=191&l=204#191" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Use accumulate expression(s) to select result using another SQL select through current connection. Return the accumulate result </p> </div> </div><div class="pudge-member routine "> <a name="count"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#count" class="pudge-obj-link">count</a>(self)</tt> <a href="sqlobject/sresults.py.html?f=205&l=225#205" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Counting elements of current select results </p> </div> </div><div class="pudge-member routine "> <a name="accumulateMany"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#accumulateMany" class="pudge-obj-link">accumulateMany</a>(self, *attributes)</tt> <a href="sqlobject/sresults.py.html?f=226&l=245#226" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Making the expressions for count/sum/min/max/avg of a given select result attributes. <cite>attributes</cite> must be a list/tuple of pairs (func_name, attribute); <cite>attribute</cite> can be a column name (like 'a_column') or a dot-q attribute (like Table.q.aColumn) </p> </div> </div><div class="pudge-member routine "> <a name="accumulateOne"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#accumulateOne" class="pudge-obj-link">accumulateOne</a>(self, func_name, attribute)</tt> <a href="sqlobject/sresults.py.html?f=246&l=252#246" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> Making the sum/min/max/avg of a given select result attribute. <cite>attribute</cite> can be a column name (like 'a_column') or a dot-q attribute (like Table.q.aColumn) </p> </div> </div><div class="pudge-member routine "> <a name="sum"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#sum" class="pudge-obj-link">sum</a>(self, attribute)</tt> <a href="sqlobject/sresults.py.html?f=253&l=255#253" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="min"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#min" class="pudge-obj-link">min</a>(self, attribute)</tt> <a href="sqlobject/sresults.py.html?f=256&l=258#256" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="avg"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#avg" class="pudge-obj-link">avg</a>(self, attribute)</tt> <a href="sqlobject/sresults.py.html?f=259&l=261#259" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="max"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#max" class="pudge-obj-link">max</a>(self, attribute)</tt> <a href="sqlobject/sresults.py.html?f=262&l=264#262" title="View Source">...</a> </h4> <div class="pudge-section rst"> </div> </div><div class="pudge-member routine "> <a name="getOne"></a> <h4 class="pudge-member-name"><span class="prefix">f</span> <tt><a href="class-sqlobject.sresults.SelectResults.html#getOne" class="pudge-obj-link">getOne</a>(self, default=<class sqlobject.sqlbuilder.NoDefault at 0xb4ca44c>)</tt> <a href="sqlobject/sresults.py.html?f=265&l=289#265" title="View Source">...</a> </h4> <div class="pudge-section rst"> <p class="pudge-member-blurb"> If a query is expected to only return a single value, using <tt class="docutils literal">.getOne()</tt> will return just that value. </p> <p>If not results are found, <tt class="docutils literal">SQLObjectNotFound</tt> will be raised, unless you pass in a default value (like <tt class="docutils literal">.getOne(None)</tt>).</p> <p>If more than one result is returned, <tt class="docutils literal">SQLObjectIntegrityError</tt> will be raised.</p> </div> </div> <p> <small> See <a href="sqlobject/sresults.py.html?f=8&l=347#8" title="sqlobject/sresults.py:8">the source</a> for more information. </small> </p>