Merge branch 'master' into ngdg_master_ft

Author: aboudreault

CHANGELOG.rst

@@ -1,10 +1,11 @@
 3.22.0
 ======
-Unreleased
+UNRELEASED
 
 Features
 --------
 
+* Add all() function to the ResultSet API (PYTHON-1203)
 * Parse new schema metadata in NGDG and generate table edges CQL syntax (PYTHON-996)
 * Add GraphSON3 support (PYTHON-788)
 * Use GraphSON3 as default for Native graphs (PYTHON-1004)
@@ -25,25 +26,23 @@ Features
 
 3.21.0
 ======
-Unreleased
+January 15, 2020
 
 Features
 --------
+* Unified driver: merge core and DSE drivers into a single package (PYTHON-1130)
+* Add Python 3.8 support (PYTHON-1189)
 * Allow passing ssl context for Twisted (PYTHON-1161)
-* ssl context and cloud support for Eventlet (PYTHON-1162)
+* Ssl context and cloud support for Eventlet (PYTHON-1162)
 * Cloud Twisted support (PYTHON-1163)
 * Add additional_write_policy and read_repair to system schema parsing (PYTHON-1048)
-* Handle prepared id mismatch when repreparing on the fly (PYTHON-1124)
-* Remove *read_repair_chance table options (PYTHON-1140)
 * Flexible version parsing (PYTHON-1174)
 * Support NULL in collection deserializer (PYTHON-1123)
-* Avoid warnings about unspecified load balancing policy when connecting to a cloud cluster (PYTHON-1177)
-* Add Python 3.8 support (PYTHON-1189)
-* Add new DSE CQL keywords (PYTHON-1122)
 * [GRAPH] Ability to execute Fluent Graph queries asynchronously (PYTHON-1129)
 
 Bug Fixes
 ---------
+* Handle prepared id mismatch when repreparing on the fly (PYTHON-1124)
 * re-raising the CQLEngineException will fail on Python 3 (PYTHON-1166)
 * asyncio message chunks can be processed discontinuously (PYTHON-1185)
 * Reconnect attempts persist after downed node removed from peers (PYTHON-1181)
@@ -55,6 +54,10 @@ Others
 ------
 * The driver has a new dependency: geomet. It comes from the dse-driver unification and
   is used to support DSE geo types.
+* Remove *read_repair_chance table options (PYTHON-1140)
+* Avoid warnings about unspecified load balancing policy when connecting to a cloud cluster (PYTHON-1177)
+* Add new DSE CQL keywords (PYTHON-1122)
+* Publish binary wheel distributions (PYTHON-1013)
 
 Deprecations
 ------------

cassandra/__init__.py

@@ -22,7 +22,7 @@ def emit(self, record):
 
 logging.getLogger('cassandra').addHandler(NullHandler())
 
-__version_info__ = (3, '21a1+20191210')
+__version_info__ = (3, 21, 0, 'post0+20200123')
 __version__ = '.'.join(map(str, __version_info__))
 
 

cassandra/cluster.py

@@ -2543,6 +2543,7 @@ def __init__(self, cluster, hosts, keyspace=None):
                 msg += " using keyspace '%s'" % self.keyspace
             raise NoHostAvailable(msg, [h.address for h in hosts])
 
+        self.session_id = uuid.uuid4()
         self._graph_paging_available = self._check_graph_paging_available()
 
         cc_host = self.cluster.get_control_connection_host()
@@ -2558,7 +2559,6 @@ def __init__(self, cluster, hosts, keyspace=None):
                           'not supported by server version {v} on '
                           'ControlConnection host {c}'.format(v=cc_host.release_version, c=cc_host))
 
-        self.session_id = uuid.uuid4()
         log.debug('Started Session with client_id {} and session_id {}'.format(self.cluster.client_id,
                                                                                self.session_id))
 
@@ -5026,6 +5026,15 @@ def current_rows(self):
         """
         return self._current_rows or []
 
+    def all(self):
+        """
+        Returns all the remaining rows as a list. This is basically
+        a convenient shortcut to `list(result_set)`.
+
+        This function is not recommended for queries that return a large number of elements.
+        """
+        return list(self)
+
     def one(self):
         """
         Return a single row of the results or None if empty. This is basically

docs.yaml

@@ -1,5 +1,5 @@
-title: DataStax Python Driver for Apache Cassandra
-summary: DataStax Python Driver for Apache Cassandra Documentation
+title: DataStax Python Driver
+summary: DataStax Python Driver for Apache Cassandra®
 output: docs/_build/
 swiftype_drivers: pythondrivers
 checks:
@@ -13,7 +13,7 @@ sections:
     directory: docs
     virtualenv_init: |
       set -x
-      CASS_DRIVER_NO_CYTHON=1 pip install -r test-requirements.txt
+      CASS_DRIVER_NO_CYTHON=1 pip install -r test-datastax-requirements.txt
       # for newer versions this is redundant, but in older versions we need to
       # install, e.g., the cassandra driver, and those versions don't specify
       # the cassandra driver version in requirements files
@@ -22,6 +22,8 @@ sections:
       # build extensions like libev
       CASS_DRIVER_NO_CYTHON=1 python setup.py build_ext --inplace --force
 versions:
+  - name: '3.21'
+    ref: 5589d96b
   - name: '3.20'
     ref: d30d166f
   - name: '3.19'

docs/getting_started.rst

@@ -40,14 +40,35 @@ behavior in some other way, this is the place to do it:
 
 .. code-block:: python
 
-    from cassandra.cluster import Cluster, ExecutionProfile, EXEC_PROFILE_DEFAULT
-    from cassandra.query import tuple_factory
+    from cassandra.cluster import Cluster
+    cluster = Cluster(['192.168.0.1', '192.168.0.2'], port=..., ssl_context=...)
 
-    profile = ExecutionProfile(row_factory=tuple_factory)
-    cluster = Cluster(execution_profiles={EXEC_PROFILE_DEFAULT: profile})
+Instantiating a :class:`~.Cluster` does not actually connect us to any nodes.
+To establish connections and begin executing queries we need a
+:class:`~.Session`, which is created by calling :meth:`.Cluster.connect()`:
+
+.. code-block:: python
+
+    cluster = Cluster()
     session = cluster.connect()
 
-    print(session.execute("SELECT release_version FROM system.local").one())
+The :meth:`~.Cluster.connect()` method takes an optional ``keyspace`` argument
+which sets the default keyspace for all queries made through that :class:`~.Session`:
+
+.. code-block:: python
+
+    cluster = Cluster()
+    session = cluster.connect('mykeyspace')
+
+
+You can always change a Session's keyspace using :meth:`~.Session.set_keyspace` or
+by executing a ``USE <keyspace>`` query:
+
+.. code-block:: python
+
+    session.set_keyspace('users')
+    # or you can do this instead
+    session.execute('USE users')
 
 Profiles are passed in by ``execution_profiles`` dict.
 
@@ -83,33 +104,6 @@ Users are free to setup additional profiles to be used by name:
 
 Also, parameters passed to ``Session.execute`` or attached to ``Statement``\s are still honored as before.
 
-Instantiating a :class:`~.Cluster` does not actually connect us to any nodes.
-To establish connections and begin executing queries we need a
-:class:`~.Session`, which is created by calling :meth:`.Cluster.connect()`:
-
-.. code-block:: python
-
-    cluster = Cluster()
-    session = cluster.connect()
-
-The :meth:`~.Cluster.connect()` method takes an optional ``keyspace`` argument
-which sets the default keyspace for all queries made through that :class:`~.Session`:
-
-.. code-block:: python
-
-    cluster = Cluster()
-    session = cluster.connect('mykeyspace')
-
-
-You can always change a Session's keyspace using :meth:`~.Session.set_keyspace` or
-by executing a ``USE <keyspace>`` query:
-
-.. code-block:: python
-
-    session.set_keyspace('users')
-    # or you can do this instead
-    session.execute('USE users')
-
 Executing Queries
 -----------------
 Now that we have a :class:`.Session` we can begin to execute queries. The simplest

docs/graph_fluent.rst

@@ -1,7 +1,7 @@
 DataStax Graph Fluent API
 =========================
 
-The fluent API adds graph features to the core driver::
+The fluent API adds graph features to the core driver:
 
 * A TinkerPop GraphTraversalSource builder to execute traversals on a DSE cluster
 * The ability to execution traversal queries explicitly using execute_graph

docs/index.rst

@@ -1,6 +1,6 @@
-DataStax Python Driver for Apache Cassandra
-===========================================
-A Python client driver for `Apache Cassandra <http://cassandra.apache.org>`_.
+DataStax Python Driver for Apache Cassandra®
+============================================
+A Python client driver for `Apache Cassandra® <http://cassandra.apache.org>`_.
 This driver works exclusively with the Cassandra Query Language v3 (CQL3)
 and Cassandra's native protocol.  Cassandra 2.1+ is supported, including DSE 4.7+.
 

docs/installation.rst

@@ -20,6 +20,54 @@ You can use ``pip install --pre cassandra-driver`` if you need to install a beta
 
 ***Note**: if intending to use optional extensions, install the `dependencies <#optional-non-python-dependencies>`_ first. The driver may need to be reinstalled if dependencies are added after the initial installation.
 
+Verifying your Installation
+---------------------------
+To check if the installation was successful, you can run::
+
+    python -c 'import cassandra; print cassandra.__version__'
+
+It should print something like "3.21.0".
+
+.. _installation-datastax-graph:
+
+(*Optional*) DataStax Graph
+---------------------------
+The driver provides an optional fluent graph API that depends on Apache TinkerPop (gremlinpython). It is
+not installed by default. To be able to build Gremlin traversals, you need to install
+the `graph` requirements::
+
+    pip install cassandra-driver[graph]
+
+See :doc:`graph_fluent` for more details about this API.
+
+(*Optional*) Compression Support
+--------------------------------
+Compression can optionally be used for communication between the driver and
+Cassandra.  There are currently two supported compression algorithms:
+snappy (in Cassandra 1.2+) and LZ4 (only in Cassandra 2.0+).  If either is
+available for the driver and Cassandra also supports it, it will
+be used automatically.
+
+For lz4 support::
+
+    pip install lz4
+
+For snappy support::
+
+    pip install python-snappy
+
+(If using a Debian Linux derivative such as Ubuntu, it may be easier to
+just run ``apt-get install python-snappy``.)
+
+(*Optional*) Metrics Support
+----------------------------
+The driver has built-in support for capturing :attr:`.Cluster.metrics` about
+the queries you run.  However, the ``scales`` library is required to
+support this::
+
+    pip install scales
+
+
 Speeding Up Installation
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -80,53 +128,6 @@ Once the dependencies are installed, simply run::
 
     python setup.py install
 
-Verifying your Installation
----------------------------
-To check if the installation was successful, you can run::
-
-    python -c 'import cassandra; print cassandra.__version__'
-
-It should print something like "2.7.0".
-
-.. _installation-datastax-graph:
-
-(*Optional*) DataStax Graph
----------------------------
-The driver provides an optional fluent graph API that depends on Apache TinkerPop (gremlinpython). It is
-not installed by default. To be able to build Gremlin traversals, you need to install
-the `graph` requirements::
-
-    pip install cassandra-driver[graph]
-
-See :doc:`graph_fluent` for more details about this API.
-
-(*Optional*) Compression Support
---------------------------------
-Compression can optionally be used for communication between the driver and
-Cassandra.  There are currently two supported compression algorithms:
-snappy (in Cassandra 1.2+) and LZ4 (only in Cassandra 2.0+).  If either is
-available for the driver and Cassandra also supports it, it will
-be used automatically.
-
-For lz4 support::
-
-    pip install lz4
-
-For snappy support::
-
-    pip install python-snappy
-
-(If using a Debian Linux derivative such as Ubuntu, it may be easier to
-just run ``apt-get install python-snappy``.)
-
-(*Optional*) Metrics Support
-----------------------------
-The driver has built-in support for capturing :attr:`.Cluster.metrics` about
-the queries you run.  However, the ``scales`` library is required to
-support this::
-
-    pip install scales
-
 
 (*Optional*) Non-python Dependencies
 ------------------------------------

docs/query_paging.rst

@@ -86,10 +86,10 @@ You can resume the pagination when executing a new query by using the :attr:`.Re
     results = session.execute(statement)
 
     # save the paging_state somewhere and return current results
-    session['paging_stage'] = results.paging_state
+    web_session['paging_stage'] = results.paging_state
 
 
     # resume the pagination sometime later...
     statement = SimpleStatement(query, fetch_size=10)
-    ps = session['paging_state']
+    ps = web_session['paging_state']
     results = session.execute(statement, paging_state=ps)

docs/security.rst

@@ -99,7 +99,10 @@ SSL Configuration Examples
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 Here, we'll describe the server and driver configuration necessary to set up SSL to meet various goals, such as the client verifying the server and the server verifying the client. We'll also include Python code demonstrating how to use servers and drivers configured in these ways.
 
-**No identity verification**
+.. _ssl-no-identify-verification:
+
+No identity verification
+++++++++++++++++++++++++
 
 No identity verification at all. Note that this is not recommended for for production deployments.
 
@@ -123,7 +126,10 @@ The driver configuration:
     cluster = Cluster(['127.0.0.1'], ssl_context=ssl_context)
     session = cluster.connect()
 
-**Client verifies server**
+.. _ssl-client-verifies-server:
+
+Client verifies server
+++++++++++++++++++++++
 
 Ensure the python driver verifies the identity of the server.
 
@@ -166,7 +172,10 @@ Additionally, you can also force the driver to verify the `hostname` of the serv
     cluster = Cluster(['127.0.0.1'], ssl_context=ssl_context, ssl_options=ssl_options)
     session = cluster.connect()
 
-**Server verifies client**
+.. _ssl-server-verifies-client:
+
+Server verifies client
+++++++++++++++++++++++
 
 If Cassandra is configured to verify clients (``require_client_auth``), you need to generate
 SSL key and certificate files.
@@ -229,8 +238,10 @@ Finally, you can use that configuration with the following driver code:
     cluster = Cluster(['127.0.0.1'], ssl_context=ssl_context)
     session = cluster.connect()
 
+.. _ssl-server-client-verification:
 
-**Server verifies client and client verifies server**
+Server verifies client and client verifies server
++++++++++++++++++++++++++++++++++++++++++++++++++
 
 See the previous section for examples of Cassandra configuration and preparing
 the client certificates.