API docs for “vmc.contrib.axiom.store.ItemQuery”

Method	__init__	Create an ItemQuery. This is typically done via `Store.query`.
Method	paginate	Split up the work of gathering a result set into multiple smaller
Method	getColumn	Get an `iaxiom.IQuery` whose results will be values of a single
Method	count	Return the number of results in this query.
Method	deleteFromStore	Delete all the Items which are found by this query.

Inherited from BaseQuery:

Method	cloneQuery	Create a similar-but-not-identical copy of this query with certain
Method	__repr__	Undocumented
Method	explain	A debugging API, exposing SQLite's 'EXPLAIN' statement.
Method	_involvedTables	Return a list of tables involved in this query,
Method	_computeFromClause	Generate the SQL string which follows the "FROM" string and before the
Method	_sqlAndArgs	Undocumented
Method	_runQuery	Undocumented
Method	locateCallSite	Undocumented
Method	_selectStuff	Return a generator which yields the massaged results of this query with
Method	distinct	Call this method if you want to avoid repeated results from a query.
Method	__iter__	Iterate the results of this query.
Method	next	This method is deprecated, a holdover from when queries were iterators,

def paginate(self, pagesize=20):

Split up the work of gathering a result set into multiple smaller 'pages', allowing very large queries to be iterated without blocking for long periods of time.

While simply iterating paginate() is very similar to iterating a query directly, using this method allows the work to obtain the results to be performed on demand, over a series of different transaction.

Parameters	pagesize	the number of results gather in each chunk of work. (This is mostly for testing paginate's implementation.) (type: `int` )
Returns	an iterable which yields all the results of this query.

def _massageData(self, row):

overrides vmc.contrib.axiom.store.BaseQuery._massageData

Convert a row into an Item instance by loading cached items or creating new ones based on query results.

Parameters	row	an n-tuple, where n is the number of columns specified by my item type.
Returns	an instance of the type specified by this query.

def getColumn(self, attributeName, raw=False):

Get an iaxiom.IQuery whose results will be values of a single attribute rather than an Item.

Parameters	attributeName	a `str`, the name of a Python attribute, that describes a column on the Item subclass that this query was specified for.
Returns	an `AttributeQuery` for the column described by the attribute named `attributeName` on the item class that this query's results will be instances of.

def count(self):

from vmc.contrib.axiom.iaxiom.IQuery

Return the number of results in this query.

NOTE: In most cases, this will have to load all of the rows in this query. It is therefore very slow and should generally be considered discouraged. Call with caution!

Class v.c.a.s.ItemQuery(BaseQuery):