kvclient-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Store</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: Store</h1> <section> <header> <h2> Store </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Store"><span class="type-signature"></span>new Store<span class="signature">(configuration)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Store constructor </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>configuration</code></td> <td class="type"> <span class="param-type"><a href="Configuration.html">Configuration</a></span> </td> <td class="description last">configuration object</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line68">line 68</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Closes the connection. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line197">line 197</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="deleteRow"><span class="type-signature"></span>deleteRow<span class="signature">(tableName, primaryKey, writeOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Deletes a row from a table. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>writeOptions</code></td> <td class="type"> <span class="param-type"><a href="WriteOptions.html">WriteOptions</a></span> </td> <td class="description last">non-default arguments controlling the Durability of the operation, or null to get default behaviour.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line442">line 442</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="deleteRowIfVersion"><span class="type-signature"></span>deleteRowIfVersion<span class="signature">(tableName, primaryKey, matchVersion, writeOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Deletes a row from a table but only if its version matches the one specified in matchVersion. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>matchVersion</code></td> <td class="type"> <span class="param-type">Buffer</span> </td> <td class="description last">the version to match.</td> </tr> <tr> <td class="name"><code>writeOptions</code></td> <td class="type"> <span class="param-type"><a href="WriteOptions.html">WriteOptions</a></span> </td> <td class="description last">non-default arguments controlling the Durability of the operation, or null to get default behaviour.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line472">line 472</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="execute"><span class="type-signature"></span>execute<span class="signature">(statement, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Executes a table statement. Currently, table statements can be used to create or modify tables and indices. </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>statement</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the statement to be performed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line728">line 728</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeAsync"><span class="type-signature"></span>executeAsync<span class="signature">(statement, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Executes a table statement in the server asynchronously. Currently, table statements can be used to create or modify tables and indices. The operation is asynchronous in server side and may not be finished when the method call the callback function. A execution identifier is returned and can be used to get information about the status of the operation. If the statement is for an administrative command, and the store is currently executing an administrative command that is the logical equivalent the action specified by the statement, the method will return a execution identifier that serves as a handle to that operation, rather than starting a new invocation of the command. </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>statement</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the statement to be performed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line758">line 758</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeCallback"><span class="type-signature"></span>executeCallback<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Callback until the command represented by a execution identifier completes. Returns information about the execution of the statement. This call will result in communication with the kvstore server. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line796">line 796</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeCancel"><span class="type-signature"></span>executeCancel<span class="signature">(statement, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Attempts to cancel execution of a statement, execution identifier of the statement must be provided. Return false if the statement couldn't be cancelled, possibly because it has already finished. If the statement hasn't succeeded already, and can be stopped, the operation will transition to the FAILED state. </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>statement</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">the statement to be performed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line779">line 779</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeOperations"><span class="type-signature"></span>executeOperations<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> This method provides an efficient and transactional mechanism for executing a sequence of operations associated with tables that share the same shard key portion of their primary keys. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line849">line 849</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeStatus"><span class="type-signature"></span>executeStatus<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Returns information about the execution of the statement. If the statement is still executing, this call will result in communication with the kvstore server to obtain up to date status, and the status returned will reflect interim information. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line831">line 831</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="executeTimeout"><span class="type-signature"></span>executeTimeout<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Callback until the command represented by a execution identifier completes or the timeout period is exceeded. This call will result in communication with the kvstore server. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line813">line 813</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(tableName, primaryKey, readOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Gets the Row associated with the primary key. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line223">line 223</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="indexIterator"><span class="type-signature"></span>indexIterator<span class="signature">(tableName, indexName, primaryKey, fieldRange, includedTables, readOptions, direction, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Returns an iterator over the rows associated with an index key. This method requires an additional database read on the server side to get row information for matching rows. Ancestor table rows for matching index rows may be returned as well if specified in the getOptions paramter. Index operations may not specify the return of child table rows. </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</td> </tr> <tr> <td class="name"><code>indexName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the index name</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>direction</code></td> <td class="type"> <span class="param-type">Direction</span> </td> <td class="description last">The Direction for this operation. If the primary key contains a complete shard key both Direction.FORWARD and Direction.REVERSE are allowed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line629">line 629</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="indexKeyIterator"><span class="type-signature"></span>indexKeyIterator<span class="signature">(tableName, indexName, primaryKey, fieldRange, includedTables, readOptions, direction, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Return the keys for matching rows associated with an index key. The iterator returned only references information directly available from the index. No extra fetch operations are performed. Ancestor table keys for matching index keys may be returned as well if specified in the getOptions paramter. Index operations may not specify the return of child table keys. </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</td> </tr> <tr> <td class="name"><code>indexName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the index name</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>direction</code></td> <td class="type"> <span class="param-type">Direction</span> </td> <td class="description last">The Direction for this operation. If the primary key contains a complete shard key both Direction.FORWARD and Direction.REVERSE are allowed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line676">line 676</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="indexKeyStream"><span class="type-signature"></span>indexKeyStream<span class="signature">(tableName, indexName, primaryKey, fieldRange, includedTables, readOptions, direction, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Return a Readable Stream with the keys for matching rows associated with an index key. The Stream returned only references information directly available from the index. No extra fetch operations are performed. Ancestor table keys for matching index keys may be returned as well if specified in the getOptions paramter. Index operations may not specify the return of child table keys. </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</td> </tr> <tr> <td class="name"><code>indexName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the index name</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>direction</code></td> <td class="type"> <span class="param-type">Direction</span> </td> <td class="description last">The Direction for this operation. If the primary key contains a complete shard key both Direction.FORWARD and Direction.REVERSE are allowed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line1016">line 1016</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="indexStream"><span class="type-signature"></span>indexStream<span class="signature">(tableName, indexName, primaryKey, fieldRange, includedTables, readOptions, direction, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Returns a Readable Stream over the rows associated with an index key. This method requires an additional database read on the server side to get row information for matching rows. Ancestor table rows for matching index rows may be returned as well if specified in the getOptions paramter. Index operations may not specify the return of child table rows. </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</td> </tr> <tr> <td class="name"><code>indexName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the index name</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>direction</code></td> <td class="type"> <span class="param-type">Direction</span> </td> <td class="description last">The Direction for this operation. If the primary key contains a complete shard key both Direction.FORWARD and Direction.REVERSE are allowed.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line969">line 969</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="multiDelete"><span class="type-signature"></span>multiDelete<span class="signature">(tableName, primaryKey, fieldRange, includedTables, writeOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Deletes multiple rows from a table in an atomic operation. The key used may be partial but must contain all of the fields that are in the shard key. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>writeOptions</code></td> <td class="type"> <span class="param-type"><a href="WriteOptions.html">WriteOptions</a></span> </td> <td class="description last">non-default arguments controlling the Durability of the operation, or null to get default behaviour.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line506">line 506</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="multiGet"><span class="type-signature"></span>multiGet<span class="signature">(tableName, primaryKey, fieldRange, includedTables, readOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Returns the rows associated with a partial primary key in an atomic manner. Rows are returned in primary key order. The key used must ontain all of the fields defined for the table's shard key. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">a function that is called when the process finish.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Store.js.html">Store.js</a>, <a href="Store.js.html#line255">line 255</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="multiGetKeys"><span class="type-signature"></span>multiGetKeys<span class="signature">(tableName, primaryKey, fieldRange, includedTables, readOptions, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Return the rows associated with a partial primary key in an atomic manner. Keys are returned in primary key order. The key used must contain all of the fields defined for the table's shard key. </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</td> </tr> <tr> <td class="name"><code>primaryKey</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">the primary key for a table. It must be a complete primary key, with all fields set.</td> </tr> <tr> <td class="name"><code>fieldRange</code></td> <td class="type"> <span class="param-type"><a href="FieldRange.html">FieldRange</a></span> </td> <td class="description last">The FieldRange to be used to restrict the range of the operation.</td> </tr> <tr> <td class="name"><code>includedTables</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last">The list of tables to be included in an operation that returns multiple rows or keys. the primaryKey parameter is always included as a target.</td> </tr> <tr> <td class="name"><code>readOptions</code></td> <td class="type"> <span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span> </td> <td class="description last">non-default options for the operation or null to get default behavior.</td>