yujunjun/knex
1
0
Fork 0
mirror of https://github.com/knex/knex.git synced 2025-11-04 03:39:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs prep for release

Browse Source
This commit is contained in:
Tim Griesser 2014-03-19 11:55:59 -04:00
parent 716e3c3019
commit b6e5ba992e
5 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/assets/behavior.js
View File

@ -621,8 +621,8 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3
"type": "heading", "type": "heading",
"data": { "data": {
"level": 2, "level": 2,
"title": "Knex.js 0.5.9", "title": "Knex.js 0.5.10",
"slug": "knexjs-059" "slug": "knexjs-0510"
}, },
"depth": 2 "depth": 2
} }

4
docs/knex.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><title>knex</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="knex"><meta name="groc-project-path" content="knex.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">knex.js</div></div><div id="document"><div class="segment"><div class="comments "><div class="wrapper"><h2 id="knexjs-059">Knex.js 0.5.9</h2></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><pre><code>(c) 2013 Tim Griesser <!DOCTYPE html><html lang="en"><head><title>knex</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="knex"><meta name="groc-project-path" content="knex.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">knex.js</div></div><div id="document"><div class="segment"><div class="comments "><div class="wrapper"><h2 id="knexjs-0510">Knex.js 0.5.10</h2></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><pre><code>(c) 2013 Tim Griesser
Knex may be freely distributed under the MIT license. Knex may be freely distributed under the MIT license.
For details and documentation: For details and documentation:
http://knexjs.org http://knexjs.org
@ -53,7 +53,7 @@ rather than wait on an async load of a client library.</p></div></div><div class
<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> <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>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Raw</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">query</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="k">return</span> <span class="k">new</span> <span class="nx">Raw</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">query</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></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Keep a reference to the current client.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">client</span> <span class="o">=</span> <span class="nx">client</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Keep in sync with package.json</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">VERSION</span> <span class="o">=</span> <span class="s1">&#39;0.5.9&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Runs a new transaction, taking a container and returning a promise <span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Keep a reference to the current client.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">client</span> <span class="o">=</span> <span class="nx">client</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Keep in sync with package.json</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">VERSION</span> <span class="o">=</span> <span class="s1">&#39;0.5.10&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Runs a new transaction, taking a container and returning a promise
for when the transaction is resolved.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">transaction</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">container</span><span class="p">)</span> <span class="p">{</span> for when the transaction is resolved.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">knex</span><span class="p">.</span><span class="nx">transaction</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">container</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Transaction</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">run</span><span class="p">(</span><span class="nx">container</span><span class="p">);</span> <span class="k">return</span> <span class="k">new</span> <span class="nx">Transaction</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">run</span><span class="p">(</span><span class="nx">container</span><span class="p">);</span>
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Attach each of the <code>Migrate</code> "interface" methods directly onto to <code>knex.migrate</code> namespace, e.g.: <span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Attach each of the <code>Migrate</code> "interface" methods directly onto to <code>knex.migrate</code> namespace, e.g.:

1
docs/lib/promise.html
View File

@ -12,6 +12,7 @@
<span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">ensure</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">lastly</span><span class="p">;</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">ensure</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">lastly</span><span class="p">;</span>
<span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">otherwise</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">caught</span><span class="p">;</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">otherwise</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">caught</span><span class="p">;</span>
<span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">exec</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">nodeify</span><span class="p">;</span>
<span class="nx">Promise</span><span class="p">.</span><span class="nx">resolve</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">fulfilled</span><span class="p">;</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">resolve</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">fulfilled</span><span class="p">;</span>
<span class="nx">Promise</span><span class="p">.</span><span class="nx">reject</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">rejected</span><span class="p">;</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">reject</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">rejected</span><span class="p">;</span>

9
index.html
View File

@ -185,7 +185,7 @@
<div id="sidebar" class="interface"> <div id="sidebar" class="interface">
<a class="toc_title" href="#"> <a class="toc_title" href="#">
Knex.js <span class="version">(0.5.9)</span> Knex.js <span class="version">(0.5.10)</span>
</a> </a>
<ul class="toc_section"> <ul class="toc_section">
<li>&raquo; <a href="https://github.com/tgriesser/knex">GitHub Repository</a></li> <li>&raquo; <a href="https://github.com/tgriesser/knex">GitHub Repository</a></li>
@ -375,7 +375,7 @@
</p> </p>
<h2>Latest Release: 0.5.9 - <span class="small"><a href="#changelog">Change Log</a></span></h2> <h2>Latest Release: 0.5.10 - <span class="small"><a href="#changelog">Change Log</a></span></h2>
<p> <p>
Current Develop &mdash; Current Develop &mdash;
@ -1527,6 +1527,11 @@ process.stderr.on('data', function() {
<h2 id="changelog">Change Log</h2> <h2 id="changelog">Change Log</h2>
<p>
<b class="header">0.5.10</b> &mdash; <small><i>Mar 19, 2014</i></small> &mdash; <a href="https://github.com/tgriesser/knex/compare/0.5.9...0.5.10">Diff</a><br />
Add the <tt>.exec</tt> method to the internal promise shim.
</p>
<p> <p>
<b class="header">0.5.9</b> &mdash; <small><i>Mar 18, 2014</i></small> &mdash; <a href="https://github.com/tgriesser/knex/compare/0.5.8...0.5.9">Diff</a><br /> <b class="header">0.5.9</b> &mdash; <small><i>Mar 18, 2014</i></small> &mdash; <a href="https://github.com/tgriesser/knex/compare/0.5.8...0.5.9">Diff</a><br />
Remove error'ed connections from the connection pool (#206), added support for <a href="https://github.com/brianc/node-postgres-pure">node-postgres-pure (pg.js)</a> (#200). Remove error'ed connections from the connection pool (#206), added support for <a href="https://github.com/brianc/node-postgres-pure">node-postgres-pure (pg.js)</a> (#200).

4
knex.js
View File

@ -1,4 +1,4 @@
// Knex.js 0.5.9 // Knex.js 0.5.10
// -------------- // --------------
// (c) 2013 Tim Griesser // (c) 2013 Tim Griesser
@ -88,7 +88,7 @@ var Knex = function(config) {
knex.client = client; knex.client = client;
// Keep in sync with package.json // Keep in sync with package.json
knex.VERSION = '0.5.9'; knex.VERSION = '0.5.10';
// Runs a new transaction, taking a container and returning a promise // Runs a new transaction, taking a container and returning a promise
// for when the transaction is resolved. // for when the transaction is resolved.