@flexvertex/flexvertex-driver

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: FlexSchema</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: FlexSchema</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>FlexSchema<span class="signature">(flexSession<span class="signature-attributes">non-null</span>, dnsPath<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h2> <div class="class-description">Represents a FlexVertex Schema.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="FlexSchema"><span class="type-signature"></span>new FlexSchema<span class="signature">(flexSession<span class="signature-attributes">non-null</span>, dnsPath<span class="signature-attributes">nullable</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>flexSession</code></td> <td class="type"> <span class="param-type"><a href="FlexSession.html">FlexSession</a></span> </td> <td class="attributes"> </td> <td class="description last">The FlexSession this FlexSchema belongs</td> </tr> <tr> <td class="name"><code>dnsPath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last">The /Domain/Nexus/Schema path</td> </tr> </tbody> </table> <dl class="details"> </dl> </div> <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="FlexSchema.html">FlexSchema</a></dt> <dd></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Should be called when this FlexSchema is no longer needed. </div> <dl class="details"> </dl> <h4 class="name" id="deleteConnection"><span class="type-signature"></span>deleteConnection<span class="signature">(flexConnection<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deletes the specified <a href="FlexConnection.html">FlexConnection</a>. FlexSchema.save() must be called to complete the deletion. </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>flexConnection</code></td> <td class="type"> <span class="param-type"><a href="FlexConnection.html">FlexConnection</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="deleteConnectionByKey"><span class="type-signature"></span>deleteConnectionByKey<span class="signature">(objectKey<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deletes a <a href="FlexConnection.html">FlexConnection</a> by specifying its ObjectKey. FlexSchema.save() must be called to complete the deletion. </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>objectKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="deleteObject"><span class="type-signature"></span>deleteObject<span class="signature">(flexObject<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deletes the specified <a href="FlexObject.html">FlexObject</a>. FlexSchema.save() must be called to complete the deletion. </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>flexObject</code></td> <td class="type"> <span class="param-type"><a href="FlexObject.html">FlexObject</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="deleteObjectByKey"><span class="type-signature"></span>deleteObjectByKey<span class="signature">(objectKey<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deletes a <a href="FlexObject.html">FlexObject</a> by specifying its ObjectKey. FlexSchema.save() must be called to complete the deletion. </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>objectKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="executeVoyage"><span class="type-signature">(async) </span>executeVoyage<span class="signature">(voyage<span class="signature-attributes">non-null</span>, namedParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="FlexCargo.html">FlexCargo</a>}</span></h4> <div class="description"> Executes a Voyage from the passed-in string </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>voyage</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">The Voyager contents</td> </tr> <tr> <td class="name"><code>namedParams</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Each property in the object is passed to Voyager as a namedParams property</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="FlexCargo.html">FlexCargo</a></span> </dd> </dl> <h4 class="name" id="executeVoyagerAsset"><span class="type-signature">(async) </span>executeVoyagerAsset<span class="signature">(assetPath<span class="signature-attributes">non-null</span>, namedParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="FlexCargo.html">FlexCargo</a>}</span></h4> <div class="description"> Executes a Voyage from a remote asset </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>assetPath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">The asset path to the Voyager file</td> </tr> <tr> <td class="name"><code>namedParams</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Each property in the object is passed to Voyager as a namedParams property</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="FlexCargo.html">FlexCargo</a></span> </dd> </dl> <h4 class="name" id="executeVoyagerFile"><span class="type-signature">(async) </span>executeVoyagerFile<span class="signature">(voyagerFilePath<span class="signature-attributes">non-null</span>, namedParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="FlexCargo.html">FlexCargo</a>}</span></h4> <div class="description"> Executes a Voyage from a local file </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>voyagerFilePath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">The path to the Voyager file</td> </tr> <tr> <td class="name"><code>namedParams</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Each property in the object is passed to Voyager as a namedParams property</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="FlexCargo.html">FlexCargo</a></span> </dd> </dl> <h4 class="name" id="loadConnection"><span class="type-signature">(async) </span>loadConnection<span class="signature">(objectKey<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Loads and returns a <a href="FlexConnection.html">FlexConnection</a> from the specified ObjectKey </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>objectKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> FlexConnection </div> <h4 class="name" id="loadObject"><span class="type-signature">(async) </span>loadObject<span class="signature">(objectKey<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Loads and returns a <a href="FlexObject.html">FlexObject</a> from the specified ObjectKey </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>objectKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> FlexObject </div> <h4 class="name" id="query"><span class="type-signature">(async) </span>query<span class="signature">(sql<span class="signature-attributes">non-null</span>, namedParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="FlexResultSet.html">FlexResultSet</a>}</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>sql</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>namedParams</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Each property in the object is passed to the SQL executor as a named parameter</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="FlexResultSet.html">FlexResultSet</a></span> </dd> </dl> <h4 class="name" id="save"><span class="type-signature">(async) </span>save<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Must be called anytime a FlexObject or FlexConnection needs to be saved or deleted. </div> <dl class="details"> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlexCargo.html">FlexCargo</a></li><li><a href="FlexCommons.html">FlexCommons</a></li><li><a href="FlexConnection.html">FlexConnection</a></li><li><a href="FlexJourney.html">FlexJourney</a></li><li><a href="FlexObject.html">FlexObject</a></li><li><a href="FlexResultSet.html">FlexResultSet</a></li><li><a href="FlexSchema.html">FlexSchema</a></li><li><a href="FlexSegment.html">FlexSegment</a></li><li><a href="FlexSession.html">FlexSession</a></li><li><a href="FlexVertex.html">FlexVertex</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Feb 23 2025 20:39:15 GMT-0700 (GMT-07:00) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>