@innotrade/enapso-graphdb-admin

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: EnapsoGraphDBAdmin</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: EnapsoGraphDBAdmin</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>EnapsoGraphDBAdmin<span class="signature">()</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="EnapsoGraphDBAdmin"><span class="type-signature"></span>new EnapsoGraphDBAdmin<span class="signature">()</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line16">line 16</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".createRepository"><span class="type-signature">(static) </span>createRepository<span class="signature">(aOptions)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Creates a new repositories </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>aOptions</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options responsible for the method. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last">The id in the options.</td> </tr> <tr> <td class="name"><code>location</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> '' </td> <td class="description last">The location in the options.</td> </tr> <tr> <td class="name"><code>baseURL</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'http://ont.enapso.com#' </td> <td class="description last">The Base URL in the options.</td> </tr> <tr> <td class="name"><code>entityIndexSize</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> '200000' </td> <td class="description last">The Entity index size in the options.</td> </tr> <tr> <td class="name"><code>entityIdSize</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> '32' </td> <td class="description last">The Entity ID bit-size in the options.</td> </tr> <tr> <td class="name"><code>ruleset</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'owl-horst-optimized' </td> <td class="description last">The Ruleset in the options.</td> </tr> <tr> <td class="name"><code>storageFolder</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'storage' </td> <td class="description last">The Storage folder in the options.</td> </tr> <tr> <td class="name"><code>enableContextIndex</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Use context index in the options.</td> </tr> <tr> <td class="name"><code>cacheMemory</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> '80m' </td> <td class="description last">The Total cache memory in the options.</td> </tr> <tr> <td class="name"><code>tupleIndexMemory</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> '80m' </td> <td class="description last">The Tuple index memory in the options.</td> </tr> <tr> <td class="name"><code>enablePredicateList</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Use predicate indices in the options.</td> </tr> <tr> <td class="name"><code>predicateMemory</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 0 </td> <td class="description last">The Predicate index memory in the options.</td> </tr> <tr> <td class="name"><code>ftsMemory</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 0 </td> <td class="description last">The Full-text search memory in the options.</td> </tr> <tr> <td class="name"><code>ftsIndexPolicy</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'never' </td> <td class="description last">The Full-text search indexing policy in the options.</td> </tr> <tr> <td class="name"><code>ftsLiteralsOnly</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The Full-text search literals only in the options.</td> </tr> <tr> <td class="name"><code>inMemoryLiteralProperties</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Cache literal language tags in the options.</td> </tr> <tr> <td class="name"><code>enableLiteralIndex</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The Enable literal index in the options.</td> </tr> <tr> <td class="name"><code>indexCompressionRatio</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> -1 </td> <td class="description last">The Index compression ratio in the options.</td> </tr> <tr> <td class="name"><code>checkForInconsistencies</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Check for inconsistencies in the options.</td> </tr> <tr> <td class="name"><code>disableSameAs</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Disable owl:sameAs in the options.</td> </tr> <tr> <td class="name"><code>enableOptimization</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The Enable query optimisation in the options.</td> </tr> <tr> <td class="name"><code>transactionIsolation</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The Transaction isolation in the options.</td> </tr> <tr> <td class="name"><code>transactionMode</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'safe' </td> <td class="description last">The Transaction mode in the options.</td> </tr> <tr> <td class="name"><code>queryTimeout</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 0 </td> <td class="description last">The Query time-out (seconds) in the options.</td> </tr> <tr> <td class="name"><code>queryLimitResults</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 0 </td> <td class="description last">The Limit query results in the options.</td> </tr> <tr> <td class="name"><code>throwQueryEvaluationExceptionOnTimeout</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Throw exception on query time-out in the options.</td> </tr> <tr> <td class="name"><code>readOnly</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Read-only in the options.</td> </tr> <tr> <td class="name"><code>nonInterpretablePredicates</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'http://www.w3.org/2000/01/rdf-schema#label;http://www.w3.org/1999/02/22-rdf-syntax-ns#type;http://www.ontotext.com/owlim/ces#gazetteerConfig;http://www.ontotext.com/owlim/ces#metadataConfig' </td> <td class="description last">The Non-interpretable predicates in the options.</td> </tr> <tr> <td class="name"><code>isShacl</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> false </td> <td class="description last">The Supports SHACL validation in the options.</td> </tr> <tr> <td class="name"><code>title</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'enapso </td> <td class="description last">Repository' - The Title of the repository in the options.</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'free' </td> <td class="description last">The Type in the options.</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line202">line 202</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Promise object represents the result of creating new repository. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id=".createUser"><span class="type-signature">(static) </span>createUser<span class="signature">(aOptions)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Creates a new user </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>aOptions</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options responsible for the method. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>username</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last">The username in the options.</td> </tr> <tr> <td class="name"><code>password</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> </td> <td class="description last">The password in the options.</td> </tr> <tr> <td class="name"><code>authorities</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="default"> '[]' </td> <td class="description last">The authorities in the options.</td> </tr> <tr> <td class="name"><code>DEFAULT_SAME_AS</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The DEFAULT SAME AS in the options.</td> </tr> <tr> <td class="name"><code>DEFAULT_INFERENCE</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The DEFAULT INFERENCE in the options.</td> </tr> <tr> <td class="name"><code>EXECUTE_COUNT</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The EXECUTE COUNT in the options.</td> </tr> <tr> <td class="name"><code>IGNORE_SHARED_QUERIES</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="default"> true </td> <td class="description last">The IGNORE SHARED QUERIES in the options.</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line636">line 636</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Promise object represents result of creating a new user </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id=".getHeaders"><span class="type-signature">(static) </span>getHeaders<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> Returns Headers </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line20">line 20</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Headers </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> <h4 class="name" id=".getRepositories"><span class="type-signature">(static) </span>getRepositories<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Returns all the repositories </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line145">line 145</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Promise object represents all the repositories </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id=".waitForAsynchronousResponse"><span class="type-signature">(static) </span>waitForAsynchronousResponse<span class="signature">(args)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Waits for a response </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>args</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The args responsible for the method. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>uri</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The uri in the args.</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line75">line 75</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Promise object represents the response object </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id=".waitForUploadResponse"><span class="type-signature">(static) </span>waitForUploadResponse<span class="signature">(args)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Waits for upload response </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>args</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The args responsible for the method. <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>timeout</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 60000 </td> <td class="description last">Represents the timeout for the method</td> </tr> <tr> <td class="name"><code>interval</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="default"> 1000 </td> <td class="description last">Represents the interval for the method</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enapso-graphdb-admin.js.html">enapso-graphdb-admin.js</a>, <a href="enapso-graphdb-admin.js.html#line94">line 94</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Promise object represents the response object </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EnapsoGraphDBAdmin.html">EnapsoGraphDBAdmin</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Tue Feb 23 2021 16:55:26 GMT+0500 (Pakistan Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>