Skip to content

Commit b735a3b

Browse files
committed
minor docs change for 3.7.0
1 parent b6ae82a commit b735a3b

6 files changed

Lines changed: 32 additions & 6 deletions

File tree

‎_modules/cassandra/policies.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -953,11 +953,11 @@ <h1>Source code for cassandra.policies</h1><div class="highlight"><pre>
953953
<span class="k">return</span> <span class="n">addr</span></div>
954954

955955

956-
<span class="k">class</span> <span class="nc">EC2MultiRegionTranslator</span><span class="p">(</span><span class="n">AddressTranslator</span><span class="p">):</span>
956+
<div class="viewcode-block" id="EC2MultiRegionTranslator"><a class="viewcode-back" href="../../api/cassandra/policies.html#cassandra.cluster.EC2MultiRegionTranslator">[docs]</a><span class="k">class</span> <span class="nc">EC2MultiRegionTranslator</span><span class="p">(</span><span class="n">AddressTranslator</span><span class="p">):</span>
957957
<span class="sd">&quot;&quot;&quot;</span>
958958
<span class="sd"> Resolves private ips of the hosts in the same datacenter as the client, and public ips of hosts in other datacenters.</span>
959959
<span class="sd"> &quot;&quot;&quot;</span>
960-
<span class="k">def</span> <span class="nf">translate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span>
960+
<div class="viewcode-block" id="EC2MultiRegionTranslator.translate"><a class="viewcode-back" href="../../api/cassandra/policies.html#cassandra.cluster.EC2MultiRegionTranslator.translate">[docs]</a> <span class="k">def</span> <span class="nf">translate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span>
961961
<span class="sd">&quot;&quot;&quot;</span>
962962
<span class="sd"> Reverse DNS the public broadcast_address, then lookup that hostname to get the AWS-resolved IP, which</span>
963963
<span class="sd"> will point to the private IP address within the same datacenter.</span>
@@ -970,7 +970,7 @@ <h1>Source code for cassandra.policies</h1><div class="highlight"><pre>
970970
<span class="k">return</span> <span class="n">a</span><span class="p">[</span><span class="mi">4</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
971971
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
972972
<span class="k">pass</span>
973-
<span class="k">return</span> <span class="n">addr</span>
973+
<span class="k">return</span> <span class="n">addr</span></div></div>
974974

975975

976976
<div class="viewcode-block" id="SpeculativeExecutionPolicy"><a class="viewcode-back" href="../../api/cassandra/policies.html#cassandra.cluster.SpeculativeExecutionPolicy">[docs]</a><span class="k">class</span> <span class="nc">SpeculativeExecutionPolicy</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

‎_sources/api/cassandra/policies.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ Translating Server Node Addresses
3333
.. autoclass:: IdentityTranslator
3434
:members:
3535

36+
.. autoclass:: EC2MultiRegionTranslator
37+
:members:
38+
3639
Marking Hosts Up or Down
3740
------------------------
3841

‎api/cassandra/policies.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,19 @@ <h2>Translating Server Node Addresses<a class="headerlink" href="#translating-se
275275
<dd><p>Returns the endpoint with no translation</p>
276276
</dd></dl>
277277

278+
<dl class="class">
279+
<dt id="cassandra.policies.EC2MultiRegionTranslator">
280+
<em class="property">class </em><code class="descclassname">cassandra.policies.</code><code class="descname">EC2MultiRegionTranslator</code><a class="reference internal" href="../../_modules/cassandra/policies.html#EC2MultiRegionTranslator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cassandra.policies.EC2MultiRegionTranslator" title="Permalink to this definition"></a></dt>
281+
<dd><p>Resolves private ips of the hosts in the same datacenter as the client, and public ips of hosts in other datacenters.</p>
282+
<dl class="method">
283+
<dt id="cassandra.policies.EC2MultiRegionTranslator.translate">
284+
<code class="descname">translate</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/cassandra/policies.html#EC2MultiRegionTranslator.translate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cassandra.policies.EC2MultiRegionTranslator.translate" title="Permalink to this definition"></a></dt>
285+
<dd><p>Reverse DNS the public broadcast_address, then lookup that hostname to get the AWS-resolved IP, which
286+
will point to the private IP address within the same datacenter.</p>
287+
</dd></dl>
288+
289+
</dd></dl>
290+
278291
</div>
279292
<div class="section" id="marking-hosts-up-or-down">
280293
<h2>Marking Hosts Up or Down<a class="headerlink" href="#marking-hosts-up-or-down" title="Permalink to this headline"></a></h2>

‎genindex.html‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,6 +1016,10 @@ <h2 id="E">E</h2>
10161016
</dt>
10171017

10181018

1019+
<dt><a href="api/cassandra/policies.html#cassandra.policies.EC2MultiRegionTranslator">EC2MultiRegionTranslator (class in cassandra.policies)</a>
1020+
</dt>
1021+
1022+
10191023
<dt><a href="api/cassandra/protocol.html#cassandra.protocol._ProtocolHandler.encode_message">encode_message() (cassandra.protocol._ProtocolHandler class method)</a>
10201024
</dt>
10211025

@@ -1053,6 +1057,8 @@ <h2 id="E">E</h2>
10531057
<dt><a href="api/cassandra/cluster.html#cassandra.cluster.EXEC_PROFILE_DEFAULT">EXEC_PROFILE_DEFAULT (in module cassandra.cluster)</a>
10541058
</dt>
10551059

1060+
</dl></td>
1061+
<td style="width: 33%" valign="top"><dl>
10561062

10571063
<dt><a href="api/cassandra/cluster.html#cassandra.cluster.Session.execute">execute() (cassandra.cluster.Session method)</a>
10581064
</dt>
@@ -1063,8 +1069,6 @@ <h2 id="E">E</h2>
10631069
</dt>
10641070

10651071
</dl></dd>
1066-
</dl></td>
1067-
<td style="width: 33%" valign="top"><dl>
10681072

10691073
<dt><a href="api/cassandra/cluster.html#cassandra.cluster.Session.execute_async">execute_async() (cassandra.cluster.Session method)</a>
10701074
</dt>
@@ -2477,6 +2481,12 @@ <h2 id="T">T</h2>
24772481
<dt><a href="api/cassandra/policies.html#cassandra.policies.AddressTranslator.translate">translate() (cassandra.policies.AddressTranslator method)</a>
24782482
</dt>
24792483

2484+
<dd><dl>
2485+
2486+
<dt><a href="api/cassandra/policies.html#cassandra.policies.EC2MultiRegionTranslator.translate">(cassandra.policies.EC2MultiRegionTranslator method)</a>
2487+
</dt>
2488+
2489+
</dl></dd>
24802490

24812491
<dt><a href="api/cassandra/metadata.html#cassandra.metadata.TableMetadata.triggers">triggers (cassandra.metadata.TableMetadata attribute)</a>
24822492
</dt>

‎objects.inv‎

19 Bytes
Binary file not shown.

‎searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)