You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2018/01/26 11:04:11 UTC
svn commit: r1822275 [17/28] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ features/ nodestore/ nodestore/document/
nodestore/segment/ oak-mongo-js/ oak-mongo-js/fonts/ oak-mongo-js/scripts/
oak-mongo-js/styles/ oak_api/ plugins/ q...
Added: jackrabbit/site/live/oak/docs/oak-mongo-js/fonts/OpenSans-Regular-webfont.woff
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/fonts/OpenSans-Regular-webfont.woff?rev=1822275&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jackrabbit/site/live/oak/docs/oak-mongo-js/fonts/OpenSans-Regular-webfont.woff
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/index.html?rev=1822275&r1=1822274&r2=1822275&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/index.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/index.html Fri Jan 26 11:04:10 2018
@@ -2,8 +2,8 @@
<html lang="en">
<head>
<meta charset="utf-8">
- <title>JSDoc: Index</title>
-
+ <title>JSDoc: Home</title>
+
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
@@ -16,12 +16,13 @@
<body>
<div id="main">
-
- <h1 class="page-title">Index</h1>
-
+
+ <h1 class="page-title">Home</h1>
+
+
@@ -35,6 +36,7 @@
+
@@ -48,13 +50,13 @@
</div>
<nav>
- <h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
+ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
</nav>
-<br clear="both">
+<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Wed Apr 19 2017 08:49:39 GMT+0200 (MESZ)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html?rev=1822275&r1=1822274&r2=1822275&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html Fri Jan 26 11:04:10 2018
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<title>JSDoc: Source: oak-mongo.js</title>
-
+
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
@@ -16,16 +16,17 @@
<body>
<div id="main">
-
+
<h1 class="page-title">Source: oak-mongo.js</h1>
-
+
+
<section>
<article>
- <pre class="prettyprint source"><code>/*
+ <pre class="prettyprint source linenums"><code>/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -163,7 +164,7 @@ var oak = (function(global){
* parameter of the function.
*/
api.forEachChild = function(path, callable) {
- if (path !== undefined && path != "/") {
+ if (path !== undefined && path != "/") {
path = path + "/";
}
@@ -241,6 +242,45 @@ var oak = (function(global){
};
/**
+ * Find and dumps _id of all documents where the document size exceeds
+ * 15MB size. It also dumps progress info after every 10k docs.
+ *
+ * The ids can be found by grepping for '^id|' pattern
+ *
+ * > oak.dumpLargeDocIds({db: "aem-author"})
+ *
+ * @param {object} options pass optional parameters for host, port, db, and filename
+ */
+ api.dumpLargeDocIds = function (options) {
+ options = options || {};
+ var sizeLimit = options.sizeLimit || 15 * 1024 * 1024;
+ var count = 0;
+ var ids = [];
+ print("Using size limit: " + sizeLimit);
+ db.nodes.find().forEach(function (doc) {
+ var size = Object.bsonsize(doc);
+ if (size > sizeLimit) {
+ print("id|" + doc._id);
+ ids.push(doc._id)
+ }
+ if (++count % 10000 === 0) {
+ print("Traversed #" + count)
+ }
+ });
+
+ print("Number of large documents : " + ids.length);
+
+ //Dump the export command to dump all such large docs
+ if (ids.length > 0) {
+ var query = JSON.stringify({_id: {$in: ids}});
+ print("Using following export command to tweak the output");
+
+ options.db = db.getName();
+ print(createExportCommand(query, options));
+ }
+ };
+
+ /**
* Converts the given Revision String into a more human readable version,
* which also prints the date.
*
@@ -378,7 +418,7 @@ var oak = (function(global){
}
// refuse to remove when clusterId is marked active
var clusterNode = db.clusterNodes.findOne({_id: clusterId.toString()});
- if (clusterNode && clusterNode.state == "ACTIVE") {
+ if (clusterNode && clusterNode.state == "ACTIVE") {
print("Cluster node with id " + clusterId + " is active!");
print("Can only remove collisions for inactive cluster node.");
return;
@@ -508,7 +548,7 @@ var oak = (function(global){
* <p>
* Run this command via something as follows:
* <p>
- * mongo <DBNAME> -eval "load('oak-mongo.js'); oak.prepareDeepHistory('/');" > fix.js
+ * mongo &lt;DBNAME> -eval "load('oak-mongo.js'); oak.prepareDeepHistory('/');" > fix.js
*
* @memberof oak
* @method prepareDeepHistory
@@ -606,23 +646,7 @@ var oak = (function(global){
*/
api.printMongoExportCommand = function (path, options) {
- options = options || {};
- var host = options.host || "127.0.0.1";
- var port = options.port || "27017";
- var db = options.db || "oak";
- var filename = options.filename || "all-required-nodes.json"
-
- var query = JSON.stringify(getDocAndHierarchyQuery(path));
-
- var mongoExportCommand = "mongoexport"
- + " --host " + host
- + " --port " + port
- + " --db " + db
- + " --collection nodes"
- + " --out " + filename
- + " --query '" + query + "'";
-
- return mongoExportCommand;
+ return createExportCommand(JSON.stringify(getDocAndHierarchyQuery(path)), options);
};
/**
@@ -668,6 +692,22 @@ var oak = (function(global){
//~--------------------------------------------------< internal >
+ var createExportCommand = function (query, options) {
+ options = options || {};
+ var host = options.host || "127.0.0.1";
+ var port = options.port || "27017";
+ var db = options.db || "oak";
+ var filename = options.filename || "all-required-nodes.json"
+
+ return "mongoexport"
+ + " --host " + host
+ + " --port " + port
+ + " --db " + db
+ + " --collection nodes"
+ + " --out " + filename
+ + " --query '" + query + "'";
+ };
+
var checkOrFixDeepHistory = function(path, fix, prepare, verbose) {
if (prepare) {
// not issuing any header at all
@@ -702,7 +742,7 @@ var oak = (function(global){
affected++;
}
}
- if (!prepare && (++count%10000==0)) {
+ if (!prepare && (++count%10000==0)) {
print("[checked "+count+" so far ("+affected+" affected, "+ignored+" ignored) ...]");
}
} else {
@@ -737,7 +777,7 @@ var oak = (function(global){
return "/";
}
var idx = 0;
- while (depth-- > 0 && idx != -1) {
+ while (depth-- > 0 && idx != -1) {
idx = path.indexOf("/", idx + 1);
}
if (idx == -1) {
@@ -748,7 +788,7 @@ var oak = (function(global){
var getEntry = function(doc, name, revision) {
var result = null;
- if (doc && doc[name] && doc[name][revision]) {
+ if (doc && doc[name] && doc[name][revision]) {
result = {};
result[revision] = doc[name][revision];
}
@@ -783,7 +823,7 @@ var oak = (function(global){
var prev = db.nodes.findOne({_id: id });
if (prev) {
- if (prev[name] && prev[name][revision]) {
+ if (prev[name] && prev[name][revision]) {
result = prev;
} else {
forEachPrev(prev, traverse);
@@ -798,7 +838,7 @@ var oak = (function(global){
print("No path specified");
return;
}
- if (!ignorePathLen && (path.length > 165)) {
+ if (!ignorePathLen && (path.length > 165)) {
print("Path too long");
return;
}
@@ -899,7 +939,7 @@ var oak = (function(global){
var revStr = doc._lastRev["r0-0-" + clusterId];
if (revStr) {
var rev = new Revision(revStr);
- if (lastRev && lastRev.isNewerThan(rev)) {
+ if (lastRev && lastRev.isNewerThan(rev)) {
if (dryRun) {
result.push({_id: doc._id, _lastRev: rev.toString(), needsFix: lastRev.toString()});
} else {
@@ -1009,7 +1049,7 @@ var oak = (function(global){
// http://stackoverflow.com/questions/3561493/is-there-a-regexp-escape-function-in-javascript
var escapeForRegExp = function(s) {
- return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
+ return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
};
var getDocAndHierarchyQuery = function (path) {
@@ -1059,13 +1099,13 @@ var oak = (function(global){
</div>
<nav>
- <h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
+ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
</nav>
-<br clear="both">
+<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Wed Apr 19 2017 08:49:39 GMT+0200 (MESZ)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html?rev=1822275&r1=1822274&r2=1822275&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html Fri Jan 26 11:04:10 2018
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: oak</title>
-
+
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
@@ -16,153 +16,177 @@
<body>
<div id="main">
-
+
<h1 class="page-title">Namespace: oak</h1>
-
+
+
<section>
-
+
<header>
- <h2>
- oak
- </h2>
-</header>
+ <h2>
+ oak
+ </h2>
+
+
+</header>
<article>
<div class="container-overview">
-
-
-
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line22">line 22</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
+
</div>
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
<h3 class="subsection-title">Methods</h3>
+
- <dl>
-<dt>
- <h4 class="name" id="blobStats"><span class="type-signature"><static> </span>blobStats<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".blobStats"><span class="type-signature">(static) </span>blobStats<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Returns statistics about the blobs collection in the current database.
+
+
+
+<div class="description">
+ Returns statistics about the blobs collection in the current database.
The stats include the combined BSON size of all documents. The time to
run this command therefore heavily depends on the size of the collection.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line194">line 194</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
statistics about the blobs collection.
</div>
@@ -170,74 +194,76 @@ run this command therefore heavily depen
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="checkDeepHistory"><span class="type-signature"><static> </span>checkDeepHistory<span class="signature">(path, <span class="optional">verbose</span>)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Same as checkHistory except it goes through ALL descendants as well!
- </div>
-
+
+ <h4 class="name" id=".checkDeepHistory"><span class="type-signature">(static) </span>checkDeepHistory<span class="signature">(path, verbose<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Same as checkHistory except it goes through ALL descendants as well!
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Argument</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+ <th>Default</th>
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -246,33 +272,33 @@ run this command therefore heavily depen
</td>
-
+
<td class="attributes">
-
+
-
+
</td>
-
+
<td class="default">
</td>
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>verbose</code></td>
-
+
<td class="type">
@@ -281,19 +307,19 @@ run this command therefore heavily depen
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -301,118 +327,132 @@ run this command therefore heavily depen
</td>
-
+
<td class="description last">if true, the result object will contain a list
of dangling references to previous documents.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line463">line 463</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line502">line 502</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="checkHistory"><span class="type-signature"><static> </span>checkHistory<span class="signature">(path, <span class="optional">verbose</span>, <span class="optional">ignorePathLen</span>)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".checkHistory"><span class="type-signature">(static) </span>checkHistory<span class="signature">(path, verbose<span class="signature-attributes">opt</span>, ignorePathLen<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Checks the history of previous documents at the given path. Orphaned
+
+
+
+<div class="description">
+ Checks the history of previous documents at the given path. Orphaned
references to removed previous documents are counted and listed when
run with verbose set to true.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Argument</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+ <th>Default</th>
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -421,33 +461,33 @@ run with verbose set to true.
</td>
-
+
<td class="attributes">
-
+
-
+
</td>
-
+
<td class="default">
</td>
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>verbose</code></td>
-
+
<td class="type">
@@ -456,19 +496,19 @@ run with verbose set to true.
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -476,18 +516,18 @@ run with verbose set to true.
</td>
-
+
<td class="description last">if true, the result object will contain a list
of dangling references to previous documents.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>ignorePathLen</code></td>
-
+
<td class="type">
@@ -496,19 +536,19 @@ run with verbose set to true.
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -516,63 +556,75 @@ run with verbose set to true.
</td>
-
+
<td class="description last">whether to ignore a long path and
still try to read it from MongoDB.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line399">line 399</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line438">line 438</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the check.
</div>
@@ -580,71 +632,73 @@ run with verbose set to true.
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="checkLastRevs"><span class="type-signature"><static> </span>checkLastRevs<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".checkLastRevs"><span class="type-signature">(static) </span>checkLastRevs<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Checks the _lastRev for a given clusterId. The checks starts with the
+
+
+
+<div class="description">
+ Checks the _lastRev for a given clusterId. The checks starts with the
given path and walks up to the root node.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -653,21 +707,21 @@ given path and walks up to the root node
</td>
+
+
-
-
-
+
<td class="description last">the path of a node to check</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>clusterId</code></td>
-
+
<td class="type">
@@ -676,66 +730,78 @@ given path and walks up to the root node
</td>
+
+
-
-
-
+
<td class="description last">the id of an oak cluster node.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line166">line 166</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the check.
</div>
@@ -743,34 +809,34 @@ given path and walks up to the root node
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="countChildren"><span class="type-signature"><static> </span>countChildren<span class="signature">(path)</span><span class="type-signature"> → {number}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".countChildren"><span class="type-signature">(static) </span>countChildren<span class="signature">(path)</span><span class="type-signature"> → {number}</span></h4>
+
- <div class="description">
- Determines the number of child node (including all sub tree)
+
+
+
+<div class="description">
+ Determines the number of child node (including all sub tree)
for a given parent node path. This would be faster compared to
getChildStats as it does not load the doc and works on
index only.
@@ -778,42 +844,44 @@ index only.
Note that there might be some difference between db.nodes.count()
and countChildren('/') as split docs, intermediate docs are not
accounted for
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -822,66 +890,78 @@ accounted for
</td>
+
+
-
-
-
+
<td class="description last">the path of a node.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line73">line 73</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the number of children, including all descendant nodes.
</div>
@@ -889,70 +969,72 @@ accounted for
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">number</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="findOne"><span class="type-signature"><static> </span>findOne<span class="signature">(path)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Finds the document with the given path.
- </div>
-
+
+ <h4 class="name" id=".findOne"><span class="type-signature">(static) </span>findOne<span class="signature">(path)</span><span class="type-signature"> → {object}</span></h4>
+
+
+
+
+<div class="description">
+ Finds the document with the given path.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -961,66 +1043,78 @@ accounted for
</td>
+
+
-
-
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line384">line 384</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line423">line 423</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the document or null if it doesn't exist.
</div>
@@ -1028,74 +1122,76 @@ accounted for
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="fixDeepHistory"><span class="type-signature"><static> </span>fixDeepHistory<span class="signature">(path, <span class="optional">verbose</span>)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Same as fixHistory except it goes through ALL descendants as well!
- </div>
-
+
+ <h4 class="name" id=".fixDeepHistory"><span class="type-signature">(static) </span>fixDeepHistory<span class="signature">(path, verbose<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Same as fixHistory except it goes through ALL descendants as well!
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Argument</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+ <th>Default</th>
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -1104,33 +1200,33 @@ accounted for
</td>
-
+
<td class="attributes">
-
+
-
+
</td>
-
+
<td class="default">
</td>
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>verbose</code></td>
-
+
<td class="type">
@@ -1139,19 +1235,19 @@ accounted for
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -1159,118 +1255,132 @@ accounted for
</td>
-
+
<td class="description last">if true, the result object will contain a list
of removed references to previous documents.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line496">line 496</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line535">line 535</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="fixHistory"><span class="type-signature"><static> </span>fixHistory<span class="signature">(path, <span class="optional">verbose</span>)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".fixHistory"><span class="type-signature">(static) </span>fixHistory<span class="signature">(path, verbose<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Repairs the history of previous documents at the given path. Orphaned
+
+
+
+<div class="description">
+ Repairs the history of previous documents at the given path. Orphaned
references to removed previous documents are cleaned up and listed when
run with verbose set to true.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Argument</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+ <th>Default</th>
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -1279,33 +1389,33 @@ run with verbose set to true.
</td>
-
+
<td class="attributes">
-
+
-
+
</td>
-
+
<td class="default">
</td>
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>verbose</code></td>
-
+
<td class="type">
@@ -1314,19 +1424,19 @@ run with verbose set to true.
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -1334,63 +1444,75 @@ run with verbose set to true.
</td>
-
+
<td class="description last">if true, the result object will contain a list
of removed references to previous documents.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line509">line 509</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line548">line 548</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the fix.
</div>
@@ -1398,71 +1520,73 @@ run with verbose set to true.
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="fixLastRevs"><span class="type-signature"><static> </span>fixLastRevs<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".fixLastRevs"><span class="type-signature">(static) </span>fixLastRevs<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Fixes the _lastRev for a given clusterId. The fix starts with the
+
+
+
+<div class="description">
+ Fixes the _lastRev for a given clusterId. The fix starts with the
given path and walks up to the root node.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -1471,21 +1595,21 @@ given path and walks up to the root node
</td>
+
+
-
-
-
+
<td class="description last">the path of a node to fix</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>clusterId</code></td>
-
+
<td class="type">
@@ -1494,66 +1618,78 @@ given path and walks up to the root node
</td>
+
+
-
-
-
+
<td class="description last">the id of an oak cluster node.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
+
-
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line180">line 180</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the fix.
</div>
@@ -1561,71 +1697,73 @@ given path and walks up to the root node
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="forEachChild"><span class="type-signature"><static> </span>forEachChild<span class="signature">(path, callable)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".forEachChild"><span class="type-signature">(static) </span>forEachChild<span class="signature">(path, callable)</span><span class="type-signature"></span></h4>
+
- <div class="description">
- Performs a breadth first traversal for nodes under given path
+
+
+
+<div class="description">
+ Performs a breadth first traversal for nodes under given path
and invokes the passed function for each child node.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -1634,136 +1772,150 @@ and invokes the passed function for each
</td>
+
+
-
-
-
+
<td class="description last">the path of a node.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>callable</code></td>
-
+
<td class="type">
</td>
+
+
-
-
-
+
<td class="description last">a function to be called for each child node including all
descendant nodes. The MongoDB document is passed as the single
parameter of the function.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line127">line 127</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="formatRevision"><span class="type-signature"><static> </span>formatRevision<span class="signature">(rev)</span><span class="type-signature"> → {string}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".formatRevision"><span class="type-signature">(static) </span>formatRevision<span class="signature">(rev)</span><span class="type-signature"> → {string}</span></h4>
+
- <div class="description">
- Converts the given Revision String into a more human readable version,
+
+
+
+<div class="description">
+ Converts the given Revision String into a more human readable version,
which also prints the date.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>rev</code></td>
-
+
<td class="type">
@@ -1772,66 +1924,78 @@ which also prints the date.
</td>
+
+
-
-
-
+
<td class="description last">a revision string.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line216">line 216</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line255">line 255</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
a human readable string representation of the revision.
</div>
@@ -1839,71 +2003,73 @@ which also prints the date.
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">string</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="getChildStats"><span class="type-signature"><static> </span>getChildStats<span class="signature">(path)</span><span class="type-signature"> → {Object}</span></h4>
+
+
+ <h4 class="name" id=".getChildStats"><span class="type-signature">(static) </span>getChildStats<span class="signature">(path)</span><span class="type-signature"> → {Object}</span></h4>
+
-</dt>
-<dd>
-
-
- <div class="description">
- Provides stats related to number of child nodes
+
+
+
+<div class="description">
+ Provides stats related to number of child nodes
below given path or total size taken by such nodes.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -1912,66 +2078,78 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">the path of a node.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line107">line 107</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
statistics about the child nodes
including all descendants.
@@ -1980,70 +2158,72 @@ below given path or total size taken by
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">Object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="getCommitValue"><span class="type-signature"><static> </span>getCommitValue<span class="signature">(path, revision)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Returns the commit value entry for the change with the given revision.
- </div>
-
+
+ <h4 class="name" id=".getCommitValue"><span class="type-signature">(static) </span>getCommitValue<span class="signature">(path, revision)</span><span class="type-signature"> → {object}</span></h4>
+
+
+
+
+<div class="description">
+ Returns the commit value entry for the change with the given revision.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -2052,21 +2232,21 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">the path of a document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>revision</code></td>
-
+
<td class="type">
@@ -2075,66 +2255,78 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">the revision of a change on the document.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line525">line 525</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line564">line 564</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the commit entry for the given revision or null if
there is none.
@@ -2143,90 +2335,103 @@ below given path or total size taken by
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="indexStats"><span class="type-signature"><static> </span>indexStats<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
+
+
+ <h4 class="name" id=".indexStats"><span class="type-signature">(static) </span>indexStats<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
+
-</dt>
-<dd>
+
+
+
+<div class="description">
+ Collects various stats related to Oak indexes stored under /oak:index.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
- <div class="description">
- Collects various stats related to Oak indexes stored under /oak:index.
- </div>
+
+
+
+
+
+
+
-<dl class="details">
+
-
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line49">line 49</a>
+ </li></ul></dd>
+
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line49">line 49</a>
- </li></ul></dd>
-
-
-
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
index stats.
</div>
@@ -2234,90 +2439,103 @@ below given path or total size taken by
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">Array</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="listCheckpoints"><span class="type-signature"><static> </span>listCheckpoints<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- List all checkpoints.
- </div>
-
+
+ <h4 class="name" id=".listCheckpoints"><span class="type-signature">(static) </span>listCheckpoints<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
+
-
-
-
-
-
+
+
+
+<div class="description">
+ List all checkpoints.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line269">line 269</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line308">line 308</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
all checkpoints
</div>
@@ -2325,70 +2543,72 @@ below given path or total size taken by
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="listChildren"><span class="type-signature"><static> </span>listChildren<span class="signature">(path)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Lists the children at a given path.
- </div>
-
+
+ <h4 class="name" id=".listChildren"><span class="type-signature">(static) </span>listChildren<span class="signature">(path)</span><span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Lists the children at a given path.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -2397,115 +2617,129 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">list the children of the document with this path.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line437">line 437</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line476">line 476</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="listDescendants"><span class="type-signature"><static> </span>listDescendants<span class="signature">(path)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Lists the descendant documents at a given path.
- </div>
-
+
+ <h4 class="name" id=".listDescendants"><span class="type-signature">(static) </span>listDescendants<span class="signature">(path)</span><span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Lists the descendant documents at a given path.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -2514,115 +2748,129 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">list the descendants of the document with this path.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line417">line 417</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line456">line 456</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="pathFromId"><span class="type-signature"><static> </span>pathFromId<span class="signature">(id)</span><span class="type-signature"> → {string}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Returns the path part of the given id.
- </div>
-
+
+ <h4 class="name" id=".pathFromId"><span class="type-signature">(static) </span>pathFromId<span class="signature">(id)</span><span class="type-signature"> → {string}</span></h4>
+
+
+
+
+<div class="description">
+ Returns the path part of the given id.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>id</code></td>
-
+
<td class="type">
@@ -2631,66 +2879,78 @@ below given path or total size taken by
</td>
+
+
-
-
-
+
<td class="description last">the id of a Document in the nodes collection.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line153">line 153</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the path derived from the id.
</div>
@@ -2698,34 +2958,34 @@ below given path or total size taken by
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">string</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="prepareDeepHistory"><span class="type-signature"><static> </span>prepareDeepHistory<span class="signature">(path, <span class="optional">verbose</span>)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".prepareDeepHistory"><span class="type-signature">(static) </span>prepareDeepHistory<span class="signature">(path, verbose<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
- <div class="description">
- Preparation step which scans through all descendants and prints out
+
+
+
+<div class="description">
+ Preparation step which scans through all descendants and prints out
'fixHistory' for those that need fixing of their 'dangling references'.
<p>
See fixHistory for parameter details.
@@ -2733,46 +2993,48 @@ See fixHistory for parameter details.
Run this command via something as follows:
<p>
mongo <DBNAME> -eval "load('oak-mongo.js'); oak.prepareDeepHistory('/');" > fix.js
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Argument</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+ <th>Default</th>
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -2781,33 +3043,33 @@ Run this command via something as follow
</td>
-
+
<td class="attributes">
-
+
-
+
</td>
-
+
<td class="default">
</td>
-
+
<td class="description last">the path of a document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>verbose</code></td>
-
+
<td class="type">
@@ -2816,19 +3078,19 @@ Run this command via something as follow
</td>
-
+
<td class="attributes">
<optional><br>
-
+
-
+
</td>
-
+
<td class="default">
@@ -2836,115 +3098,129 @@ Run this command via something as follow
</td>
-
+
<td class="description last">if true, the result object will contain a list
of dangling references to previous documents.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line476">line 476</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line515">line 515</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="printMongoExportCommand"><span class="type-signature"><static> </span>printMongoExportCommand<span class="signature">(path, options)</span><span class="type-signature"> → {string}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".printMongoExportCommand"><span class="type-signature">(static) </span>printMongoExportCommand<span class="signature">(path, options)</span><span class="type-signature"> → {string}</span></h4>
+
- <div class="description">
- Prints mongoexport command to export all documents related to given path.
+
+
+
+<div class="description">
+ Prints mongoexport command to export all documents related to given path.
Related documents refer to all documents in the hierarchy and their split documents.
e.g.
> oak.printMongoExportCommand("/etc", {db: "aem-author"})
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -2953,21 +3229,21 @@ e.g.
</td>
+
+
-
-
-
+
<td class="description last">the path of the document.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>options</code></td>
-
+
<td class="type">
@@ -2976,141 +3252,155 @@ e.g.
</td>
+
+
-
-
-
+
<td class="description last">pass optional parameters for host, port, db, and filename</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line568">line 568</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line607">line 607</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+<div class="param-desc">
+ command line which can be used to export documents using mongoexport
+</div>
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">string</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+ <h4 class="name" id=".printOplogSliceCommand"><span class="type-signature">(static) </span>printOplogSliceCommand<span class="signature">(revStr, options)</span><span class="type-signature"> → {string}</span></h4>
+
-
-
- <h5>Returns:</h5>
-
-
-<div class="param-desc">
- command line which can be used to export documents using mongoexport
+
+
+
+<div class="description">
+ Prints mongoexport command to export oplog entries around time represented by revision.
+e.g.
+> oak.printOplogSliceCommand("r14e64620028-0-1", {db: "aem-author"})
+Note, this assumed that time on mongo instance is synchronized with time on oak instance. If that's
+not the case, then adjust revStr to account for the difference.
</div>
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">string</span>
- </dd>
-</dl>
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
-
-
-</dd>
-
-<dt>
- <h4 class="name" id="printOplogSliceCommand"><span class="type-signature"><static> </span>printOplogSliceCommand<span class="signature">(revStr, options)</span><span class="type-signature"> → {string}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Prints mongoexport command to export oplog entries around time represented by revision.
-e.g.
-> oak.printOplogSliceCommand("r14e64620028-0-1", {db: "aem-author"})
-Note, this assumed that time on mongo instance is synchronized with time on oak instance. If that's
-not the case, then adjust revStr to account for the difference.
- </div>
-
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
-
-
-
-
- <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>revStr</code></td>
-
+
<td class="type">
@@ -3119,21 +3409,21 @@ not the case, then adjust revStr to acco
</td>
+
+
-
-
-
+
<td class="description last">revision string around which oplog is to be exported.</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>options</code></td>
-
+
<td class="type">
@@ -3142,66 +3432,78 @@ not the case, then adjust revStr to acco
</td>
+
+
-
-
-
+
<td class="description last">pass optional parameters for host, port, db, filename, oplogTimeBuffer</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line601">line 601</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line624">line 624</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
command line which can be used to export oplog entries using mongoexport
</div>
@@ -3209,70 +3511,72 @@ not the case, then adjust revStr to acco
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">string</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="removeCheckpointsOlderThan"><span class="type-signature"><static> </span>removeCheckpointsOlderThan<span class="signature">(rev)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Removes all checkpoints older than a given Revision.
- </div>
-
+
+ <h4 class="name" id=".removeCheckpointsOlderThan"><span class="type-signature">(static) </span>removeCheckpointsOlderThan<span class="signature">(rev)</span><span class="type-signature"> → {object}</span></h4>
+
+
+
+
+<div class="description">
+ Removes all checkpoints older than a given Revision.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>rev</code></td>
-
+
<td class="type">
@@ -3281,66 +3585,78 @@ not the case, then adjust revStr to acco
</td>
+
+
-
-
-
+
<td class="description last">checkpoints older than this revision are removed.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line298">line 298</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line337">line 337</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the MongoDB update.
</div>
@@ -3348,72 +3664,74 @@ not the case, then adjust revStr to acco
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="removeCollisions"><span class="type-signature"><static> </span>removeCollisions<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
+
+
+ <h4 class="name" id=".removeCollisions"><span class="type-signature">(static) </span>removeCollisions<span class="signature">(path, clusterId)</span><span class="type-signature"> → {object}</span></h4>
+
- <div class="description">
- Removes all collision markers on the document with the given path and
+
+
+
+<div class="description">
+ Removes all collision markers on the document with the given path and
clusterId. This method will only remove collisions when the clusterId
is inactive.
- </div>
-
+</div>
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -3422,21 +3740,21 @@ is inactive.
</td>
+
+
-
-
-
+
<td class="description last">the path of a document</td>
</tr>
-
-
-
+
+
+
<tr>
<td class="name"><code>clusterId</code></td>
-
+
<td class="type">
@@ -3445,66 +3763,78 @@ is inactive.
</td>
+
+
-
-
-
+
<td class="description last">collision markers for this clusterId will be removed.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line332">line 332</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line371">line 371</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
the result of the MongoDB update.
</div>
@@ -3512,70 +3842,72 @@ is inactive.
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
+
+
-<dt>
- <h4 class="name" id="removeDescendantsAndSelf"><span class="type-signature"><static> </span>removeDescendantsAndSelf<span class="signature">(path)</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Removes the complete subtree rooted at the given path.
- </div>
-
+
+ <h4 class="name" id=".removeDescendantsAndSelf"><span class="type-signature">(static) </span>removeDescendantsAndSelf<span class="signature">(path)</span><span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Removes the complete subtree rooted at the given path.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
-
-
- <h5>Parameters:</h5>
-
<table class="params">
<thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
-
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
<tr>
<td class="name"><code>path</code></td>
-
+
<td class="type">
@@ -3584,135 +3916,160 @@ is inactive.
</td>
+
+
-
-
-
+
<td class="description last">the path of the subtree to remove.</td>
</tr>
-
-
- </tbody>
-</table>
-
-
+
+ </tbody>
+</table>
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line229">line 229</a>
+ <a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line268">line 268</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-</dd>
+
+
+
+
+
+
+
+
+
+
+
+
-<dt>
- <h4 class="name" id="systemStats"><span class="type-signature"><static> </span>systemStats<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- Collects various stats related to Oak usage of Mongo.
- </div>
-
+
+ <h4 class="name" id=".systemStats"><span class="type-signature">(static) </span>systemStats<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
+
-
-
-
-
-
+
+
+
+<div class="description">
+ Collects various stats related to Oak usage of Mongo.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
<dl class="details">
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="oak-mongo.js.html">oak-mongo.js</a>, <a href="oak-mongo.js.html#line31">line 31</a>
</li></ul></dd>
+
+
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
- <h5>Returns:</h5>
-
-
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
<div class="param-desc">
system stats.
</div>
@@ -3720,31 +4077,30 @@ is inactive.
<dl>
- <dt>
- Type
- </dt>
- <dd>
-
+ <dt>
+ Type
+ </dt>
+ <dd>
+
<span class="param-type">object</span>
- </dd>
+ </dd>
</dl>
-
-
-</dd>
- </dl>
-
-
+
+
+
+
+
</article>
-</section>
+</section>
@@ -3752,13 +4108,13 @@ is inactive.
</div>
<nav>
- <h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
+ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="oak.html">oak</a></li></ul>
</nav>
-<br clear="both">
+<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.3-dev</a> on Wed Apr 19 2017 08:49:39 GMT+0200 (MESZ)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/scripts/linenumber.js
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/scripts/linenumber.js?rev=1822275&r1=1822274&r2=1822275&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/scripts/linenumber.js (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/scripts/linenumber.js Fri Jan 26 11:04:10 2018
@@ -1,17 +1,25 @@
+/*global document */
(function() {
- var counter = 0;
- var numbered;
- var source = document.getElementsByClassName('prettyprint source');
+ var source = document.getElementsByClassName('prettyprint source linenums');
+ var i = 0;
+ var lineNumber = 0;
+ var lineId;
+ var lines;
+ var totalLines;
+ var anchorHash;
if (source && source[0]) {
- source = source[0].getElementsByTagName('code')[0];
+ anchorHash = document.location.hash.substring(1);
+ lines = source[0].getElementsByTagName('li');
+ totalLines = lines.length;
- numbered = source.innerHTML.split('\n');
- numbered = numbered.map(function(item) {
- counter++;
- return '<span id="line' + counter + '" class="line"></span>' + item;
- });
-
- source.innerHTML = numbered.join('\n');
+ for (; i < totalLines; i++) {
+ lineNumber++;
+ lineId = 'line' + lineNumber;
+ lines[i].id = lineId;
+ if (lineId === anchorHash) {
+ lines[i].className += ' selected';
+ }
+ }
}
})();
\ No newline at end of file