docs(cluster) document 'lock_timeout' and 'silent'

thibaultcha · Oct 18, 2016 · e99ece3 · e99ece3
1 parent 2bd3d66
commit e99ece3
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 14 deletions.
diff --git a/docs/examples/authentication.lua.html b/docs/examples/authentication.lua.html
@@ -106,7 +106,7 @@ <h2>authentication.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/batch.lua.html b/docs/examples/batch.lua.html
@@ -140,7 +140,7 @@ <h2>batch.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/intro.lua.html b/docs/examples/intro.lua.html
@@ -183,7 +183,7 @@ <h2>intro.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/pagination.lua.html b/docs/examples/pagination.lua.html
@@ -116,7 +116,7 @@ <h2>pagination.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/ssl.lua.html b/docs/examples/ssl.lua.html
@@ -122,7 +122,7 @@ <h2>ssl.lua</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -125,7 +125,7 @@ <h2>Examples</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/manual/README.md.html b/docs/manual/README.md.html
@@ -254,7 +254,7 @@ <h2>License</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/cassandra.html b/docs/modules/cassandra.html
@@ -1121,7 +1121,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.cluster.html b/docs/modules/resty.cassandra.cluster.html
@@ -428,6 +428,15 @@ <h3>Fields:</h3>
          Maximum waiting time allowed when executing
  DDL queries before timing out, in ms.
  (<code>number</code>, default: <code>10000</code>)
+        </li>
+        <li><span class="parameter">lock_timeout</span>
+         Timeout value of lua-resty-lock used for the <a href="../modules/resty.cassandra.cluster.html#_Cluster:refresh">refresh</a>
+ and prepared statement mutexes, in seconds.
+ (<code>number</code>, optional)
+        </li>
+        <li><span class="parameter">silent</span>
+         Disables all logging (of any log_level) from this cluster.
+ (<code>boolean</code>, default: <code>false</code>)
         </li>
         <li><span class="parameter">lb_policy</span>
          A load balancing policy created from one of the modules
@@ -499,7 +508,7 @@ <h3>Fields:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.policies.lb.dc_rr.html b/docs/modules/resty.cassandra.policies.lb.dc_rr.html
@@ -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.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.policies.lb.rr.html b/docs/modules/resty.cassandra.policies.lb.rr.html
@@ -127,7 +127,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.policies.reconnection.const.html b/docs/modules/resty.cassandra.policies.reconnection.const.html
@@ -134,7 +134,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.policies.reconnection.exp.html b/docs/modules/resty.cassandra.policies.reconnection.exp.html
@@ -141,7 +141,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/resty.cassandra.policies.retry.simple.html b/docs/modules/resty.cassandra.policies.retry.simple.html
@@ -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.5</a></i>
-<i style="float:right;">Last updated 2016-10-06 18:45:55 </i>
+<i style="float:right;">Last updated 2016-10-17 20:28:32 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/lib/resty/cassandra/cluster.lua b/lib/resty/cassandra/cluster.lua
@@ -242,6 +242,11 @@ _Cluster.__index = _Cluster
 -- @field max_schema_consensus_wait Maximum waiting time allowed when executing
 -- DDL queries before timing out, in ms.
 -- (`number`, default: `10000`)
+-- @field lock_timeout Timeout value of lua-resty-lock used for the `refresh`
+-- and prepared statement mutexes, in seconds.
+-- (`number`, optional)
+-- @field silent Disables all logging (of any log_level) from this cluster.
+-- (`boolean`, default: `false`)
 -- @field lb_policy A load balancing policy created from one of the modules
 -- under `resty.cassandra.policies.lb.*`.
 -- (`lb policy`, default: `lb.rr` round robin)