yujunjun/knex
1
0
Fork 0
mirror of https://github.com/knex/knex.git synced 2025-12-27 23:18:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating docs for 0.5.0

Browse Source
This commit is contained in:
Tim Griesser 2013-11-25 12:31:42 -05:00
parent 44854ec984
commit 53998e3dd0
3 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clients/server/postgres/schemagrammar.html
View File

@ -55,6 +55,8 @@
<span class="p">},</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>Create the column definition for a integer type.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">typeInteger</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">return</span> <span class="nx">column</span><span class="p">.</span><span class="nx">autoIncrement</span> <span class="o">?</span> <span class="s1">&#39;serial&#39;</span> <span class="o">:</span> <span class="s1">&#39;integer&#39;</span><span class="p">;</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Create the column definition for a bigint type.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">typeBigInteger</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">return</span> <span class="nx">column</span><span class="p">.</span><span class="nx">autoIncrement</span> <span class="o">?</span> <span class="s1">&#39;bigserial&#39;</span> <span class="o">:</span> <span class="s1">&#39;bigint&#39;</span><span class="p">;</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Create the column definition for a tiny integer type.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">typeTinyInteger</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">&#39;smallint&#39;</span><span class="p">;</span>
<span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Create the column definition for a float type.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">typeFloat</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>

6
docs/knex.html
View File

@ -11,6 +11,7 @@ each of which are injected with the current instance, so they maintain
the correct client reference &amp; grammar.</p></div></div><div class="code"><div class="wrapper"> <span class="kd">var</span> <span class="nx">Raw</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./lib/raw&#39;</span><span class="p">).</span><span class="nx">Raw</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">Transaction</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./lib/transaction&#39;</span><span class="p">).</span><span class="nx">Transaction</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">Builder</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./lib/builder&#39;</span><span class="p">).</span><span class="nx">Builder</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;./lib/promise&#39;</span><span class="p">).</span><span class="nx">Promise</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">ClientBase</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./clients/base&#39;</span><span class="p">).</span><span class="nx">ClientBase</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">SchemaBuilder</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./lib/schemabuilder&#39;</span><span class="p">).</span><span class="nx">SchemaBuilder</span><span class="p">;</span>
@ -48,7 +49,10 @@ rather than wait on an async load of a client library.</p></div></div><div class
<code>knex.schema.dropTableIfExists('tableName');</code></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">SchemaInterface</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">val</span><span class="p">,</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">knex</span><span class="p">.</span><span class="nx">schema</span><span class="p">[</span><span class="nx">key</span><span class="p">]</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">schemaBuilder</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">SchemaBuilder</span><span class="p">(</span><span class="nx">knex</span><span class="p">);</span>
<span class="nx">schemaBuilder</span><span class="p">.</span><span class="nx">table</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">first</span><span class="p">(</span><span class="nx">arguments</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">table</span> <span class="o">=</span> <span class="nx">schemaBuilder</span><span class="p">.</span><span class="nx">table</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">first</span><span class="p">(</span><span class="nx">arguments</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">table</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">reject</span><span class="p">(</span><span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">&#39;The table must be defined for the &#39;</span> <span class="o">+</span> <span class="nx">key</span> <span class="o">+</span> <span class="s1">&#39; method.&#39;</span><span class="p">));</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">SchemaInterface</span><span class="p">[</span><span class="nx">key</span><span class="p">].</span><span class="nx">apply</span><span class="p">(</span><span class="nx">schemaBuilder</span><span class="p">,</span> <span class="nx">_</span><span class="p">.</span><span class="nx">rest</span><span class="p">(</span><span class="nx">arguments</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>Method to run a new <code>Raw</code> query on the current client.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">raw</span> <span class="o">=</span> <span class="kd">function</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="p">{</span>

9
index.html
View File

@ -1146,8 +1146,7 @@ knex.schema.table('users', function (table) {
<p id="Schema-increments">
<b class="header">increments</b><code>table.increments(name)</code>
<br />
Adds an auto incrementing column, . This will be used as the primary key for the column.
Also available is a <tt>bigIncrements</tt> if you
Adds an auto incrementing column, in PostgreSQL this is a <tt>serial</tt>. This will be used as the primary key for the column. Also available is a <tt>bigIncrements</tt> if you wish to add a bigint incrementing number (in PostgreSQL <tt>bigserial</tt>).
</p>
<p id="Schema-integer">
@ -1156,10 +1155,11 @@ knex.schema.table('users', function (table) {
Adds an integer column.
</p>
<p id="Schema-integer">
<p id="Schema-bigInteger">
<b class="header">integer</b><code>table.integer(name)</code>
<br />
In MySQL, adds a <tt>bigint</tt> column, otherwise adds a normal integer.
In MySQL or PostgreSQL, adds a <tt>bigint</tt> column,
otherwise adds a normal integer.
</p>
<p id="Schema-text">
@ -1473,6 +1473,7 @@ process.stderr.on('data', function() {
<li>Initial pass at a <a href="#Migrate">migration</a> api.</li>
<li>Aggregate methods are no longer aliased as "aggregate",
but may now be aliased and have more than one aggregate in a query (#108, #110).</li>
<li>Adding bigint and bigserial to PostgreSQL (#111).</li>
<li>Bugfix on increment/decrement values (#100).</li>
<li>Bugfix with having method (#107).</li>
<li>Switched from when.js to <a href="https://github.com/petkaantonov/bluebird">bluebird</a> for promise implementation, with shim for backward compatibility.</li>