mirror of
https://github.com/knex/knex.git
synced 2025-12-16 17:48:31 +00:00
65 lines
13 KiB
HTML
65 lines
13 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><title>lib/schema/columnbuilder</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/schema/columnbuilder"><meta name="groc-project-path" content="lib/schema/columnbuilder.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/schema/columnbuilder.js</div></div><div id="document"><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">'lodash'</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Alias a few methods for clarity when processing.</p></div></div><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">columnAlias</span> <span class="o">=</span> <span class="p">{</span>
|
||
|
|
<span class="s1">'float'</span> <span class="o">:</span> <span class="s1">'floating'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'enum'</span> <span class="o">:</span> <span class="s1">'enu'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'boolean'</span><span class="o">:</span> <span class="s1">'bool'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'string'</span> <span class="o">:</span> <span class="s1">'varchar'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'bigint'</span> <span class="o">:</span> <span class="s1">'bigInteger'</span>
|
||
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>The chainable interface off the original "column" method.</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">ColumnBuilder</span><span class="p">(</span><span class="nx">tableBuilder</span><span class="p">,</span> <span class="nx">type</span><span class="p">,</span> <span class="nx">args</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_single</span> <span class="o">=</span> <span class="p">{};</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_modifiers</span> <span class="o">=</span> <span class="p">{};</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_statements</span> <span class="o">=</span> <span class="p">[];</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_type</span> <span class="o">=</span> <span class="nx">columnAlias</span><span class="p">[</span><span class="nx">type</span><span class="p">]</span> <span class="o">||</span> <span class="nx">type</span><span class="p">;</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_args</span> <span class="o">=</span> <span class="nx">args</span><span class="p">;</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_tableBuilder</span> <span class="o">=</span> <span class="nx">tableBuilder</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>If we're altering the table, extend the object
|
||
|
|
with the available "alter" methods.</p></div></div><div class="code"><div class="wrapper"> <span class="k">if</span> <span class="p">(</span><span class="nx">tableBuilder</span><span class="p">.</span><span class="nx">_method</span> <span class="o">===</span> <span class="s1">'alter'</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="k">this</span><span class="p">,</span> <span class="nx">AlterMethods</span><span class="p">);</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="kd">var</span> <span class="nx">AlterMethods</span> <span class="o">=</span> <span class="p">{};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Specify that the column is to be dropped. This takes precedence
|
||
|
|
over all other rules for the column.</p></div></div><div class="code"><div class="wrapper"><span class="nx">AlterMethods</span><span class="p">.</span><span class="nx">drop</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</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">drop</span> <span class="o">=</span> <span class="kc">true</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>Specify the "type" that we're looking to set the
|
||
|
|
Knex takes no responsibility for any data-loss that may
|
||
|
|
occur when changing data types.</p></div></div><div class="code"><div class="wrapper"><span class="nx">AlterMethods</span><span class="p">.</span><span class="nx">alterType</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">type</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_statements</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
|
||
|
|
<span class="nx">grouping</span><span class="o">:</span> <span class="s1">'alterType'</span><span class="p">,</span>
|
||
|
|
<span class="nx">value</span><span class="o">:</span> <span class="nx">type</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>All of the modifier methods that can be used to modify the current query.</p></div></div><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">modifiers</span> <span class="o">=</span> <span class="p">[</span>
|
||
|
|
<span class="s1">'defaultsTo'</span><span class="p">,</span> <span class="s1">'defaultTo'</span><span class="p">,</span> <span class="s1">'unsigned'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'nullable'</span><span class="p">,</span> <span class="s1">'notNull'</span><span class="p">,</span> <span class="s1">'notNullable'</span><span class="p">,</span>
|
||
|
|
<span class="s1">'after'</span><span class="p">,</span> <span class="s1">'comment'</span>
|
||
|
|
<span class="p">];</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Aliases for convenience.</p></div></div><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">aliasMethod</span> <span class="o">=</span> <span class="p">{</span>
|
||
|
|
<span class="nx">defaultsTo</span><span class="o">:</span> <span class="s1">'defaultTo'</span><span class="p">,</span>
|
||
|
|
<span class="nx">notNull</span><span class="o">:</span> <span class="s1">'notNullable'</span>
|
||
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>If we call any of the modifiers (index or otherwise) on the chainable, we pretend
|
||
|
|
as though we're calling <code>table.method(column)</code> directly.</p></div></div><div class="code"><div class="wrapper"><span class="nx">_</span><span class="p">.</span><span class="nx">each</span><span class="p">(</span><span class="nx">modifiers</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">method</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="nx">ColumnBuilder</span><span class="p">.</span><span class="nx">prototype</span><span class="p">[</span><span class="nx">method</span><span class="p">]</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">aliasMethod</span><span class="p">[</span><span class="nx">method</span><span class="p">])</span> <span class="p">{</span>
|
||
|
|
<span class="nx">method</span> <span class="o">=</span> <span class="nx">aliasMethod</span><span class="p">[</span><span class="nx">method</span><span class="p">];</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">method</span> <span class="o">===</span> <span class="s1">'notNullable'</span><span class="p">)</span> <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">nullable</span><span class="p">(</span><span class="kc">false</span><span class="p">);</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_modifiers</span><span class="p">[</span><span class="nx">method</span><span class="p">]</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">toArray</span><span class="p">(</span><span class="nx">arguments</span><span class="p">);</span>
|
||
|
|
<span class="k">return</span> <span class="k">this</span><span class="p">;</span>
|
||
|
|
<span class="p">};</span>
|
||
|
|
<span class="p">});</span>
|
||
|
|
|
||
|
|
<span class="nx">_</span><span class="p">.</span><span class="nx">each</span><span class="p">([</span><span class="s1">'index'</span><span class="p">,</span> <span class="s1">'primary'</span><span class="p">,</span> <span class="s1">'unique'</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">method</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="nx">ColumnBuilder</span><span class="p">.</span><span class="nx">prototype</span><span class="p">[</span><span class="nx">method</span><span class="p">]</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</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">_type</span><span class="p">.</span><span class="nx">toLowerCase</span><span class="p">().</span><span class="nx">indexOf</span><span class="p">(</span><span class="s1">'increments'</span><span class="p">)</span> <span class="o">===</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">_tableBuilder</span><span class="p">[</span><span class="nx">method</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">_tableBuilder</span><span class="p">,</span>
|
||
|
|
<span class="p">[</span><span class="k">this</span><span class="p">.</span><span class="nx">_args</span><span class="p">[</span><span class="mi">0</span><span class="p">]].</span><span class="nx">concat</span><span class="p">(</span><span class="nx">_</span><span class="p">.</span><span class="nx">toArray</span><span class="p">(</span><span class="nx">arguments</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="p">};</span>
|
||
|
|
<span class="p">});</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Specify that the current column "references" a column,
|
||
|
|
which may be tableName.column or just "column"</p></div></div><div class="code"><div class="wrapper"><span class="nx">ColumnBuilder</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">references</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">value</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">_tableBuilder</span><span class="p">.</span><span class="nx">foreign</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">_tableBuilder</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">_args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="k">this</span><span class="p">)</span>
|
||
|
|
<span class="p">.</span><span class="nx">_columnBuilder</span><span class="p">(</span><span class="k">this</span><span class="p">)</span>
|
||
|
|
<span class="p">.</span><span class="nx">references</span><span class="p">(</span><span class="nx">value</span><span class="p">);</span>
|
||
|
|
<span class="p">};</span>
|
||
|
|
|
||
|
|
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">ColumnBuilder</span><span class="p">;</span></div></div></div></div></body></html>
|