Skip to content

Commit 03a2636

Browse files
committed
add documentation for Cluster.timestamp_generator
1 parent 6285229 commit 03a2636

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

cassandra/cluster.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,17 @@ def default_retry_policy(self, policy):
661661
establishment, options passing, and authentication.
662662
"""
663663

664+
timestamp_generator = None
665+
"""
666+
An object, shared between all sessions created by this cluster instance,
667+
that generates timestamps when client-side timestamp generation is enabled.
668+
By default, each :class:`Cluster` uses a new
669+
:class:`~.MonotonicTimestampGenerator`.
670+
671+
Applications can set this value for custom timestamp behavior. See the
672+
documentation for :meth:`Session.timestamp_generator`.
673+
"""
674+
664675
@property
665676
def schema_metadata_enabled(self):
666677
"""

docs/api/cassandra/cluster.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
.. autoattribute:: token_metadata_enabled
6565
:annotation: = True
6666

67+
.. autoattribute:: timestamp_generator
68+
6769
.. automethod:: connect
6870

6971
.. automethod:: shutdown

0 commit comments

Comments
 (0)