Skip to content

Commit

Permalink
docs(*) generate 1.5.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@thibaultcha
thibaultcha committed Sep 26, 2019
1 parent b1e1271 commit a771a1f
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/examples/authentication.lua.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h2>authentication.lua</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/batch.lua.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ <h2>batch.lua</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/intro.lua.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h2>intro.lua</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/pagination.lua.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2>pagination.lua</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/ssl.lua.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ <h2>ssl.lua</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h2>Examples</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/README.md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ <h2>License</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/cassandra.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h1>Module <code>cassandra</code></h1>
<p> Single host module for PUC Lua, LuaJIT and OpenResty.</p>
<h3>Info:</h3>
<ul>
<li><strong>Release</strong>: 1.4.0</li>
<li><strong>Release</strong>: 1.5.0</li>
<li><strong>Author</strong>: thibaultcha</li>
</ul>

Expand Down Expand Up @@ -1123,7 +1123,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
26 changes: 22 additions & 4 deletions docs/modules/resty.cassandra.cluster.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h1>Module <code>resty.cassandra.cluster</code></h1>
<p> Cluster module for OpenResty.</p>
<h3>Info:</h3>
<ul>
<li><strong>Release</strong>: 1.4.0</li>
<li><strong>Release</strong>: 1.5.0</li>
<li><strong>Author</strong>: thibaultcha</li>
</ul>

Expand All @@ -83,7 +83,7 @@ <h2><a href="#Functions">Functions</a></h2>
<td class="summary">Create a new Cluster client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#_Cluster:refresh">_Cluster:refresh ()</a></td>
<td class="name" nowrap><a href="#_Cluster:refresh">_Cluster:refresh (timeout)</a></td>
<td class="summary">Refresh the list of nodes in the cluster.</td>
</tr>
<tr>
Expand Down Expand Up @@ -168,17 +168,31 @@ <h3>Usage:</h3>
</dd>
<dt>
<a name = "_Cluster:refresh"></a>
<strong>_Cluster:refresh ()</strong>
<strong>_Cluster:refresh (timeout)</strong>
</dt>
<dd>
Refresh the list of nodes in the cluster.
Queries one of the specified <code>contact_points</code> to retrieve the list of
available nodes in the cluster, and update the configured policies.
The query will use the timeout threshold specified in the <code>read_timeout</code>
option of the <a href="../modules/resty.cassandra.cluster.html#_Cluster.new">new</a> method.
This method is safe be called at runtime, by multiple workers at the same
time, which can be useful to refresh the cluster topology when nodes are
added or removed from the cluster.
This method is automatically called upon the first query made to the
cluster (from <a href="../modules/resty.cassandra.cluster.html#_Cluster:execute">execute</a>, <a href="../modules/resty.cassandra.cluster.html#_Cluster:batch">batch</a> or <a href="../modules/resty.cassandra.cluster.html#_Cluster:iterate">iterate</a>), but needs to be manually
called if further updates are required.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">timeout</span>
<span class="types"><span class="type">number</span></span>
Timeout threshold (in seconds) for a given
worker when another worker is already refreshing the topology (defaults to
the <code>lock_timeout</code> option of the <a href="../modules/resty.cassandra.cluster.html#_Cluster.new">new</a> method).
</li>
</ul>

<h3>Returns:</h3>
<ol>
Expand All @@ -188,6 +202,10 @@ <h3>Returns:</h3>
<li>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
<code>err</code>: String describing the error if failure.</li>
<li>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
<code>topology</code>: A table containing the topology changes if any.
This value will only be returned when the worker acquired the lock.</li>
</ol>


Expand Down Expand Up @@ -510,7 +528,7 @@ <h3>Fields:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.lb.dc_rr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.lb.req_dc_rr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.lb.req_rr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.lb.rr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.reconnection.const.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.reconnection.exp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.cassandra.policies.retry.simple.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down

0 comments on commit a771a1f

Please sign in to comment.