openstack/deb-python-cassandra-driver
Code Issues Proposed changes

some docs update for documentor

Browse Source
This commit is contained in:
Alan Boudreault
2016-09-02 13:30:36 -04:00
parent 3998a9a2bf
commit dfb5b7c3e2
6 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README-dev.rst
View File

@@ -7,6 +7,7 @@ Releasing
* For beta releases, use a version like ``(2, 1, '0b1')`` * For beta releases, use a version like ``(2, 1, '0b1')``
* For release candidates, use a version like ``(2, 1, '0rc1')`` * For release candidates, use a version like ``(2, 1, '0rc1')``
* When in doubt, follow PEP 440 versioning * When in doubt, follow PEP 440 versioning
* Update the version in ``docs.yaml``
* Commit the changelog and version changes * Commit the changelog and version changes
* Tag the release. For example: ``git tag -a 1.0.0 -m 'version 1.0.0'`` * Tag the release. For example: ``git tag -a 1.0.0 -m 'version 1.0.0'``
@@ -25,7 +26,7 @@ Releasing
* Commit and push * Commit and push
* Update 'cassandra-test' branch to reflect new release * Update 'cassandra-test' branch to reflect new release
* this is typically a matter of merging or rebasing onto master * this is typically a matter of merging or rebasing onto master
* test and push updated branch to origin * test and push updated branch to origin

2
cassandra/cqlengine/columns.py
View File

@@ -699,7 +699,7 @@ class BaseCollectionColumn(Column):
""" """
Base Container type for collection-like columns. 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): def __init__(self, types, **kwargs):
""" """

6
cassandra/cqlengine/functions.py
View File

@@ -86,7 +86,7 @@ class MinTimeUUID(TimeUUIDQueryFunction):
""" """
return a fake timeuuid corresponding to the smallest possible timeuuid for the given timestamp 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)' 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 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)' format_string = 'MaxTimeUUID(%({0})s)'
@@ -104,7 +104,7 @@ class Token(BaseQueryFunction):
""" """
compute the token for a given partition key 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): def __init__(self, *values):
if len(values) == 1 and isinstance(values[0], (list, tuple)): if len(values) == 1 and isinstance(values[0], (list, tuple)):

2
cassandra/cqlengine/query.py
View File

@@ -135,7 +135,7 @@ class BatchQuery(object):
""" """
Handles the batching of queries 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. See :doc:`/cqlengine/batches` for more details.
""" """

2
docs/cqlengine/queryset.rst
View File

@@ -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). 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. 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* *Example*

2
docs/upgrading.rst
View File

@@ -250,7 +250,7 @@ See :ref:`query-paging` for full details.
Protocol-Level Batch Statements Protocol-Level Batch Statements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
With version 1 of the native protocol, batching of statements required 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 With version 2 of the native protocol, you can now batch statements at
the protocol level. This allows you to use many different prepared the protocol level. This allows you to use many different prepared
statements within a single batch. statements within a single batch.