Skip to content

Commit 11278b2

Browse files
aholmbergaholmberg
committed
update docs
1 parent f3eb650 commit 11278b2

80 files changed

Lines changed: 2931 additions & 2331 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_modules/cassandra.html‎

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>cassandra &mdash; Cassandra Driver 2.7.2 documentation</title>
9+
<title>cassandra &mdash; Cassandra Driver 3.0.0 documentation</title>
1010

1111
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
1212
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
1313

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: '../',
17-
VERSION: '2.7.2',
17+
VERSION: '3.0.0',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323
<script type="text/javascript" src="../_static/jquery.js"></script>
2424
<script type="text/javascript" src="../_static/underscore.js"></script>
2525
<script type="text/javascript" src="../_static/doctools.js"></script>
26-
<link rel="top" title="Cassandra Driver 2.7.2 documentation" href="../index.html" />
26+
<link rel="top" title="Cassandra Driver 3.0.0 documentation" href="../index.html" />
2727
<link rel="up" title="Module code" href="index.html" />
2828
</head>
2929
<body role="document">
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../index.html">Cassandra Driver 2.7.2 documentation</a> &raquo;</li>
39+
<li class="nav-item nav-item-0"><a href="../index.html">Cassandra Driver 3.0.0 documentation</a> &raquo;</li>
4040
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> &raquo;</li>
4141
</ul>
4242
</div>
@@ -89,7 +89,7 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
8989
<span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">&#39;cassandra&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">NullHandler</span><span class="p">())</span>
9090

9191

92-
<span class="n">__version_info__</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
92+
<span class="n">__version_info__</span> <span class="o">=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
9393
<span class="n">__version__</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">__version_info__</span><span class="p">))</span>
9494

9595

@@ -192,11 +192,25 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
192192
<span class="k">return</span> <span class="n">ConsistencyLevel</span><span class="o">.</span><span class="n">value_to_name</span><span class="p">[</span><span class="n">value</span><span class="p">]</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="k">else</span> <span class="s">&quot;Not Set&quot;</span>
193193

194194

195+
<span class="k">class</span> <span class="nc">SchemaChangeType</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
196+
<span class="n">DROPPED</span> <span class="o">=</span> <span class="s">&#39;DROPPED&#39;</span>
197+
<span class="n">CREATED</span> <span class="o">=</span> <span class="s">&#39;CREATED&#39;</span>
198+
<span class="n">UPDATED</span> <span class="o">=</span> <span class="s">&#39;UPDATED&#39;</span>
199+
200+
201+
<span class="k">class</span> <span class="nc">SchemaTargetType</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
202+
<span class="n">KEYSPACE</span> <span class="o">=</span> <span class="s">&#39;KEYSPACE&#39;</span>
203+
<span class="n">TABLE</span> <span class="o">=</span> <span class="s">&#39;TABLE&#39;</span>
204+
<span class="n">TYPE</span> <span class="o">=</span> <span class="s">&#39;TYPE&#39;</span>
205+
<span class="n">FUNCTION</span> <span class="o">=</span> <span class="s">&#39;FUNCTION&#39;</span>
206+
<span class="n">AGGREGATE</span> <span class="o">=</span> <span class="s">&#39;AGGREGATE&#39;</span>
207+
208+
195209
<span class="k">class</span> <span class="nc">SignatureDescriptor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
196210

197-
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">type_signature</span><span class="p">):</span>
211+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">argument_types</span><span class="p">):</span>
198212
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
199-
<span class="bp">self</span><span class="o">.</span><span class="n">type_signature</span> <span class="o">=</span> <span class="n">type_signature</span>
213+
<span class="bp">self</span><span class="o">.</span><span class="n">argument_types</span> <span class="o">=</span> <span class="n">argument_types</span>
200214

201215
<span class="nd">@property</span>
202216
<span class="k">def</span> <span class="nf">signature</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -205,11 +219,14 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
205219

206220
<span class="sd"> can be used to uniquely identify overloaded function names within a keyspace</span>
207221
<span class="sd"> &quot;&quot;&quot;</span>
208-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_signature</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">type_signature</span><span class="p">)</span>
222+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_signature</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">argument_types</span><span class="p">)</span>
209223

210224
<span class="nd">@staticmethod</span>
211-
<span class="k">def</span> <span class="nf">format_signature</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">type_signature</span><span class="p">):</span>
212-
<span class="k">return</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">type_signature</span><span class="p">))</span>
225+
<span class="k">def</span> <span class="nf">format_signature</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">argument_types</span><span class="p">):</span>
226+
<span class="k">return</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">argument_types</span><span class="p">))</span>
227+
228+
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
229+
<span class="k">return</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">argument_types</span><span class="p">)</span>
213230

214231

215232
<div class="viewcode-block" id="UserFunctionDescriptor"><a class="viewcode-back" href="../api/cassandra.html#cassandra.UserFunctionDescriptor">[docs]</a><span class="k">class</span> <span class="nc">UserFunctionDescriptor</span><span class="p">(</span><span class="n">SignatureDescriptor</span><span class="p">):</span>
@@ -222,7 +239,7 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
222239
<span class="sd"> name of the function</span>
223240
<span class="sd"> &quot;&quot;&quot;</span>
224241

225-
<span class="n">type_signature</span> <span class="o">=</span> <span class="bp">None</span>
242+
<span class="n">argument_types</span> <span class="o">=</span> <span class="bp">None</span>
226243
<span class="sd">&quot;&quot;&quot;</span>
227244
<span class="sd"> Ordered list of CQL argument type names comprising the type signature</span>
228245
<span class="sd"> &quot;&quot;&quot;</span>
@@ -238,7 +255,7 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
238255
<span class="sd"> name of the aggregate</span>
239256
<span class="sd"> &quot;&quot;&quot;</span>
240257

241-
<span class="n">type_signature</span> <span class="o">=</span> <span class="bp">None</span>
258+
<span class="n">argument_types</span> <span class="o">=</span> <span class="bp">None</span>
242259
<span class="sd">&quot;&quot;&quot;</span>
243260
<span class="sd"> Ordered list of CQL argument type names comprising the type signature</span>
244261
<span class="sd"> &quot;&quot;&quot;</span>
@@ -533,7 +550,7 @@ <h3>Navigation</h3>
533550
<li class="right" >
534551
<a href="../py-modindex.html" title="Python Module Index"
535552
>modules</a> |</li>
536-
<li class="nav-item nav-item-0"><a href="../index.html">Cassandra Driver 2.7.2 documentation</a> &raquo;</li>
553+
<li class="nav-item nav-item-0"><a href="../index.html">Cassandra Driver 3.0.0 documentation</a> &raquo;</li>
537554
<li class="nav-item nav-item-1"><a href="index.html" >Module code</a> &raquo;</li>
538555
</ul>
539556
</div>

‎_modules/cassandra/auth.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>cassandra.auth &mdash; Cassandra Driver 2.7.2 documentation</title>
9+
<title>cassandra.auth &mdash; Cassandra Driver 3.0.0 documentation</title>
1010

1111
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
1212
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1313

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: '../../',
17-
VERSION: '2.7.2',
17+
VERSION: '3.0.0',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323
<script type="text/javascript" src="../../_static/jquery.js"></script>
2424
<script type="text/javascript" src="../../_static/underscore.js"></script>
2525
<script type="text/javascript" src="../../_static/doctools.js"></script>
26-
<link rel="top" title="Cassandra Driver 2.7.2 documentation" href="../../index.html" />
26+
<link rel="top" title="Cassandra Driver 3.0.0 documentation" href="../../index.html" />
2727
<link rel="up" title="cassandra" href="../cassandra.html" />
2828
</head>
2929
<body role="document">
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../index.html">Cassandra Driver 2.7.2 documentation</a> &raquo;</li>
39+
<li class="nav-item nav-item-0"><a href="../../index.html">Cassandra Driver 3.0.0 documentation</a> &raquo;</li>
4040
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &raquo;</li>
4141
<li class="nav-item nav-item-2"><a href="../cassandra.html" accesskey="U">cassandra</a> &raquo;</li>
4242
</ul>
@@ -261,7 +261,7 @@ <h3>Navigation</h3>
261261
<li class="right" >
262262
<a href="../../py-modindex.html" title="Python Module Index"
263263
>modules</a> |</li>
264-
<li class="nav-item nav-item-0"><a href="../../index.html">Cassandra Driver 2.7.2 documentation</a> &raquo;</li>
264+
<li class="nav-item nav-item-0"><a href="../../index.html">Cassandra Driver 3.0.0 documentation</a> &raquo;</li>
265265
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &raquo;</li>
266266
<li class="nav-item nav-item-2"><a href="../cassandra.html" >cassandra</a> &raquo;</li>
267267
</ul>

0 commit comments

Comments
 (0)