yujunjun/knex
1
0
Fork 0
mirror of https://github.com/knex/knex.git synced 2025-12-18 10:38:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
knex/docs/lib/schema/builder.html
Tim Griesser f7ad182e68 working on a lot of tooling, migration pieces
2014-05-28 22:29:34 -04:00

34 lines
6.4 KiB
HTML
Raw Blame History

<!DOCTYPE html><html lang="en"><head><title>lib/schema/builder</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/builder"><meta name="groc-project-path" content="lib/schema/builder.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/builder.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">&#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">EventEmitter</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;events&#39;</span><span class="p">).</span><span class="nx">EventEmitter</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Constructor for the builder instance, typically called from
<code>knex.builder</code>, accepting the current <code>knex</code> instance,
and pulling out the <code>client</code> and <code>grammar</code> from the current
knex instance.</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">SchemaBuilder</span><span class="p">()</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_sequence</span> <span class="o">=</span> <span class="p">[];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_errors</span> <span class="o">=</span> <span class="p">[];</span>
<span class="p">}</span>
<span class="nx">inherits</span><span class="p">(</span><span class="nx">SchemaBuilder</span><span class="p">,</span> <span class="nx">EventEmitter</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Each of the schema builder methods just add to the
"_sequence" array for consistency.</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="s1">&#39;createTable&#39;</span><span class="p">,</span> <span class="s1">&#39;table&#39;</span><span class="p">,</span> <span class="s1">&#39;alterTable&#39;</span><span class="p">,</span> <span class="s1">&#39;hasTable&#39;</span><span class="p">,</span> <span class="s1">&#39;hasColumn&#39;</span><span class="p">,</span>
<span class="s1">&#39;dropTable&#39;</span><span class="p">,</span> <span class="s1">&#39;renameTable&#39;</span><span class="p">,</span> <span class="s1">&#39;dropTableIfExists&#39;</span><span class="p">,</span> <span class="s1">&#39;raw&#39;</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">SchemaBuilder</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">method</span> <span class="o">===</span> <span class="s1">&#39;table&#39;</span><span class="p">)</span> <span class="nx">method</span> <span class="o">=</span> <span class="s1">&#39;alterTable&#39;</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_sequence</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
<span class="nx">method</span><span class="o">:</span> <span class="nx">method</span><span class="p">,</span>
<span class="nx">args</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="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>return '[object Knex:SchemaBuilder]';</p></div></div><div class="code"><div class="wrapper"><span class="nx">SchemaBuilder</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">toString</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">toQuery</span><span class="p">();</span>
<span class="p">};</span>
<span class="nx">SchemaBuilder</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">toSQL</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">SchemaCompiler</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">client</span><span class="p">.</span><span class="nx">SchemaCompiler</span><span class="p">;</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">SchemaCompiler</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">toSQL</span><span class="p">();</span>
<span class="p">};</span>
<span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../interface&#39;</span><span class="p">)(</span><span class="nx">SchemaBuilder</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">SchemaBuilder</span><span class="p">;</span></div></div></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink