knex/docs/lib/raw.html
2013-12-12 17:37:44 -05:00

27 lines
5.0 KiB
HTML

<!DOCTYPE html><html lang="en"><head><title>lib/raw</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="lib/raw"><meta name="groc-project-path" content="lib/raw.js"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">lib/raw.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h2 id="raw">Raw</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">_</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;lodash&#39;</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">Common</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./common&#39;</span><span class="p">).</span><span class="nx">Common</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">Raw</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">instance</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">knex</span> <span class="o">=</span> <span class="nx">instance</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">client</span> <span class="o">=</span> <span class="nx">instance</span><span class="p">.</span><span class="nx">client</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">flags</span> <span class="o">=</span> <span class="p">{};</span>
<span class="p">};</span>
<span class="nx">_</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span><span class="nx">Raw</span><span class="p">.</span><span class="nx">prototype</span><span class="p">,</span> <span class="nx">Common</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">_source</span><span class="o">:</span> <span class="s1">&#39;Raw&#39;</span><span class="p">,</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Set the sql and the bindings associated with the query, returning
the current raw object.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">query</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">sql</span><span class="p">,</span> <span class="nx">bindings</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">bindings</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">isArray</span><span class="p">(</span><span class="nx">bindings</span><span class="p">)</span> <span class="o">?</span> <span class="nx">bindings</span> <span class="o">:</span>
<span class="nx">bindings</span> <span class="o">?</span> <span class="p">[</span><span class="nx">bindings</span><span class="p">]</span> <span class="o">:</span> <span class="p">[];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">sql</span> <span class="o">=</span> <span class="nx">sql</span><span class="p">;</span>
<span class="k">return</span> <span class="k">this</span><span class="p">;</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Returns the raw sql for the query.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">toSql</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">sql</span><span class="p">;</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Returns the cleaned bindings for the current raw query.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">getBindings</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">client</span><span class="p">.</span><span class="nx">grammar</span><span class="p">.</span><span class="nx">getBindings</span><span class="p">(</span><span class="k">this</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="nx">exports</span><span class="p">.</span><span class="nx">Raw</span> <span class="o">=</span> <span class="nx">Raw</span><span class="p">;</span></div></div></div></div></body></html>