kvclient-js
Version:
Oracle NoSQL Database node.js Client API.
1,307 lines (410 loc) • 18.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="ReplicaAckPolicy"><span class="type-signature"></span>ReplicaAckPolicy<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
A replicated environment makes it possible to increase an application's transaction commit guarantees by
committing changes to its replicas on the network. ReplicaAckPolicy defines the policy for how such network
commits are handled.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ALL</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">All replicas must acknowledge that they have committed the transaction.</td>
</tr>
<tr>
<td class="name"><code>NONE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">No transaction commit acknowledgments are required and the master will never wait
for replica acknowledgments.</td>
</tr>
<tr>
<td class="name"><code>SIMPLE_MAJORITY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">A simple majority of replicas must acknowledge that they have committed
the transaction.</td>
</tr>
</tbody>
</table>
</dl>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Types.js.html">Types.js</a>, <a href="Types.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="ReturnChoice"><span class="type-signature"></span>ReturnChoice<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Specifies whether to return the row value, version, both or neither.
For best performance, it is important to choose only the properties that are required.
The store is optimized to avoid I/O when the requested properties are in cache.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ALL</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Return both the value and the version.</td>
</tr>
<tr>
<td class="name"><code>NONE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Do not return the value or the version.</td>
</tr>
<tr>
<td class="name"><code>VALUE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Return the value only.</td>
</tr>
<tr>
<td class="name"><code>VERSION</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Return the version only.</td>
</tr>
</tbody>
</table>
</dl>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Types.js.html">Types.js</a>, <a href="Types.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="SimpleConsistency"><span class="type-signature"></span>SimpleConsistency<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Used to provide consistency guarantees for read operations.
In general, read operations may be serviced either at a Master or Replica node. When serviced at the Master node,
consistency is always absolute. If absolute consistency is required, ABSOLUTE may be specified to force the
operation to be serviced at the Master. For other types of consistency, when the operation is serviced at a
Replica node, the transaction will not begin until the consistency policy is satisfied.
The Consistency is specified as an argument to all read operations, for example, get.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ABSOLUTE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">A consistency policy that requires that a transaction be serviced on the Master so that
consistency is absolute.</td>
</tr>
<tr>
<td class="name"><code>NONE_REQUIRED</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">A consistency policy that lets a transaction on a replica using this policy
proceed regardless of the state of the Replica relative to the Master.</td>
</tr>
<tr>
<td class="name"><code>NONE_REQUIRED_NO_MASTER</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">A consistency policy that requires that a read operation be serviced on
a replica; never the Master.</td>
</tr>
</tbody>
</table>
</dl>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Types.js.html">Types.js</a>, <a href="Types.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="SyncPolicy"><span class="type-signature"></span>SyncPolicy<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Defines the synchronization policy to be used when committing a transaction. High levels of synchronization
offer a greater guarantee that the transaction is persistent to disk, but trade that off for lower performance.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>NO_SYNC</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Do not write or synchronously flush the log on transaction commit.</td>
</tr>
<tr>
<td class="name"><code>SYNC</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Write and synchronously flush the log on transaction commit.</td>
</tr>
<tr>
<td class="name"><code>WRITE_NO_SYNC</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Write but do not synchronously flush the log on transaction commit.</td>
</tr>
</tbody>
</table>
</dl>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Types.js.html">Types.js</a>, <a href="Types.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="readProxyConfiguration"><span class="type-signature"></span>readProxyConfiguration<span class="signature">(filename)</span><span class="type-signature"> → {<a href="ProxyConfiguration.html">ProxyConfiguration</a>}</span></h4>
</dt>
<dd>
<div class="description">
Tries to read a file with a ProxyConfiguration object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>filename</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the full path for the file</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Proxy.js.html">Proxy.js</a>, <a href="Proxy.js.html#line162">line 162</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ProxyConfiguration.html">ProxyConfiguration</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="startProxy"><span class="type-signature"></span>startProxy<span class="signature">(proxyConfiguration, callback)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
starts a proxy with the given configuration
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>proxyConfiguration</code></td>
<td class="type">
<span class="param-type"><a href="ProxyConfiguration.html">ProxyConfiguration</a></span>
</td>
<td class="description last">the configuration used to start the proxy</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">function called after the proxy is started</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Proxy.js.html">Proxy.js</a>, <a href="Proxy.js.html#line216">line 216</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="stopProxy"><span class="type-signature"></span>stopProxy<span class="signature">(proxyConfiguration, callback)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Shutdown the proxy. If a proxy was started, this method will shutdown it.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>proxyConfiguration</code></td>
<td class="type">
<span class="param-type"><a href="ProxyConfiguration.html">ProxyConfiguration</a></span>
</td>
<td class="description last">the configuration used to start the proxy</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">function called after trying to shutdown the proxy</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Proxy.js.html">Proxy.js</a>, <a href="Proxy.js.html#line289">line 289</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Configuration.html">Configuration</a></li><li><a href="Durability.html">Durability</a></li><li><a href="FieldRange.html">FieldRange</a></li><li><a href="Iterator.html">Iterator</a></li><li><a href="Logger.html">Logger</a></li><li><a href="Operation.html">Operation</a></li><li><a href="ProxyConfiguration.html">ProxyConfiguration</a></li><li><a href="Readable.html">Readable</a></li><li><a href="ReadOptions.html">ReadOptions</a></li><li><a href="SecurityProperties.html">SecurityProperties</a></li><li><a href="Store.html">Store</a></li><li><a href="VerifyProperties.html">VerifyProperties</a></li><li><a href="WriteOptions.html">WriteOptions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#readProxyConfiguration">readProxyConfiguration</a></li><li><a href="global.html#ReplicaAckPolicy">ReplicaAckPolicy</a></li><li><a href="global.html#ReturnChoice">ReturnChoice</a></li><li><a href="global.html#SimpleConsistency">SimpleConsistency</a></li><li><a href="global.html#startProxy">startProxy</a></li><li><a href="global.html#stopProxy">stopProxy</a></li><li><a href="global.html#SyncPolicy">SyncPolicy</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a> on Mon Dec 01 2014 16:17:12 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>