<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>DocStrap Module: query-builder</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css"> </head> <body> <div class="container-fluid"> <div class="navbar navbar-fixed-top navbar-inverse"> <div class="navbar-inner"> <a class="brand" href="index.html">DocStrap</a> <ul class="nav"> <li class="dropdown"> <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="module-adapter.html">adapter</a> </li> <li> <a href="module-driver.html">driver</a> </li> <li> <a href="module-helpers.html">helpers</a> </li> <li> <a href="module-node-query.html">node-query</a> </li> <li> <a href="module-query-builder.html">query-builder</a> </li> <li> <a href="module-query-parser.html">query-parser</a> </li> <li> <a href="module-State.html">State</a> </li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <h1 class="page-title">Module: query-builder</h1> <section> <header> <h2> query-builder </h2> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-3">line 3</a> </li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Members</h3> <dl> <dt class="name" id="~state"> <h4><span class="type-signature"><private, inner> </span>state<span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Variables controlling the sql building</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-13">line 13</a> </li> </ul> </dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(table, <span class="optional">where</span>, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Run the generated delete query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="description last"><p>The table to insert into</p></td> </tr> <tr> <td class="name"><code>where</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Where clause for delete statement</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>Callback for handling response from the database</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-859">line 859</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> </dd> <dt> <h4 class="name" id="end"><span class="type-signature"></span>end<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Closes the database connection for the current adapter</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-347">line 347</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> </dd> <dt> <h4 class="name" id="from"><span class="type-signature"></span>from<span class="signature">(tableName)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Specify the database table to select from</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>tableName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The table to use for the current query</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-395">line 395</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(<span class="optional">table</span>, <span class="optional">limit</span>, <span class="optional">offset</span>, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Get the results of the compiled query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The table to select from</p></td> </tr> <tr> <td class="name"><code>limit</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>A limit for the query</p></td> </tr> <tr> <td class="name"><code>offset</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>An offset for the query</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>A callback for receiving the result</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-781">line 781</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> </dd> <dt> <h4 class="name" id="getCompiledDelete"><span class="type-signature"></span>getCompiledDelete<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> <p>Return generated delete query SQL</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>the name of the table to delete from</p></td> </tr> <tr> <td class="name"><code>reset</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Whether to reset the query builder so another query can be built</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-921">line 921</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getCompiledInsert"><span class="type-signature"></span>getCompiledInsert<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> <p>Return generated insert query SQL</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>the name of the table to insert into</p></td> </tr> <tr> <td class="name"><code>reset</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Whether to reset the query builder so another query can be built</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-899">line 899</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getCompiledSelect"><span class="type-signature"></span>getCompiledSelect<span class="signature">(<span class="optional">table</span>, <span class="optional">reset</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Return generated select query SQL</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>the name of the table to retrieve from</p></td> </tr> <tr> <td class="name"><code>reset</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Whether to reset the query builder so another query can be built</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-882">line 882</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>String</p> </div> </dd> <dt> <h4 class="name" id="getCompiledUpdate"><span class="type-signature"></span>getCompiledUpdate<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> <p>Return generated update query SQL</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>the name of the table to update</p></td> </tr> <tr> <td class="name"><code>reset</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Whether to reset the query builder so another query can be built</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-910">line 910</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">String</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getState"><span class="type-signature"><private> </span>getState<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> </dt> <dd> <div class="description"> <p>Returns the current class state for testing or other purposes</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-338">line 338</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> </dd> <dt> <h4 class="name" id="groupBy"><span class="type-signature"></span>groupBy<span class="signature">(field)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Group the results by the selected field(s)</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Array</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="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-663">line 663</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="groupEnd"><span class="type-signature"></span>groupEnd<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Ends a logical grouping started with one of the groupStart methods</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-762">line 762</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="groupStart"><span class="type-signature"></span>groupStart<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Adds an open paren to the current query for logical grouping</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-726">line 726</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="having"><span class="type-signature"></span>having<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add a 'having' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the field and the comparision operator, or an object</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The value to compare if the value of key is a string</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-468">line 468</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">(table, <span class="optional">data</span>, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Run the generated insert query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="description last"><p>The table to insert into</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Data to insert, if not already added with the 'set' method</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>Callback for handling response from the database</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-804">line 804</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> </dd> <dt> <h4 class="name" id="insertBatch"><span class="type-signature"></span>insertBatch<span class="signature">(table, data, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Insert multiple sets of rows at a time</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The table to insert into</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>The array of objects containing data rows to insert</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>Callback for handling database response</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-824">line 824</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> <h5>Example</h5> <pre class="sunlight-highlight-javascript">query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}], callbackFunction);</pre> </dd> <dt> <h4 class="name" id="join"><span class="type-signature"></span>join<span class="signature">(table, cond, <span class="optional">type</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add a join clause to the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The table you are joining</p></td> </tr> <tr> <td class="name"><code>cond</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The join condition.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'inner' </td> <td class="description last"><p>The type of join, which defaults to inner</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-638">line 638</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="like"><span class="type-signature"></span>like<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add a 'like/ and like' clause to the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The name of the field to compare to</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value to compare to</p></td> </tr> <tr> <td class="name"><code>pos</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> both </td> <td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-417">line 417</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="limit"><span class="type-signature"></span>limit<span class="signature">(limit, <span class="optional">offset</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Put a limit on the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>limit</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> </td> <td class="description last"><p>The maximum number of rows to fetch</p></td> </tr> <tr> <td class="name"><code>offset</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The row number to start from</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-714">line 714</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="notLike"><span class="type-signature"></span>notLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add a 'not like/ and not like' clause to the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The name of the field to compare to</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value to compare to</p></td> </tr> <tr> <td class="name"><code>pos</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> both </td> <td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-430">line 430</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orderBy"><span class="type-signature"></span>orderBy<span class="signature">(field, <span class="optional">type</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Order the results by the selected field(s)</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The field(s) to order by</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'ASC' </td> <td class="description last"><p>The order direction, ASC or DESC</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-686">line 686</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orGroupStart"><span class="type-signature"></span>orGroupStart<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Adds an open paren to the current query for logical grouping, prefixed with 'OR'</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-739">line 739</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orHaving"><span class="type-signature"></span>orHaving<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add an 'or having' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the field and the comparision operator, or an object</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The value to compare if the value of key is a string</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-482">line 482</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orLike"><span class="type-signature"></span>orLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add an 'or like' clause to the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The name of the field to compare to</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value to compare to</p></td> </tr> <tr> <td class="name"><code>pos</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> both </td> <td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-443">line 443</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orNotGroupStart"><span class="type-signature"></span>orNotGroupStart<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Adds an open paren to the current query for logical grouping, prefixed with 'OR NOT'</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-751">line 751</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orNotLike"><span class="type-signature"></span>orNotLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Add an 'or not like' clause to the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The name of the field to compare to</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value to compare to</p></td> </tr> <tr> <td class="name"><code>pos</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> both </td> <td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-456">line 456</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orWhere"><span class="type-signature"></span>orWhere<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'or where' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the field and the comparision operator, or an object</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The value to compare if the value of key is a string</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-508">line 508</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orWhereIn"><span class="type-signature"></span>orWhereIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'or where in' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>the field to search</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>the array of items to search in</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-576">line 576</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orWhereIsNotNull"><span class="type-signature"></span>orWhereIsNotNull<span class="signature">(field)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Field is not null prefixed with 'OR'</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</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="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-552">line 552</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orWhereIsNull"><span class="type-signature"></span>orWhereIsNull<span class="signature">(field)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Field is null prefixed with 'OR'</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</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="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-541">line 541</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="orWhereNotIn"><span class="type-signature"></span>orWhereNotIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'or where not in' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>the field to search</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>the array of items to search in</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-600">line 600</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="select"><span class="type-signature"></span>select<span class="signature">(fields)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Specify rows to select in the query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Array</span> </td> <td class="description last"><p>The fields to select from the current table</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-361">line 361</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set values for insertion or updating</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>The key or object to use</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The value if using a scalar key</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-612">line 612</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(table, <span class="optional">data</span>, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Run the generated update query</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>table</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> </td> <td class="description last"><p>The table to insert into</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Data to insert, if not already added with the 'set' method</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>Callback for handling response from the database</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-840">line 840</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>void</p> </div> </dd> <dt> <h4 class="name" id="where"><span class="type-signature"></span>where<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'where' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the field and the comparision operator, or an object</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The value to compare if the value of key is a string</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-496">line 496</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="whereIn"><span class="type-signature"></span>whereIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'where in' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>the field to search</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>the array of items to search in</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-564">line 564</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="whereIsNotNull"><span class="type-signature"></span>whereIsNotNull<span class="signature">(field)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Specify that a field IS NOT NULL</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</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="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-530">line 530</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="whereIsNull"><span class="type-signature"></span>whereIsNull<span class="signature">(field)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Select a field that is Null</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The name of the field that has a NULL value</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-519">line 519</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> <dt> <h4 class="name" id="whereNotIn"><span class="type-signature"></span>whereNotIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a 'where not in' clause</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>the field to search</p></td> </tr> <tr> <td class="name"><code>val</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>the array of items to search in</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="query-builder.js.html">query-builder.js</a>, <a href="query-builder.js.html#sunlight-1-line-588">line 588</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>this</p> </div> </dd> </dl> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta1</a> on Wed Jan 28th 2015 using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. </span> </footer> </div> <div class="span3"> <div id="toc"></div> </div> <br clear="both"> </div> </div> <!--<script src="scripts/sunlight.js"></script>--> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "h1,h2,h3,h4", showAndHide : false, scrollTo : "100px" } ); $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); // $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" ); $( ".tutorial-section pre, .readme-section pre" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { lang = "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : true, showMenu : true, enableDoclinks : true } ); } ); </script> <!--Navigation and Symbol Display--> <!--Google Analytics--> </body> </html>