knex/docs/lib/dialects/postgres/runner.html

60 lines
14 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html lang="en"><head><title>lib/dialects/postgres/runner</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/dialects/postgres/runner"><meta name="groc-project-path" content="lib/dialects/postgres/runner.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/dialects/postgres/runner.js</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">)</span> <span class="p">{</span>
<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">inherits</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;inherits&#39;</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">Promise</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../../promise&#39;</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">Runner</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../../runner&#39;</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">utils</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../../utils&#39;</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Inherit from the <code>Runner</code> constructor's prototype,
so we can add the correct <code>then</code> method.</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">Runner_PG</span><span class="p">()</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">client</span><span class="p">;</span>
<span class="nx">Runner</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">inherits</span><span class="p">(</span><span class="nx">Runner_PG</span><span class="p">,</span> <span class="nx">Runner</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">PGQueryStream</span><span class="p">;</span>
<span class="nx">Runner_PG</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_stream</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">method</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">sql</span><span class="p">,</span> <span class="nx">stream</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">PGQueryStream</span> <span class="o">=</span> <span class="nx">PGQueryStream</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;pg-query-stream&#39;</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">runner</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Promise</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">resolver</span><span class="p">,</span> <span class="nx">rejecter</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">stream</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;error&#39;</span><span class="p">,</span> <span class="nx">rejecter</span><span class="p">);</span>
<span class="nx">stream</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;end&#39;</span><span class="p">,</span> <span class="nx">resolver</span><span class="p">);</span>
<span class="nx">runner</span><span class="p">.</span><span class="nx">connection</span><span class="p">.</span><span class="nx">query</span><span class="p">(</span><span class="k">new</span> <span class="nx">PGQueryStream</span><span class="p">(</span><span class="nx">sql</span><span class="p">.</span><span class="nx">sql</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="nx">options</span><span class="p">)).</span><span class="nx">pipe</span><span class="p">(</span><span class="nx">stream</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">});</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Runs the query on the specified connection, providing the bindings
and any other necessary prep work.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Runner_PG</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_query</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">method</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">obj</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">connection</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">connection</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">sql</span> <span class="o">=</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">sql</span> <span class="o">=</span> <span class="nx">utils</span><span class="p">.</span><span class="nx">pgBindings</span><span class="p">(</span><span class="nx">obj</span><span class="p">.</span><span class="nx">sql</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">isDebugging</span><span class="p">())</span> <span class="k">this</span><span class="p">.</span><span class="nx">debug</span><span class="p">(</span><span class="nx">obj</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">obj</span><span class="p">.</span><span class="nx">options</span><span class="p">)</span> <span class="nx">sql</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span><span class="nx">text</span><span class="o">:</span> <span class="nx">sql</span><span class="p">},</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">options</span><span class="p">);</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Promise</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">resolver</span><span class="p">,</span> <span class="nx">rejecter</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">connection</span><span class="p">.</span><span class="nx">query</span><span class="p">(</span><span class="nx">sql</span><span class="p">,</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">bindings</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="k">return</span> <span class="nx">rejecter</span><span class="p">(</span><span class="nx">err</span><span class="p">);</span>
<span class="nx">obj</span><span class="p">.</span><span class="nx">response</span> <span class="o">=</span> <span class="nx">response</span><span class="p">;</span>
<span class="nx">resolver</span><span class="p">(</span><span class="nx">obj</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="p">});</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Ensures the response is returned in the same format as other clients.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Runner_PG</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">processResponse</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">obj</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">obj</span><span class="p">.</span><span class="nx">output</span><span class="p">)</span> <span class="k">return</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">output</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">response</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">resp</span> <span class="o">=</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">response</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">returning</span> <span class="o">=</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">returning</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">resp</span><span class="p">.</span><span class="nx">command</span> <span class="o">===</span> <span class="s1">&#39;SELECT&#39;</span><span class="p">)</span> <span class="k">return</span> <span class="nx">resp</span><span class="p">.</span><span class="nx">rows</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">returning</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">returns</span> <span class="o">=</span> <span class="p">[];</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">l</span> <span class="o">=</span> <span class="nx">resp</span><span class="p">.</span><span class="nx">rows</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">l</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">row</span> <span class="o">=</span> <span class="nx">resp</span><span class="p">.</span><span class="nx">rows</span><span class="p">[</span><span class="nx">i</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">returning</span> <span class="o">===</span> <span class="s1">&#39;*&#39;</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">returning</span><span class="p">))</span> <span class="p">{</span>
<span class="nx">returns</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nx">row</span><span class="p">;</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="nx">returns</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nx">row</span><span class="p">[</span><span class="nx">returning</span><span class="p">];</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">returns</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">resp</span><span class="p">.</span><span class="nx">command</span> <span class="o">===</span> <span class="s1">&#39;UPDATE&#39;</span> <span class="o">||</span> <span class="nx">resp</span><span class="p">.</span><span class="nx">command</span> <span class="o">===</span> <span class="s1">&#39;DELETE&#39;</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">resp</span><span class="p">.</span><span class="nx">rowCount</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">resp</span><span class="p">;</span>
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Assign the newly extended <code>Runner</code> constructor to the client object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">client</span><span class="p">.</span><span class="nx">Runner</span> <span class="o">=</span> <span class="nx">Runner_PG</span><span class="p">;</span>
<span class="p">};</span></div></div></div></div></body></html>