Merge pull request #660 from datastax/624
some docs update for documentor
This commit is contained in:
		@@ -7,6 +7,7 @@ Releasing
 | 
			
		||||
  * For beta releases, use a version like ``(2, 1, '0b1')``
 | 
			
		||||
  * For release candidates, use a version like ``(2, 1, '0rc1')``
 | 
			
		||||
  * When in doubt, follow PEP 440 versioning
 | 
			
		||||
* Update the version in ``docs.yaml``
 | 
			
		||||
 | 
			
		||||
* Commit the changelog and version changes
 | 
			
		||||
* Tag the release.  For example: ``git tag -a 1.0.0 -m 'version 1.0.0'``
 | 
			
		||||
 
 | 
			
		||||
@@ -699,7 +699,7 @@ class BaseCollectionColumn(Column):
 | 
			
		||||
    """
 | 
			
		||||
    Base Container type for collection-like columns.
 | 
			
		||||
 | 
			
		||||
    https://cassandra.apache.org/doc/cql3/CQL.html#collections
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL-3.0.html#collections
 | 
			
		||||
    """
 | 
			
		||||
    def __init__(self, types, **kwargs):
 | 
			
		||||
        """
 | 
			
		||||
 
 | 
			
		||||
@@ -86,7 +86,7 @@ class MinTimeUUID(TimeUUIDQueryFunction):
 | 
			
		||||
    """
 | 
			
		||||
    return a fake timeuuid corresponding to the smallest possible timeuuid for the given timestamp
 | 
			
		||||
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL.html#timeuuidFun
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL-3.0.html#timeuuidFun
 | 
			
		||||
    """
 | 
			
		||||
    format_string = 'MinTimeUUID(%({0})s)'
 | 
			
		||||
 | 
			
		||||
@@ -95,7 +95,7 @@ class MaxTimeUUID(TimeUUIDQueryFunction):
 | 
			
		||||
    """
 | 
			
		||||
    return a fake timeuuid corresponding to the largest possible timeuuid for the given timestamp
 | 
			
		||||
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL.html#timeuuidFun
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL-3.0.html#timeuuidFun
 | 
			
		||||
    """
 | 
			
		||||
    format_string = 'MaxTimeUUID(%({0})s)'
 | 
			
		||||
 | 
			
		||||
@@ -104,7 +104,7 @@ class Token(BaseQueryFunction):
 | 
			
		||||
    """
 | 
			
		||||
    compute the token for a given partition key
 | 
			
		||||
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL.html#tokenFun
 | 
			
		||||
    http://cassandra.apache.org/doc/cql3/CQL-3.0.html#tokenFun
 | 
			
		||||
    """
 | 
			
		||||
    def __init__(self, *values):
 | 
			
		||||
        if len(values) == 1 and isinstance(values[0], (list, tuple)):
 | 
			
		||||
 
 | 
			
		||||
@@ -135,7 +135,7 @@ class BatchQuery(object):
 | 
			
		||||
    """
 | 
			
		||||
    Handles the batching of queries
 | 
			
		||||
 | 
			
		||||
    http://www.datastax.com/docs/1.2/cql_cli/cql/BATCH
 | 
			
		||||
    http://docs.datastax.com/en/cql/3.0/cql/cql_reference/batch_r.html
 | 
			
		||||
 | 
			
		||||
    See :doc:`/cqlengine/batches` for more details.
 | 
			
		||||
    """
 | 
			
		||||
 
 | 
			
		||||
@@ -224,7 +224,7 @@ Token Function
 | 
			
		||||
    Token functon may be used only on special, virtual column pk__token, representing token of partition key (it also works for composite partition keys).
 | 
			
		||||
    Cassandra orders returned items by value of partition key token, so using cqlengine.Token we can easy paginate through all table rows.
 | 
			
		||||
 | 
			
		||||
    See http://cassandra.apache.org/doc/cql3/CQL.html#tokenFun
 | 
			
		||||
    See http://cassandra.apache.org/doc/cql3/CQL-3.0.html#tokenFun
 | 
			
		||||
 | 
			
		||||
    *Example*
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -250,7 +250,7 @@ See :ref:`query-paging` for full details.
 | 
			
		||||
Protocol-Level Batch Statements
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
With version 1 of the native protocol, batching of statements required
 | 
			
		||||
using a `BATCH cql query <http://cassandra.apache.org/doc/cql3/CQL.html#batchStmt>`_.
 | 
			
		||||
using a `BATCH cql query <http://cassandra.apache.org/doc/cql3/CQL-3.0.html#batchStmt>`_.
 | 
			
		||||
With version 2 of the native protocol, you can now batch statements at
 | 
			
		||||
the protocol level. This allows you to use many different prepared
 | 
			
		||||
statements within a single batch.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user