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

Mention Cluster.shutdown() in the upgrading guide

Browse Source
This commit is contained in:
Tyler Hobbs
2014-05-28 14:53:52 -05:00
parent 7835e37a36
commit 66a5cca5ab
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/upgrading.rst
View File

@@ -12,7 +12,16 @@ in 2.1 are not yet supported.
Using the v2 Native Protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
By default, the driver will attempt to use version 2 of Cassandra's
native protocol. When working with Cassandra 1.2, you will need to
native protocol. You can explicitly set the protocol version to
2, though:
.. code-block:: python
from cassandra.cluster import Cluster
cluster = Cluster(protocol_version=2)
When working with Cassandra 1.2, you will need to
explicitly set the :attr:`~.Cluster.protocol_version` to 1:
.. code-block:: python
@@ -49,6 +58,13 @@ Lightweight Transactions
to your CQL queries and set the :attr:`~.Statement.serial_consistency_level`
on your statements.
Calling Cluster.shutdown()
^^^^^^^^^^^^^^^^^^^^^^^^^^
In order to fix some issues around garbage collection and unclean interpreter
shutdowns, version 2.0 of the driver requires you to call :meth:`.Cluster.shutdown()`
on your :class:`~.Cluster` objects when you are through with them.
This helps to guarantee a clean shutdown.
Deprecations
^^^^^^^^^^^^
The following functions have moved from ``cassandra.decoder`` to ``cassandra.query``.