openstack/deb-python-cassandra-driver
Code Issues Proposed changes

Add cluster idle_heartbeat_interval and refresh_schema to docs

Browse Source
This commit is contained in:
Adam Holmberg
2015-01-26 15:37:45 -06:00
parent 98e0e3259e
commit 1f1a66419e
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cassandra/cluster.py
View File

@@ -1077,10 +1077,14 @@ class Cluster(object):
def refresh_schema(self, keyspace=None, table=None, usertype=None, max_schema_agreement_wait=None): def refresh_schema(self, keyspace=None, table=None, usertype=None, max_schema_agreement_wait=None):
""" """
Synchronously refresh the schema metadata. Synchronously refresh the schema metadata.
By default timeout for this operation is governed by :attr:`~.Cluster.max_schema_agreement_wait`
By default, the timeout for this operation is governed by :attr:`~.Cluster.max_schema_agreement_wait`
and :attr:`~.Cluster.control_connection_timeout`. and :attr:`~.Cluster.control_connection_timeout`.
Passing max_schema_agreement_wait here overrides :attr:`~.Cluster.max_schema_agreement_wait`. Passing max_schema_agreement_wait here overrides :attr:`~.Cluster.max_schema_agreement_wait`.
Setting max_schema_agreement_wait <= 0 will bypass schema agreement and refresh schema immediately. Setting max_schema_agreement_wait <= 0 will bypass schema agreement and refresh schema immediately.
An Exception is raised if schema refresh fails for any reason. An Exception is raised if schema refresh fails for any reason.
""" """
if not self.control_connection.refresh_schema(keyspace, table, usertype, max_schema_agreement_wait): if not self.control_connection.refresh_schema(keyspace, table, usertype, max_schema_agreement_wait):

4
docs/api/cassandra/cluster.rst
View File

@@ -39,6 +39,8 @@
.. autoattribute:: control_connection_timeout .. autoattribute:: control_connection_timeout
.. autoattribute:: idle_heartbeat_interval
.. automethod:: connect .. automethod:: connect
.. automethod:: shutdown .. automethod:: shutdown
@@ -57,6 +59,8 @@
.. automethod:: set_max_connections_per_host .. automethod:: set_max_connections_per_host
.. automethod:: refresh_schema
.. autoclass:: Session () .. autoclass:: Session ()
.. autoattribute:: default_timeout .. autoattribute:: default_timeout