kvclient-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Operation</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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">Class: Operation</h1> <section> <header> <h2> Operation </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Operation"><span class="type-signature"></span>new Operation<span class="signature">(tableName, type, row, returnChoice, abortIfUnsuccessful, matchVersion)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Defines an update operation to be passed to Store.executeOperations(). </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>tableName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The table name on which this operation is executed on.</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">OperationType</span> </td> <td class="description last">Determines which update operation to be executed.</td> </tr> <tr> <td class="name"><code>row</code></td> <td class="type"> <span class="param-type">Row</span> </td> <td class="description last">For put operations: represents the row to be stored. For delete operations: represents the key of the row to be deleted.</td> </tr> <tr> <td class="name"><code>returnChoice</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReturnChoice">ReturnChoice</a></span> </td> <td class="description last">Specifies whether to return the row value, version, both or neither.</td> </tr> <tr> <td class="name"><code>abortIfUnsuccessful</code></td> <td class="type"> <span class="param-type">Bool</span> </td> <td class="description last">True if this operation should cause the execute transaction to abort when the operation fails, where failure is the condition when the delete or put method returns null.</td> </tr> <tr> <td class="name"><code>matchVersion</code></td> <td class="type"> <span class="param-type">Version</span> </td> <td class="description last">The version to be matched for: putIfVersion and deleteIfVersion.</td> </tr> </tbody> </table> <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>tableName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The table name on which this operation is executed on.</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">OperationType</span> </td> <td class="description last">Determines which update operation to be executed.</td> </tr> <tr> <td class="name"><code>row</code></td> <td class="type"> <span class="param-type">Row</span> </td> <td class="description last">For put operations: represents the row to be stored. For delete operations: represents the key of the row to be deleted.</td> </tr> <tr> <td class="name"><code>returnChoice</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReturnChoice">ReturnChoice</a></span> </td> <td class="description last">Specifies whether to return the row value, version, both or neither.</td> </tr> <tr> <td class="name"><code>abortIfUnsuccessful</code></td> <td class="type"> <span class="param-type">Bool</span> </td> <td class="description last">True if this operation should cause the execute transaction to abort when the operation fails, where failure is the condition when the delete or put method returns null.</td> </tr> <tr> <td class="name"><code>matchVersion</code></td> <td class="type"> <span class="param-type">Version</span> </td> <td class="description last">The version to be matched for: putIfVersion and deleteIfVersion.</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#line316">line 316</a> </li></ul></dd> </dl> </dd> </div> </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>