Skip to content

Commit 6c14ee6

Browse files
committed
docs: fix README/index differences, backport fixes
1 parent 4d90874 commit 6c14ee6

3 files changed

Lines changed: 23 additions & 10 deletions

File tree

README.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ DataStax Python Driver for Apache Cassandra
44
.. image:: https://travis-ci.org/datastax/python-driver.png?branch=master
55
:target: https://travis-ci.org/datastax/python-driver
66

7-
A modern, `feature-rich <https://github.com/datastax/python-driver#features>`_ and highly-tunable Python client library for Apache Cassandra (1.2+) and DataStax Enterprise (3.1+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.
7+
A modern, `feature-rich <https://github.com/datastax/python-driver#features>`_ and highly-tunable Python client library for Apache Cassandra (2.1+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.
88

9-
The driver supports Python 2.7, 3.3, and 3.4.
9+
The driver supports Python 2.7, 3.3, 3.4, 3.5, and 3.6.
10+
11+
If you require compatibility with DataStax Enterprise, use the `DataStax Enterprise Python Driver <http://docs.datastax.com/en/developer/python-dse-driver/>`_.
1012

1113
Feedback Requested
1214
------------------
@@ -63,12 +65,9 @@ If you would like to contribute, please feel free to open a pull request.
6365

6466
Getting Help
6567
------------
66-
Your two best options for getting help with the driver are the
68+
Your best options for getting help with the driver are the
6769
`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_
68-
and the IRC channel.
69-
70-
For IRC, use the #datastax-drivers channel on irc.freenode.net. If you don't have an IRC client,
71-
you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers>`_.
70+
and the ``#datastax-drivers`` channel in the `DataStax Academy Slack <https://academy.datastax.com/slack>`_.
7271

7372
License
7473
-------

cassandra/query.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,21 @@ class PreparedStatement(object):
366366
367367
A :class:`.PreparedStatement` should be prepared only once. Re-preparing a statement
368368
may affect performance (as the operation requires a network roundtrip).
369+
370+
|prepared_stmt_head|: Do not use ``*`` in prepared statements if you might
371+
change the schema of the table being queried. The driver and server each
372+
maintain a map between metadata for a schema and statements that were
373+
prepared against that schema. When a user changes a schema, e.g. by adding
374+
or removing a column, the server invalidates its mappings involving that
375+
schema. However, there is currently no way to propagate that invalidation
376+
to drivers. Thus, after a schema change, the driver will incorrectly
377+
interpret the results of ``SELECT *`` queries prepared before the schema
378+
change. This is currently being addressed in `CASSANDRA-10786
379+
<https://issues.apache.org/jira/browse/CASSANDRA-10786>`_.
380+
381+
.. |prepared_stmt_head| raw:: html
382+
383+
<b>A note about <code>*</code> in prepared statements</b>
369384
"""
370385

371386
column_metadata = None #TODO: make this bind_metadata in next major

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A Python client driver for `Apache Cassandra <http://cassandra.apache.org>`_.
44
This driver works exclusively with the Cassandra Query Language v3 (CQL3)
55
and Cassandra's native protocol. Cassandra 2.1+ is supported.
66

7-
The driver supports Python 2.6, 2.7, 3.3, 3.4, 3.5, and 3.6.
7+
The driver supports Python 2.7, 3.3, 3.4, 3.5, and 3.6.
88

99
This driver is open source under the
1010
`Apache v2 License <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
@@ -74,8 +74,7 @@ Visit the :doc:`FAQ section <faq>` in this documentation.
7474

7575
Please send questions to the `mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
7676

77-
Alternatively, you can use IRC. Connect to the #datastax-drivers channel on irc.freenode.net.
78-
If you don't have an IRC client, you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers>`_.
77+
Alternatively, you can use the `#datastax-drivers` channel in the DataStax Acadamy Slack to ask questions in real time.
7978

8079
Reporting Issues
8180
----------------

0 commit comments

Comments
 (0)