nosqldb-oraclejs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: ProxyConfiguration</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: ProxyConfiguration</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>ProxyConfiguration<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="ProxyConfiguration"><span class="type-signature"></span>new ProxyConfiguration<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Defines a set of configuration values used to connect or create a proxy instance. This is just the constructor with no parameters, once this object is created you can change any parameter. </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>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 with the initial values to construct ProxyConfiguration, the object has the following format: { startProxy : true, KVCLIENT_JAR: '', KVPROXY_JAR: '', .....</td> </tr> </tbody> </table> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>startProxy</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">Indicates if the module should try to start a proxy instance from which it will connect to a Oracle NoSQL Database Store.</td> </tr> <tr> <td class="name"><code>KVCLIENT_JAR</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The path where the file kvclient.jar is located, required to start a local proxy.</td> </tr> <tr> <td class="name"><code>KVPROXY_JAR</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The path where the proxy files are located. the default value is the location to the driver's proxy included files.</td> </tr> <tr> <td class="name"><code>host</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">Indicates the host:port for a proxy to connect, if startProxy is set to true, then this parameter is used to start the proxy at this host:port.</td> </tr> <tr> <td class="name"><code>maxIteratorResults</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">A long representing the maximum number of results returned in one single iterator call. Default: 100</td> </tr> <tr> <td class="name"><code>iteratorExpiration</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Iterator expiration interval in milliseconds.</td> </tr> <tr> <td class="name"><code>maxOpenIterators</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Maximum concurrent opened iterators. Default: 10000</td> </tr> <tr> <td class="name"><code>numPoolThreads</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Number of proxy threads. Default: 20</td> </tr> <tr> <td class="name"><code>socketReadTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Configures the read timeout in milliseconds associated with the underlying sockets to the store.</td> </tr> <tr> <td class="name"><code>socketOpenTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Configures the open timeout in milliseconds used when establishing sockets to the store.</td> </tr> <tr> <td class="name"><code>maxActiveRequests</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Maximum number of active requests towards the store.</td> </tr> <tr> <td class="name"><code>requestTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Configures the default request timeout in milliseconds.</td> </tr> <tr> <td class="name"><code>requestThresholdPercent</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Threshold for activating request limiting, as a percentage of the requested maximum active requests.</td> </tr> <tr> <td class="name"><code>nodeLimitPercent</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">Limit on the number of requests, as a percentage of the requested maximum active requests.</td> </tr> <tr> <td class="name"><code>securityFile</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The security file with properties to be used in a secured store.</td> </tr> <tr> <td class="name"><code>verbose</code></td> <td class="type"> <span class="param-type">bool</span> </td> <td class="description last">Verbose flag.</td> </tr> <tr> <td class="name"><code>log4jproperties</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The file used by log4j to configure logging.</td> </tr> <tr> <td class="name"><code>maxConcurrentRequests</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">The maximum number of concurrent requests per iterator. Default value is set to no of available processors * 2.</td> </tr> <tr> <td class="name"><code>maxResultsBatches</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">The maximum number of results batches that can be held in the proxy per iterator. Default: 0, which means it will be set automatically by kv.client based on the -max-concurrent-requests.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="proxy.js.html">proxy.js</a>, <a href="proxy.js.html#line223">line 223</a> </li></ul></dd> </dl> </div> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configuration.html">Configuration</a></li><li><a href="ConnectionError.html">ConnectionError</a></li><li><a href="Consistency.html">Consistency</a></li><li><a href="DeleteResult.html">DeleteResult</a></li><li><a href="Durability.html">Durability</a></li><li><a href="ExecutionFuture.html">ExecutionFuture</a></li><li><a href="ExecutionId.html">ExecutionId</a></li><li><a href="FieldRange.html">FieldRange</a></li><li><a href="GetResult.html">GetResult</a></li><li><a href="Iterator.html">Iterator</a></li><li><a href="IteratorError.html">IteratorError</a></li><li><a href="KeyPair.html">KeyPair</a></li><li><a href="KeyPairResult.html">KeyPairResult</a></li><li><a href="Logger.html">Logger</a></li><li><a href="ModuleInfo.html">ModuleInfo</a></li><li><a href="MultiGetKeyResult.html">MultiGetKeyResult</a></li><li><a href="MultiGetResult.html">MultiGetResult</a></li><li><a href="NoSQLDBError.html">NoSQLDBError</a></li><li><a href="Operation.html">Operation</a></li><li><a href="ParameterError.html">ParameterError</a></li><li><a href="ProxyConfiguration.html">ProxyConfiguration</a></li><li><a href="PutResult.html">PutResult</a></li><li><a href="Readable.html">Readable</a></li><li><a href="ReadOptions.html">ReadOptions</a></li><li><a href="ReplicaAckPolicy.html">ReplicaAckPolicy</a></li><li><a href="ReturnChoice.html">ReturnChoice</a></li><li><a href="ReturnKey.html">ReturnKey</a></li><li><a href="ReturnRow.html">ReturnRow</a></li><li><a href="Row.html">Row</a></li><li><a href="SimpleConsistency.html">SimpleConsistency</a></li><li><a href="StatementResult.html">StatementResult</a></li><li><a href="Store.html">Store</a></li><li><a href="StoreError.html">StoreError</a></li><li><a href="SyncPolicy.html">SyncPolicy</a></li><li><a href="TimeConsistency.html">TimeConsistency</a></li><li><a href="TimeToLive.html">TimeToLive</a></li><li><a href="UpdateResult.html">UpdateResult</a></li><li><a href="VerifyProperties.html">VerifyProperties</a></li><li><a href="Version.html">Version</a></li><li><a href="VersionConsistency.html">VersionConsistency</a></li><li><a href="WriteOptions.html">WriteOptions</a></li></ul><h3>Events</h3><ul><li><a href="Iterator.html#event:close">close</a></li><li><a href="Iterator.html#event:data">data</a></li><li><a href="Iterator.html#event:done">done</a></li><li><a href="Iterator.html#event:error">error</a></li><li><a href="Readable.html#event:data">data</a></li><li><a href="Readable.html#event:end">end</a></li><li><a href="Readable.html#event:error">error</a></li><li><a href="Store.html#event:close">close</a></li><li><a href="Store.html#event:error">error</a></li><li><a href="Store.html#event:open">open</a></li></ul><h3>Global</h3><ul><li><a href="global.html#AuthenticationFailureException">AuthenticationFailureException</a></li><li><a href="global.html#AuthenticationRequiredException">AuthenticationRequiredException</a></li><li><a href="global.html#ConsistencyException">ConsistencyException</a></li><li><a href="global.html#DurabilityException">DurabilityException</a></li><li><a href="global.html#FaultException">FaultException</a></li><li><a href="global.html#IllegalArgumentException">IllegalArgumentException</a></li><li><a href="global.html#readConfiguration">readConfiguration</a></li><li><a href="global.html#RequestLimitException">RequestLimitException</a></li><li><a href="global.html#RequestTimeoutException">RequestTimeoutException</a></li><li><a href="global.html#startProxy">startProxy</a></li><li><a href="global.html#stopProxy">stopProxy</a></li><li><a href="global.html#TableOpExecutionException">TableOpExecutionException</a></li><li><a href="global.html#TimeUnit">TimeUnit</a></li><li><a href="global.html#UnauthorizedException">UnauthorizedException</a></li><li><a href="global.html#UnknownException">UnknownException</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Aug 01 2019 14:19:18 GMT+0530 (India Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>