Package couchdbkit :: Package schema :: Module base :: Class QueryMixin
[hide private]
[frames] | no frames]

Class QueryMixin

source code

object --+
         |
        QueryMixin
Known Subclasses:

Mixin that add query methods

Instance Methods [hide private]

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
__view(cl, view_type=None, data=None, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
The default wrapper can distinguish between multiple Document classes and wrap the result accordingly.
source code
 
view(cls, view_name, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
Get documents associated view a view.
source code
 
temp_view(cls, design, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
Slow view.
source code
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__view(cl, view_type=None, data=None, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
Class Method

source code 

The default wrapper can distinguish between multiple Document classes and wrap the result accordingly. The known classes are passed either as classes={<doc_type>: <Document-class>, ...} or classes=[<Document-class1>, <Document-class2>, ...]

view(cls, view_name, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
Class Method

source code 

Get documents associated view a view. Results of view are automatically wrapped to Document object.

Returns:
:class:`simplecouchdb.core.ViewResults` instance. All results are wrapped to current document instance.

temp_view(cls, design, wrapper=None, dynamic_properties=True, wrap_doc=True, classes=None, **params)
Class Method

source code 

Slow view. Like in view method, results are automatically wrapped to Document object.

Returns:
Like view, return a :class:`simplecouchdb.core.ViewResults` instance. All results are wrapped to current document instance.