Skip to content

Commit b3e395d

Browse files
Merge pull request scylladb#48 from riptano/3.22-docs
Update docs for 3.22 release
2 parents 2ccc9b6 + dff53fb commit b3e395d

File tree

6 files changed

+34
-3
lines changed

6 files changed

+34
-3
lines changed

cassandra/cluster.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,8 @@ def __init__(self, load_balancing_policy=_NOT_SET, retry_policy=None,
426426
427427
See :class:`.ExecutionProfile` for base attributes. Note that if not explicitly set,
428428
the row_factory and graph_options.graph_protocol are resolved during the query execution.
429+
These options will resolve to graph_graphson3_row_factory and GraphProtocol.GRAPHSON_3_0
430+
for the core graph engine (DSE 6.8+), otherwise graph_object_row_factory and GraphProtocol.GRAPHSON_1_0
429431
430432
In addition to default parameters shown in the signature, this profile also defaults ``retry_policy`` to
431433
:class:`cassandra.policies.NeverRetryPolicy`.

docs/api/cassandra/cluster.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@
127127
.. autoattribute:: consistency_level
128128
:annotation: = LOCAL_ONE
129129

130-
.. autoclass:: GraphExecutionProfile (load_balancing_policy=_NOT_SET, retry_policy=None, consistency_level=ConsistencyLevel.LOCAL_ONE, serial_consistency_level=None, request_timeout=30.0, row_factory=<function graph_object_row_factory>, graph_options=None, continuous_paging_options=_NOT_SET)
130+
.. autoclass:: GraphExecutionProfile (load_balancing_policy=_NOT_SET, retry_policy=None, consistency_level=ConsistencyLevel.LOCAL_ONE, serial_consistency_level=None, request_timeout=30.0, row_factory=None, graph_options=None, continuous_paging_options=_NOT_SET)
131131
:members:
132132

133-
.. autoclass:: GraphAnalyticsExecutionProfile (load_balancing_policy=None, retry_policy=None, consistency_level=ConsistencyLevel.LOCAL_ONE, serial_consistency_level=None, request_timeout=3600. * 24. * 7., row_factory=<function graph_object_row_factory>, graph_options=None)
133+
.. autoclass:: GraphAnalyticsExecutionProfile (load_balancing_policy=None, retry_policy=None, consistency_level=ConsistencyLevel.LOCAL_ONE, serial_consistency_level=None, request_timeout=3600. * 24. * 7., row_factory=None, graph_options=None)
134134
:members:
135135

136136
.. autodata:: EXEC_PROFILE_DEFAULT

docs/api/cassandra/datastax/graph/fluent/predicates.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,8 @@
77
.. autoclass:: Search
88
:members:
99

10+
.. autoclass:: CqlCollection
11+
:members:
12+
1013
.. autoclass:: Geo
1114
:members:

docs/api/cassandra/datastax/graph/index.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@
1111

1212
.. autofunction:: graph_object_row_factory
1313

14+
.. autofunction:: graph_graphson2_row_factory
15+
16+
.. autofunction:: graph_graphson3_row_factory
17+
18+
.. function:: to_int(value)
19+
20+
Wraps a value to be explicitly serialized as a graphson Int.
21+
22+
.. function:: to_bigint(value)
23+
24+
Wraps a value to be explicitly serialized as a graphson Bigint.
25+
26+
.. function:: to_smallint(value)
27+
28+
Wraps a value to be explicitly serialized as a graphson Smallint.
29+
30+
.. function:: to_float(value)
31+
32+
Wraps a value to be explicitly serialized as a graphson Float.
33+
34+
.. function:: to_double(value)
35+
36+
Wraps a value to be explicitly serialized as a graphson Double.
37+
1438
.. autoclass:: GraphProtocol
1539
:members:
1640

docs/api/cassandra/metadata.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ Schemas
3737
.. autoclass:: TableMetadataV3 ()
3838
:members:
3939

40+
.. autoclass:: TableMetadataDSE68 ()
41+
:members:
42+
4043
.. autoclass:: ColumnMetadata ()
4144
:members:
4245

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Contents
8989
graph
9090
classic_graph
9191
graph_fluent
92-
dse_auth
9392
dates_and_times
9493
cloud
9594
faq

0 commit comments

Comments
 (0)