gremlin

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: RemoteConnection</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: RemoteConnection</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>RemoteConnection<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> <div class="class-description">Represents an abstraction of a "connection" to a "server" that is capable of processing a traversal and returning results.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="RemoteConnection"><span class="type-signature"></span>new RemoteConnection<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <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>url</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="description last">The resource uri.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The connection options.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line32">line 32</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"></span></h4> <div class="description"> Returns true if connection is open </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line54">line 54</a> </li></ul></dd> </dl> <h4 class="name" id="isSessionBound"><span class="type-signature"></span>isSessionBound<span class="type-signature"></span></h4> <div class="description"> Determines if the connection is already bound to a session. If so, this indicates that the <code>#createSession()</code> cannot be called so as to produce child sessions. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line63">line 63</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Closes the connection where open transactions will close according to the features of the graph provider. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line105">line 105</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="commit"><span class="type-signature"></span>commit<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Submits a <code>Bytecode.GraphOp.commit</code> to the server and closes the connection. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line90">line 90</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="createSession"><span class="type-signature"></span>createSession<span class="signature">()</span><span class="type-signature"> → {<a href="RemoteConnection.html">RemoteConnection</a>}</span></h4> <div class="description"> Create a new <code>RemoteConnection</code> that is bound to a session using the configuration from this one. If the connection is already session bound then this function should throw an exception. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line82">line 82</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="RemoteConnection.html">RemoteConnection</a></span> </dd> </dl> <h4 class="name" id="open"><span class="type-signature"></span>open<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Opens the connection, if its not already opened. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line46">line 46</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="rollback"><span class="type-signature"></span>rollback<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Submits a <code>Bytecode.GraphOp.rollback</code> to the server and closes the connection. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line97">line 97</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="submit"><span class="type-signature">(abstract) </span>submit<span class="signature">(bytecode)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Submits the <code>Bytecode</code> provided and returns a <code>RemoteTraversal</code>. </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>bytecode</code></td> <td class="type"> <span class="param-type"><a href="Bytecode.html">Bytecode</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="driver_remote-connection.js.html">driver/remote-connection.js</a>, <a href="driver_remote-connection.js.html#line73">line 73</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Returns a <code>Promise</code> that resolves to a <code>RemoteTraversal</code>. </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="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="CardinalityValue.html">CardinalityValue</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrategy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a href="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li><li><a href="global.html#toArrayBuffer">toArrayBuffer</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Aug 08 2025 09:56:43 GMT-0700 (Pacific Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>