Skip to content

Commit becfbe5

Browse files
committed
Docs changes for 3.20
1 parent f2c1211 commit becfbe5

7 files changed

Lines changed: 259 additions & 252 deletions

File tree

cassandra/cluster.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,7 @@ def default_retry_policy(self, policy):
793793
cloud = None
794794
"""
795795
A dict of the cloud configuration. Example::
796+
796797
{
797798
# path to the secure connect bundle
798799
'secure_connect_bundle': '/path/to/secure-connect-dbname.zip'

docs.yaml

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,38 +22,44 @@ sections:
2222
# build extensions like libev
2323
CASS_DRIVER_NO_CYTHON=1 python setup.py build_ext --inplace --force
2424
versions:
25-
- name: '3.19'
26-
ref: ac2471f9
27-
- name: '3.18'
28-
ref: ec36b957
29-
- name: '3.17'
30-
ref: 38e359e1
31-
- name: '3.16'
32-
ref: '3.16.0'
33-
- name: '3.15'
34-
ref: '2ce0bd97'
35-
- name: '3.14'
36-
ref: '9af8bd19'
37-
- name: '3.13'
38-
ref: '3.13.0'
39-
- name: '3.12'
40-
ref: '43b9c995'
41-
- name: '3.11'
42-
ref: '3.11.0'
43-
- name: '3.10'
44-
ref: 64572368
45-
- name: 3.9
46-
ref: 3.9-doc
47-
- name: 3.8
48-
ref: 3.8-doc
49-
- name: 3.7
50-
ref: 3.7-doc
51-
- name: 3.6
52-
ref: 3.6-doc
53-
- name: 3.5
54-
ref: 3.5-doc
25+
- name: '3.20'
26+
ref: '38613962'
27+
# - name: '3.19'
28+
# ref: ac2471f9
29+
# - name: '3.18'
30+
# ref: ec36b957
31+
# - name: '3.17'
32+
# ref: 38e359e1
33+
# - name: '3.16'
34+
# ref: '3.16.0'
35+
# - name: '3.15'
36+
# ref: '2ce0bd97'
37+
# - name: '3.14'
38+
# ref: '9af8bd19'
39+
# - name: '3.13'
40+
# ref: '3.13.0'
41+
# - name: '3.12'
42+
# ref: '43b9c995'
43+
# - name: '3.11'
44+
# ref: '3.11.0'
45+
# - name: '3.10'
46+
# ref: 64572368
47+
# - name: 3.9
48+
# ref: 3.9-doc
49+
# - name: 3.8
50+
# ref: 3.8-doc
51+
# - name: 3.7
52+
# ref: 3.7-doc
53+
# - name: 3.6
54+
# ref: 3.6-doc
55+
# - name: 3.5
56+
# ref: 3.5-doc
5557
redirects:
5658
- \A\/(.*)/\Z: /\1.html
5759
rewrites:
5860
- search: cassandra.apache.org/doc/cql3/CQL.html
5961
replace: cassandra.apache.org/doc/cql3/CQL-3.0.html
62+
- search: http://www.datastax.com/documentation/cql/3.1/
63+
replace: https://docs.datastax.com/en/archived/cql/3.1/
64+
- search: http://www.datastax.com/docs/1.2/cql_cli/cql/BATCH
65+
replace: https://docs.datastax.com/en/dse/6.7/cql/cql/cql_reference/cql_commands/cqlBatch.html

docs/.nav

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ security
99
upgrading
1010
user_defined_types
1111
dates_and_times
12+
cloud
1213
faq
1314
api

docs/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Core Driver
2020
cassandra/concurrent
2121
cassandra/connection
2222
cassandra/util
23+
cassandra/timestamps
2324
cassandra/io/asyncioreactor
2425
cassandra/io/asyncorereactor
2526
cassandra/io/eventletreactor

docs/cloud.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ Apollo Differences
2323
==================
2424
In most circumstances, the client code for interacting with an Apollo cluster will be the same as interacting with any other Cassandra cluster. The exceptions being:
2525

26-
* A cloud configuration must be passed to a :class:`~.Cluster` instance via the `cloud` attribute (as demonstrated above).
27-
* An SSL connection will be established automatically. Manual SSL configuration is not allowed, and using `ssl_context` or `ssl_options` will result in an exception.
28-
* A :class:`~.Cluster`'s `contact_points` attribute should not be used. The cloud config contains all of the necessary contact information.
29-
* If a consistency level is not specified for an execution profile or query, then :attr:`.ConsistencyLevel.LOCAL_QUORUM` will be used as the default.
26+
* A cloud configuration must be passed to a :class:`~.Cluster` instance via the `cloud` attribute (as demonstrated above).
27+
* An SSL connection will be established automatically. Manual SSL configuration is not allowed, and using `ssl_context` or `ssl_options` will result in an exception.
28+
* A :class:`~.Cluster`'s `contact_points` attribute should not be used. The cloud config contains all of the necessary contact information.
29+
* If a consistency level is not specified for an execution profile or query, then :attr:`.ConsistencyLevel.LOCAL_QUORUM` will be used as the default.
30+
3031

3132
Limitations
3233
===========
3334

3435
Event loops
35-
-----------
36-
36+
^^^^^^^^^^^
3737
Twisted and Evenlet aren't supported yet. These event loops are still using the old way to configure
3838
SSL (ssl_options), which is not compatible with the secure connect bundle provided by Apollo.

0 commit comments

Comments
 (0)