nosqldb-oraclejs
Version:
Oracle NoSQL Database JS Driver
3,548 lines (980 loc) • 125 kB
HTML
<!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>
<!--[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">Class: Store</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Store<span class="signature">(configuration)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Store"><span class="type-signature"></span>new Store<span class="signature">(configuration)</span><span class="type-signature"></span></h4>
<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#line71">line 71</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="type-signature"> :parse|exports</span></h4>
<div class="description">
Helper function to parse strings and convert them into Javascript objects,
use it instead of common JSON.parse when you use long integers (64 bits).
This function converts these long integers into Int64 objects.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">parse</span>
|
<span class="param-type">exports</span>
</li>
</ul>
<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#line1898">line 1898</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stringify"><span class="type-signature"></span>stringify<span class="type-signature"> :parse|exports</span></h4>
<div class="description">
Helper function to convert Javascript objects into strings,
use it instead of common JSON.strings when you use Int64 objects.
This function converts these Int64 objects into correct long integer strings.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">parse</span>
|
<span class="param-type">exports</span>
</li>
</ul>
<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#line1906">line 1906</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"></span></h4>
<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#line299">line 299</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(tableName, primaryKey, writeOptions<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>Attributes</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="attributes">
</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="attributes">
</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="attributes">
<optional><br>
</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"><a href="global.html#deleteCallback">deleteCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the process
ends.</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#line837">line 837</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deleteIfVersion"><span class="type-signature"></span>deleteIfVersion<span class="signature">(tableName, primaryKey, matchVersion, writeOptions<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>Attributes</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="attributes">
</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="attributes">
</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"><a href="Version.html">Version</a></span>
</td>
<td class="attributes">
</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="attributes">
<optional><br>
</td>
<td class="description last">Non-default arguments controlling the
Durability of 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"><a href="global.html#deleteCallback">deleteCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the process
ends.</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#line883">line 883</a>
</li></ul></dd>
</dl>
<h4 class="name" id="execute"><span class="type-signature"></span>execute<span class="signature">(statement, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>Attributes</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="attributes">
</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">executeCallback</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the
process ends.</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#line1336">line 1336</a>
</li></ul></dd>
</dl>
<h4 class="name" id="executeFuture"><span class="type-signature"></span>executeFuture<span class="signature">(statement, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Executes a table DDL statement in the server without waiting for a response.
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>Attributes</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="attributes">
</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"><a href="global.html#executeFutureCallback">executeFutureCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the
process ends.</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#line1363">line 1363</a>
</li></ul></dd>
</dl>
<h4 class="name" id="executeUpdates"><span class="type-signature"></span>executeUpdates<span class="signature">(operations, writeOptions<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operations</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
</td>
<td class="description last">The operations to be performed.</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="attributes">
<optional><br>
</td>
<td class="description last">Non-default arguments controlling the
Durability of the operation, or null to get default behaviour.
For this method, returnChoice is not allowed within writeOptions object
and it must be null, instead, every operation should handle their own
returnChoice option.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#executeUpdatesCallback">executeUpdatesCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when
the process ends.</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#line1421">line 1421</a>
</li></ul></dd>
</dl>
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(tableName, primaryKey, readOptions<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>Attributes</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="attributes">
</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="attributes">
</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="attributes">
<optional><br>
</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"><a href="global.html#getCallback">getCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the process
ends.</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#line446">line 446</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getExecutionFuture"><span class="type-signature"></span>getExecutionFuture<span class="signature">(executionId)</span><span class="type-signature"> → {<a href="ExecutionFuture.html">ExecutionFuture</a>}</span></h4>
<div class="description">
Creates an ExecutionFuture object from a ExecutionId 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>executionId</code></td>
<td class="type">
<span class="param-type"><a href="ExecutionId.html">ExecutionId</a></span>
</td>
<td class="description last">The ExecutionId from which the execution
future is going to be constructed.</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#line1397">line 1397</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
executionFuture The ExecutionFuture object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ExecutionFuture.html">ExecutionFuture</a></span>
</dd>
</dl>
<h4 class="name" id="indexIterator"><span class="type-signature"></span>indexIterator<span class="signature">(tableName, indexName, options<span class="signature-attributes">opt</span>, callback, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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 parameter. 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>Attributes</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="attributes">
</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="attributes">
</td>
<td class="description last">The index name.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that includes the following
parameters:
{ indexKey: null,
fieldRange: null,
includedTables: null,
readOptions: null,
direction: null }</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options.indexKey</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index key for the operation. It may be
partial or complete. If the key has no fields set the entire index is
matched.</td>
</tr>
<tr>
<td class="name"><code>options.fieldRange</code></td>
<td class="type">
<span class="param-type"><a href="FieldRange.html">FieldRange</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The FieldRange to be used to restrict
the range of the operation.</td>
</tr>
<tr>
<td class="name"><code>options.includedTables</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
</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>options.readOptions</code></td>
<td class="type">
<span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">Non-default options for the
operation or null to get default behavior.</td>
</tr>
<tr>
<td class="name"><code>options.direction</code></td>
<td class="type">
<span class="param-type">Direction</span>
</td>
<td class="attributes">
</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"><a href="global.html#iteratorCallback">iteratorCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the
process ends.</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#line1169">line 1169</a>
</li></ul></dd>
</dl>
<h4 class="name" id="indexKeyIterator"><span class="type-signature"></span>indexKeyIterator<span class="signature">(tableName, indexName, options<span class="signature-attributes">opt</span>, callback, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Returns the KeyPair for matching rows associated with an index key. The
iterator returned only references information directly available from the
index -- the row's primary key and the matching index key for the entry.
No extra fetch operations are performed. Ancestor table keys for
matching index keys may be returned as well if specified in the getOptions
parameter. 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>Attributes</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="attributes">
</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="attributes">
</td>
<td class="description last">The index name.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that includes the following
parameters:
{ indexKey: null,
fieldRange: null,
includedTables: null,
readOptions: null,
direction: null }</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options.indexKey</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index key for the operation. It may be
partial or complete. If the key has no fields set the entire index is
matched.</td>
</tr>
<tr>
<td class="name"><code>options.fieldRange</code></td>
<td class="type">
<span class="param-type"><a href="FieldRange.html">FieldRange</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The FieldRange to be used to restrict
the range of the operation.</td>
</tr>
<tr>
<td class="name"><code>options.includedTables</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
</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>options.readOptions</code></td>
<td class="type">
<span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">Non-default options for the
operation or null to get default behavior.</td>
</tr>
<tr>
<td class="name"><code>options.direction</code></td>
<td class="type">
<span class="param-type">Direction</span>
</td>
<td class="attributes">
</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"><a href="global.html#iteratorCallback">iteratorCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the
process ends.</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#line1248">line 1248</a>
</li></ul></dd>
</dl>
<h4 class="name" id="indexKeyStream"><span class="type-signature"></span>indexKeyStream<span class="signature">(tableName, indexName, options<span class="signature-attributes">opt</span>, callback, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Return a Readable Stream with the KeyPairs 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 parameter. 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>Attributes</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="attributes">
</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="attributes">
</td>
<td class="description last">The index name.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that includes the following
parameters:
{ indexKey: null,
fieldRange: null,
includedTables: null,
readOptions: null,
direction: null }</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options.indexKey</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index key for the operation. It may be
partial or complete. If the key has no fields set the entire index is
matched.</td>
</tr>
<tr>
<td class="name"><code>options.fieldRange</code></td>
<td class="type">
<span class="param-type"><a href="FieldRange.html">FieldRange</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The FieldRange to be used to restrict
the range of the operation.</td>
</tr>
<tr>
<td class="name"><code>options.includedTables</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
</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>options.readOptions</code></td>
<td class="type">
<span class="param-type"><a href="ReadOptions.html">ReadOptions</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">Non-default options for the
operation or null to get default behavior.</td>
</tr>
<tr>
<td class="name"><code>options.direction</code></td>
<td class="type">
<span class="param-type">Direction</span>
</td>
<td class="attributes">
</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"><a href="global.html#streamCallback">streamCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A function that is called when the process
ends.</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#line1763">line 1763</a>
</li></ul></dd>
</dl>
<h4 class="name" id="indexStream"><span class="type-signature"></span>indexStream<span class="signature">(tableName, indexName, options<span class="signature-attributes">opt</span>, callback, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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 parameter. 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>Attributes</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="attributes">
</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="attributes">
</td>
<td class="description last">The index name.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that includes the following
parameters:
{ indexKey: null,
fieldRange: null,
includedTables: null,
readOptions: null,
direction: null }</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options.indexKey</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index key for the operation. It may be
partial or complete. If the key has no fields set the entire index is
matched.</td>
</tr>
<tr>
<td class="name"><code>options.fieldRange</code></td>
<td class="type">
<span class="param-type"><a href="FieldRange.html">FieldRange</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The FieldRange to be used to restrict
the range of the operation.</td>
</tr>
<tr>
<td class="name"><code>options.includedTables</code></td>
<td class="type">
<span class="param-type">Array</span>