iframe-proxy | Sunbelt Computer Software

This repository was archived by the owner on Oct 21, 2022. It is now read-only.

267 lines (86 loc) · 4.04 KB

<!DOCTYPE html>
<html lang="en">
    <meta charset="utf-8">
    <title>JSDoc: Class: sql</title>
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<div id="main">
    <h1 class="page-title">Class: sql</h1>
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-Adaptor.html">Adaptor</a>~</span>sql<span class="signature">(sqlQuery, options)</span><span class="type-signature"> &rarr; {Operation}</span></h2>
    <div class="container-overview">
    <h4 class="name" id="sql"><span class="type-signature"></span>new sql<span class="signature">(sqlQuery, options)</span><span class="type-signature"> &rarr; {Operation}</span></h4>
<div class="description">
    Execute an SQL statement
    <h5>Parameters:</h5>
<table class="params">
    <thead>
        <th>Name</th>
        <th>Type</th>
        <th class="last">Description</th>
    </thead>
    <tbody>
        <tr>
                <td class="name"><code>sqlQuery</code></td>
            <td class="type">
<span class="param-type">function</span>
            </td>
            <td class="description last">a function which takes state and returns a
string of SQL.</td>
        </tr>
        <tr>
                <td class="name"><code>options</code></td>
            <td class="type">
<span class="param-type">object</span>
            </td>
            <td class="description last">Optional options argument</td>
        </tr>
    </tbody>
<dl class="details">
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Adaptor.js.html">Adaptor.js</a>, <a href="Adaptor.js.html#line277">line 277</a>
    </li></ul></dd>
<h5>Returns:</h5>
        Type
<span class="param-type">Operation</span>
    <h5>Example</h5>
    <pre class="prettyprint"><code>sql(state => `select(*) from ${state.data.tableName};`, { writeSql: true })</code></pre>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Adaptor.html">Adaptor</a></li></ul><h3>Classes</h3><ul><li><a href="module-Adaptor-describeTable.html">describeTable</a></li><li><a href="module-Adaptor-execute.html">execute</a></li><li><a href="module-Adaptor-findValue.html">findValue</a></li><li><a href="module-Adaptor-insert.html">insert</a></li><li><a href="module-Adaptor-insertMany.html">insertMany</a></li><li><a href="module-Adaptor-insertTable.html">insertTable</a></li><li><a href="module-Adaptor-modifyTable.html">modifyTable</a></li><li><a href="module-Adaptor-sql.html">sql</a></li><li><a href="module-Adaptor-upsert.html">upsert</a></li><li><a href="module-Adaptor-upsertIf.html">upsertIf</a></li><li><a href="module-Adaptor-upsertMany.html">upsertMany</a></li></ul>
<br class="clear">
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Oct 21 2021 11:45:53 GMT+0000 (Greenwich Mean Time)
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

module-Adaptor-sql.html

Latest commit

History

module-Adaptor-sql.html

File metadata and controls