some docs changes

This commit is contained in:
Alan Boudreault
2016-07-29 12:29:31 -04:00
parent 80ff3b785e
commit 7907d96d8c
2 changed files with 5 additions and 10 deletions

View File

@@ -175,11 +175,6 @@ class BatchQuery(object):
self._context_entered = False self._context_entered = False
def add_query(self, query): def add_query(self, query):
"""
Adds a query to the batch.
:param query: The query
"""
if not isinstance(query, BaseCQLStatement): if not isinstance(query, BaseCQLStatement):
raise CQLEngineException('only BaseCQLStatements can be added to a batch query') raise CQLEngineException('only BaseCQLStatements can be added to a batch query')
self.queries.append(query) self.queries.append(query)
@@ -209,9 +204,6 @@ class BatchQuery(object):
self._callbacks.append((fn, args, kwargs)) self._callbacks.append((fn, args, kwargs))
def execute(self): def execute(self):
"""
Executes the batch.
"""
if self._executed and self.warn_multiple_exec: if self._executed and self.warn_multiple_exec:
msg = "Batch executed multiple times." msg = "Batch executed multiple times."
if self._context_entered: if self._context_entered:
@@ -271,7 +263,7 @@ class BatchQuery(object):
class ContextQuery(object): class ContextQuery(object):
""" """
A Context manager to allow a Model to switch context easily. Presently, the context only A Context manager to allow a Model to switch context easily. Presently, the context only
specifies a keyspace for model IO. specifies a keyspace for model IO.
For example: For example:
@@ -289,7 +281,7 @@ class ContextQuery(object):
def __init__(self, model, keyspace=None): def __init__(self, model, keyspace=None):
""" """
:param model: A model :param model: A model. This should be a class type, not an instance.
:param keyspace: (optional) A keyspace name :param keyspace: (optional) A keyspace name
""" """
from cassandra.cqlengine import models from cassandra.cqlengine import models

View File

@@ -57,6 +57,9 @@ The methods here are used to filter, order, and constrain results.
.. autoclass:: BatchQuery .. autoclass:: BatchQuery
:members: :members:
.. automethod:: add_query
.. automethod:: execute
.. autoclass:: ContextQuery .. autoclass:: ContextQuery
.. autoclass:: DoesNotExist .. autoclass:: DoesNotExist