17 lines
8.5 KiB
HTML
17 lines
8.5 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>adl.to-hugsql-queries documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Adl</span> <span class="project-version">1.4.6-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adl</span></div></div></li><li class="depth-2 branch"><a href="adl.main.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>main</span></div></a></li><li class="depth-2 branch current"><a href="adl.to-hugsql-queries.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-hugsql-queries</span></div></a></li><li class="depth-2 branch"><a href="adl.to-json-routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-json-routes</span></div></a></li><li class="depth-2 branch"><a href="adl.to-psql.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-psql</span></div></a></li><li class="depth-2 branch"><a href="adl.to-reframe.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-reframe</span></div></a></li><li class="depth-2 branch"><a href="adl.to-selmer-routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-selmer-routes</span></div></a></li><li class="depth-2 branch"><a href="adl.to-selmer-templates.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-selmer-templates</span></div></a></li><li class="depth-2 branch"><a href="adl.to-swagger.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-swagger</span></div></a></li><li class="depth-2"><a href="adl.validator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validator</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-delete-query"><div class="inner"><span>delete-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-expanded-token"><div class="inner"><span>expanded-token</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-foreign-queries"><div class="inner"><span>foreign-queries</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-insert-query"><div class="inner"><span>insert-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-list-query"><div class="inner"><span>list-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-order-by-clause"><div class="inner"><span>order-by-clause</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-queries"><div class="inner"><span>queries</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-search-query"><div class="inner"><span>search-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-select-query"><div class="inner"><span>select-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-to-hugsql-queries"><div class="inner"><span>to-hugsql-queries</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-update-query"><div class="inner"><span>update-query</span></div></a></li><li class="depth-1"><a href="adl.to-hugsql-queries.html#var-where-clause"><div class="inner"><span>where-clause</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl.to-hugsql-queries</h1><div class="doc"><pre class="plaintext">Application Description Language - generate HUGSQL queries file.
|
|
</pre></div><div class="public anchor" id="var-delete-query"><h3>delete-query</h3><div class="usage"><code>(delete-query entity)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `delete` query for this `entity`
|
|
</pre></div></div><div class="public anchor" id="var-expanded-token"><h3>expanded-token</h3><div class="usage"></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-foreign-queries"><h3>foreign-queries</h3><div class="usage"><code>(foreign-queries entity application)</code></div><div class="doc"><pre class="plaintext">Generate any foreign entity queries for this `entity` of this `application`.
|
|
</pre></div></div><div class="public anchor" id="var-insert-query"><h3>insert-query</h3><div class="usage"><code>(insert-query entity)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `insert` query for this `entity`.
|
|
TODO: this depends on the idea that system-unique properties
|
|
are not insertable, which is... dodgy.</pre></div></div><div class="public anchor" id="var-list-query"><h3>list-query</h3><div class="usage"><code>(list-query entity)</code></div><div class="doc"><pre class="plaintext">Generate a query to list records in the table represented by this `entity`.
|
|
Parameters `:limit` and `:offset` may be supplied. If not present limit defaults
|
|
to 100 and offset to 0.</pre></div></div><div class="public anchor" id="var-order-by-clause"><h3>order-by-clause</h3><div class="usage"><code>(order-by-clause entity)</code><code>(order-by-clause entity prefix)</code><code>(order-by-clause entity prefix expanded?)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `order by` clause for queries on this `entity`
|
|
</pre></div></div><div class="public anchor" id="var-queries"><h3>queries</h3><div class="usage"><code>(queries application entity)</code><code>(queries application)</code></div><div class="doc"><pre class="plaintext">Generate all standard queries for this `entity` in this `application`; if
|
|
no entity is specified, generate all queries for the application.</pre></div></div><div class="public anchor" id="var-search-query"><h3>search-query</h3><div class="usage"><code>(search-query entity application)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-select-query"><h3>select-query</h3><div class="usage"><code>(select-query entity properties)</code><code>(select-query entity)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `select` query for this `entity`
|
|
</pre></div></div><div class="public anchor" id="var-to-hugsql-queries"><h3>to-hugsql-queries</h3><div class="usage"><code>(to-hugsql-queries application)</code></div><div class="doc"><pre class="plaintext">Generate all [HugSQL](<a href="https://www.hugsql.org/)">https://www.hugsql.org/)</a> queries implied by this ADL `application` spec.
|
|
</pre></div></div><div class="public anchor" id="var-update-query"><h3>update-query</h3><div class="usage"><code>(update-query entity)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `update` query for this `entity`
|
|
</pre></div></div><div class="public anchor" id="var-where-clause"><h3>where-clause</h3><div class="usage"><code>(where-clause entity)</code><code>(where-clause entity properties)</code></div><div class="doc"><pre class="plaintext">Generate an appropriate `where` clause for queries on this `entity`;
|
|
if `properties` are passed, filter on those properties, otherwise the key
|
|
properties.</pre></div></div></div></body></html> |