mirror of
https://github.com/knex/knex.git
synced 2025-12-16 09:38:25 +00:00
58 lines
12 KiB
HTML
58 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><title>lib/dialects/mysql/query</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/mysql/query"><meta name="groc-project-path" content="lib/dialects/mysql/query.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/mysql/query.js</div></div><div id="document"><div class="segment"><div class="comments "><div class="wrapper"><h2 id="mysql-query-builder-amp-compiler">MySQL Query Builder & Compiler</h2></div></div></div><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">'lodash'</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">'inherits'</span><span class="p">);</span>
|
|
<span class="kd">var</span> <span class="nx">QueryBuilder</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../../query/builder'</span><span class="p">);</span>
|
|
<span class="kd">var</span> <span class="nx">QueryCompiler</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../../query/compiler'</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h2 id="query-builder">Query Builder</h2></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Extend the QueryBuilder base class to include the "Formatter"
|
|
which has been defined on the client, as well as the</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">QueryBuilder_MySQL</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">QueryBuilder</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">QueryBuilder_MySQL</span><span class="p">,</span> <span class="nx">QueryBuilder</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h2 id="query-compiler">Query Compiler</h2></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Set the "Formatter" to use for the queries,
|
|
ensuring that all parameterized values (even across sub-queries)
|
|
are properly built into the same query.</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">QueryCompiler_MySQL</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">formatter</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">client</span><span class="p">.</span><span class="nx">Formatter</span><span class="p">();</span>
|
|
<span class="nx">QueryCompiler</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">QueryCompiler_MySQL</span><span class="p">,</span> <span class="nx">QueryCompiler</span><span class="p">);</span>
|
|
|
|
<span class="nx">QueryCompiler_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_emptyInsertValue</span> <span class="o">=</span> <span class="s1">'() values ()'</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Update method, including joins, wheres, order & limits.</p></div></div><div class="code"><div class="wrapper"><span class="nx">QueryCompiler_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">update</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">join</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">join</span><span class="p">();</span>
|
|
<span class="kd">var</span> <span class="nx">updates</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">_prepUpdate</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">single</span><span class="p">.</span><span class="nx">update</span><span class="p">);</span>
|
|
<span class="kd">var</span> <span class="nx">where</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">where</span><span class="p">();</span>
|
|
<span class="kd">var</span> <span class="nx">order</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">order</span><span class="p">();</span>
|
|
<span class="kd">var</span> <span class="nx">limit</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">limit</span><span class="p">();</span>
|
|
<span class="k">return</span> <span class="s1">'update '</span> <span class="o">+</span> <span class="k">this</span><span class="p">.</span><span class="nx">tableName</span> <span class="o">+</span>
|
|
<span class="p">(</span><span class="nx">join</span> <span class="o">?</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nx">join</span> <span class="o">:</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span>
|
|
<span class="s1">' set '</span> <span class="o">+</span> <span class="nx">updates</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s1">', '</span><span class="p">)</span> <span class="o">+</span>
|
|
<span class="p">(</span><span class="nx">where</span> <span class="o">?</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nx">where</span> <span class="o">:</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span>
|
|
<span class="p">(</span><span class="nx">order</span> <span class="o">?</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nx">order</span> <span class="o">:</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span>
|
|
<span class="p">(</span><span class="nx">limit</span> <span class="o">?</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nx">limit</span> <span class="o">:</span> <span class="s1">''</span><span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">QueryCompiler_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">forUpdate</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="s1">'for update'</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
<span class="nx">QueryCompiler_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">forShare</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="s1">'lock in share mode'</span><span class="p">;</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Compiles a <code>columnInfo</code> query.</p></div></div><div class="code"><div class="wrapper"><span class="nx">QueryCompiler_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">columnInfo</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="p">{</span>
|
|
<span class="nx">sql</span><span class="o">:</span> <span class="s1">'select * from information_schema.columns where table_name = ? and table_schema = ?'</span><span class="p">,</span>
|
|
<span class="nx">bindings</span><span class="o">:</span> <span class="p">[</span><span class="k">this</span><span class="p">.</span><span class="nx">single</span><span class="p">.</span><span class="nx">table</span><span class="p">,</span> <span class="nx">client</span><span class="p">.</span><span class="nx">database</span><span class="p">()],</span>
|
|
<span class="nx">output</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">resp</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="nx">_</span><span class="p">.</span><span class="nx">reduce</span><span class="p">(</span><span class="nx">resp</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">columns</span><span class="p">,</span> <span class="nx">val</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">columns</span><span class="p">[</span><span class="nx">val</span><span class="p">.</span><span class="nx">COLUMN_NAME</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="nx">defaultValue</span><span class="o">:</span> <span class="nx">val</span><span class="p">.</span><span class="nx">COLUMN_DEFAULT</span><span class="p">,</span>
|
|
<span class="nx">type</span><span class="o">:</span> <span class="nx">val</span><span class="p">.</span><span class="nx">DATA_TYPE</span><span class="p">,</span>
|
|
<span class="nx">maxLength</span><span class="o">:</span> <span class="nx">val</span><span class="p">.</span><span class="nx">CHARACTER_MAXIMUM_LENGTH</span><span class="p">,</span>
|
|
<span class="nx">nullable</span><span class="o">:</span> <span class="p">(</span><span class="nx">val</span><span class="p">.</span><span class="nx">IS_NULLABLE</span> <span class="o">===</span> <span class="s1">'YES'</span><span class="p">)</span>
|
|
<span class="p">};</span>
|
|
<span class="k">return</span> <span class="nx">columns</span><span class="p">;</span>
|
|
<span class="p">},</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>Set the QueryBuilder & QueryCompiler on the client object,
|
|
incase anyone wants to modify things to suit their own purposes.</p></div></div><div class="code"><div class="wrapper"><span class="nx">client</span><span class="p">.</span><span class="nx">QueryBuilder</span> <span class="o">=</span> <span class="nx">QueryBuilder_MySQL</span><span class="p">;</span>
|
|
<span class="nx">client</span><span class="p">.</span><span class="nx">QueryCompiler</span> <span class="o">=</span> <span class="nx">QueryCompiler_MySQL</span><span class="p">;</span>
|
|
|
|
<span class="p">};</span></div></div></div></div></body></html> |