2014-10-20 16:56:45 -04:00
|
|
|
<!DOCTYPE html>
|
2014-10-23 10:53:16 -04:00
|
|
|
|
2014-10-20 16:56:45 -04:00
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
2014-10-23 10:53:16 -04:00
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>DocStrap Index</title>
|
2014-10-20 16:56:45 -04:00
|
|
|
|
2014-10-23 10:53:16 -04:00
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
2014-10-20 16:56:45 -04:00
|
|
|
|
2014-10-23 10:53:16 -04:00
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
2014-10-20 16:56:45 -04:00
|
|
|
|
2014-10-23 10:53:16 -04:00
|
|
|
</head>
|
2014-10-20 16:56:45 -04:00
|
|
|
|
2014-10-23 10:53:16 -04:00
|
|
|
<body>
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
<div class="navbar navbar-fixed-top navbar-inverse">
|
|
|
|
|
<div class="navbar-inner">
|
|
|
|
|
<a class="brand" href="index.html">DocStrap</a>
|
|
|
|
|
<ul class="nav">
|
|
|
|
|
|
|
|
|
|
<li class="dropdown">
|
|
|
|
|
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
|
|
|
|
|
class="caret"></b></a>
|
|
|
|
|
|
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-adapter.html">adapter</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-driver.html">driver</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-helpers.html">helpers</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-node-query.html">node-query</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-query-builder.html">query-builder</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2014-10-27 10:35:44 -04:00
|
|
|
<li>
|
|
|
|
|
<a href="module-query-parser.html">query-parser</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2014-10-23 10:53:16 -04:00
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="span8">
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="page-title">Index</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="readme-section">
|
2014-10-28 14:43:48 -04:00
|
|
|
<article><h1>CI-Node-query</h1><p>A node query builder for various SQL databases, based on CodeIgniter's query builder.</p>
|
2014-10-28 09:05:27 -04:00
|
|
|
<p><a href="https://travis-ci.org/timw4mail/node-query"><img src="https://travis-ci.org/timw4mail/node-query.svg?branch=master" alt="Build Status"></a></p>
|
2014-10-28 09:46:27 -04:00
|
|
|
<h3>Supported adapters</h3><ul>
|
|
|
|
|
<li>mysql</li>
|
|
|
|
|
<li>mysql2</li>
|
|
|
|
|
<li>pg</li>
|
|
|
|
|
</ul>
|
2014-10-28 14:43:48 -04:00
|
|
|
<h3>Installation</h3><pre class="prettyprint source"><code>npm install ci-node-query</code></pre><h3>Basic use</h3><pre class="prettyprint source"><code>var nodeQuery = require('ci-node-query');
|
2014-10-23 10:53:16 -04:00
|
|
|
|
2014-10-23 11:59:42 -04:00
|
|
|
var connection = ... // Database module connection
|
2014-10-23 10:53:16 -04:00
|
|
|
|
|
|
|
|
// Three arguments: database type, database connection, database connection library
|
2014-10-23 11:59:42 -04:00
|
|
|
var query = nodeQuery('mysql', connection, 'mysql2');
|
2014-10-23 10:53:16 -04:00
|
|
|
|
|
|
|
|
query.select('foo')
|
2014-10-20 16:56:45 -04:00
|
|
|
.from('bar')
|
|
|
|
|
.where('x', 3)
|
2014-10-27 17:08:18 -04:00
|
|
|
.orWhere({y: 2})
|
2014-10-27 15:47:22 -04:00
|
|
|
.join('baz', 'baz.boo = bar.foo', 'left')
|
2014-10-27 17:08:18 -04:00
|
|
|
.orderBy('x', 'DESC')
|
2014-10-20 16:56:45 -04:00
|
|
|
.limit(2, 3)
|
2014-10-27 15:47:22 -04:00
|
|
|
.get(function(/* Adapter dependent arguments */) {
|
2014-10-23 10:53:16 -04:00
|
|
|
// Database module result handling
|
2014-10-28 14:43:48 -04:00
|
|
|
});</code></pre><h3>Additional help</h3><ul>
|
|
|
|
|
<li>Generated documentation is in the docs/ folder </li>
|
|
|
|
|
<li><code>tests/query-builder-base.js</code> contains a lot of usage examples</li>
|
|
|
|
|
<li>The <code>tests/adapters</code> folder contains examples of how to set up a connection for the appropriate database library</li>
|
2014-10-30 11:10:47 -04:00
|
|
|
<li>The documentation generated for the latest dev build is also <a href="https://github.timshomepage.net/node-query/docs/">Available</a></li>
|
2014-10-28 14:43:48 -04:00
|
|
|
</ul></article>
|
2014-10-23 10:53:16 -04:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="clearfix"></div>
|
|
|
|
|
<footer>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="copyright">
|
|
|
|
|
DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects.
|
|
|
|
|
</span>
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
<span class="jsdoc-message">
|
|
|
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
|
2014-10-31 11:58:12 -04:00
|
|
|
on Fri Oct 31st 2014 using the <a
|
2014-10-23 10:53:16 -04:00
|
|
|
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
|
|
|
</span>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="span3">
|
|
|
|
|
<div id="toc"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<br clear="both">
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<!--<script src="scripts/sunlight.js"></script>-->
|
|
|
|
|
<script src="scripts/docstrap.lib.js"></script>
|
|
|
|
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
|
|
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
$( function () {
|
|
|
|
|
$( "[id*='$']" ).each( function () {
|
|
|
|
|
var $this = $( this );
|
|
|
|
|
|
|
|
|
|
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
|
|
|
|
} );
|
|
|
|
|
|
|
|
|
|
$( "#toc" ).toc( {
|
|
|
|
|
anchorName : function ( i, heading, prefix ) {
|
|
|
|
|
return $( heading ).attr( "id" ) || ( prefix + i );
|
|
|
|
|
},
|
|
|
|
|
selectors : "h1,h2,h3,h4",
|
|
|
|
|
showAndHide : false,
|
|
|
|
|
scrollTo : "100px"
|
|
|
|
|
} );
|
|
|
|
|
|
|
|
|
|
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
|
|
|
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
|
|
|
$( '.dropdown-toggle' ).dropdown();
|
|
|
|
|
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
|
|
|
|
|
|
|
|
|
|
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
|
|
|
|
|
var $this = $( this );
|
|
|
|
|
|
|
|
|
|
var example = $this.find( "code" );
|
|
|
|
|
exampleText = example.html();
|
|
|
|
|
var lang = /{@lang (.*?)}/.exec( exampleText );
|
|
|
|
|
if ( lang && lang[1] ) {
|
|
|
|
|
exampleText = exampleText.replace( lang[0], "" );
|
|
|
|
|
example.html( exampleText );
|
|
|
|
|
lang = lang[1];
|
|
|
|
|
} else {
|
|
|
|
|
lang = "javascript";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ( lang ) {
|
|
|
|
|
|
|
|
|
|
$this
|
|
|
|
|
.addClass( "sunlight-highlight-" + lang )
|
|
|
|
|
.addClass( "linenums" )
|
|
|
|
|
.html( example.html() );
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
} );
|
|
|
|
|
|
|
|
|
|
Sunlight.highlightAll( {
|
|
|
|
|
lineNumbers : true,
|
|
|
|
|
showMenu : true,
|
|
|
|
|
enableDoclinks : true
|
|
|
|
|
} );
|
|
|
|
|
} );
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Navigation and Symbol Display-->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Google Analytics-->
|
|
|
|
|
|
2014-10-20 16:56:45 -04:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
