yujunjun/knex
1
0
Fork 0
mirror of https://github.com/knex/knex.git synced 2025-08-01 13:22:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
knex/docs/lib/schemainterface.html

33 lines
7.7 KiB
HTML
Raw Normal View History

bumping docs & deps for 0.5.1
2013-12-12 17:37:44 -05:00
<!DOCTYPE html><html lang="en"><head><title>lib/schemainterface</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/schemainterface"><meta name="groc-project-path" content="lib/schemainterface.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/schemainterface.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h2 id="schema-interface">Schema Interface</h2></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>The SchemaInterface are the publically accessible methods
lots of docs & updated comments
2013-09-17 07:15:18 -04:00
when creating or modifying an existing schema, Each of
these methods are mixed into the <code>knex.schema</code> object,
and pass-through to creating a <code>SchemaBuilder</code> instance,
bumping docs & deps for 0.5.1
2013-12-12 17:37:44 -05:00
which is used as the context of the <code>this</code> value below.</p></div></div><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">SchemaInterface</span> <span class="o">=</span> <span class="p">{</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Modify a table on the schema.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">table</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">callback</span><span class="p">(</span><span class="nx">callback</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;table&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Create a new table on the schema.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">createTable</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_addCommand</span><span class="p">(</span><span class="s1">&#39;createTable&#39;</span><span class="p">);</span>
<span class="k">this</span><span class="p">.</span><span class="nx">callback</span><span class="p">(</span><span class="nx">callback</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;createTable&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Drop a table from the schema.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">dropTable</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">_addCommand</span><span class="p">(</span><span class="s1">&#39;dropTable&#39;</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;dropTable&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Drop a table from the schema if it exists.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">dropTableIfExists</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">_addCommand</span><span class="p">(</span><span class="s1">&#39;dropTableIfExists&#39;</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;dropTableIfExists&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Rename a table on the schema.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">renameTable</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">to</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_addCommand</span><span class="p">(</span><span class="s1">&#39;renameTable&#39;</span><span class="p">,</span> <span class="p">{</span><span class="nx">to</span><span class="o">:</span> <span class="nx">to</span><span class="p">});</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;renameTable&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Determine if the given table exists.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">hasTable</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">bindings</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">table</span><span class="p">);</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_addCommand</span><span class="p">(</span><span class="s1">&#39;tableExists&#39;</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;tableExists&#39;</span><span class="p">);</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Determine if the column exists</p></div></div><div class="code"><div class="wrapper"> <span class="nx">hasColumn</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">column</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="p">.</span><span class="nx">push</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">table</span><span class="p">,</span> <span class="nx">column</span><span class="p">);</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_addCommand</span><span class="p">(</span><span class="s1">&#39;columnExists&#39;</span><span class="p">);</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_setType</span><span class="p">(</span><span class="s1">&#39;columnExists&#39;</span><span class="p">);</span>
<span class="p">}</span>
Graduating from docco... onto groc
2013-09-13 13:50:41 -04:00
bumping docs & deps for 0.5.1
2013-12-12 17:37:44 -05:00
<span class="p">};</span>
Graduating from docco... onto groc
2013-09-13 13:50:41 -04:00
bumping docs & deps for 0.5.1
2013-12-12 17:37:44 -05:00
<span class="nx">exports</span><span class="p">.</span><span class="nx">SchemaInterface</span> <span class="o">=</span> <span class="nx">SchemaInterface</span><span class="p">;</span></div></div></div></div></body></html>
Reference in New Issue Copy Permalink