336 lines
6.9 KiB
HTML
336 lines
6.9 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>DocStrap Source: driver.js</title>
|
|
|
|
<!--[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">
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
|
|
|
</head>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="module-query-parser.html">query-parser</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: driver.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre
|
|
class="sunlight-highlight-javascript linenums">'use strict';
|
|
|
|
var helpers = require('./helpers');
|
|
|
|
/**
|
|
* Base Database Driver
|
|
*
|
|
* @module driver
|
|
*/
|
|
var d = {
|
|
identifierChar: '"',
|
|
tablePrefix: null,
|
|
hasTruncate: true,
|
|
|
|
/**
|
|
* Low level function for naive quoting of strings
|
|
|
|
* @param {String} str
|
|
* @return {String}
|
|
* @private
|
|
*/
|
|
_quote: function(str) {
|
|
return (helpers.isString(str) && ! (str.startsWith(d.identifierChar) || str.endsWith(d.identifierChar)))
|
|
? d.identifierChar + str + d.identifierChar
|
|
: str;
|
|
},
|
|
|
|
/**
|
|
* Set the limit clause
|
|
|
|
* @param {String} sql
|
|
* @param {Number} limit
|
|
* @param {Number|null} offset
|
|
* @return {String}
|
|
*/
|
|
limit: function(sql, limit, offset) {
|
|
sql += " LIMIT " + limit;
|
|
|
|
if (helpers.isNumber(offset))
|
|
{
|
|
sql += " OFFSET " + offset;
|
|
}
|
|
|
|
return sql;
|
|
},
|
|
|
|
/**
|
|
* Quote database table name, and set prefix
|
|
*
|
|
* @param {String} table
|
|
* @return {String}
|
|
*/
|
|
quoteTable: function(table) {
|
|
// Quote after prefix
|
|
return d.quoteIdentifiers(table);
|
|
},
|
|
|
|
/**
|
|
* Use the driver's escape character to quote identifiers
|
|
*
|
|
* @param {String|Array}
|
|
* @return {String|Array}
|
|
*/
|
|
quoteIdentifiers: function(str) {
|
|
var hiers, raw;
|
|
var pattern = new RegExp(d.identifierChar + '(' + '([a-zA-Z0-9_]+)' + '(\((.*?)\))' + ')' + d.identifierChar, 'ig');
|
|
|
|
// Recurse for arrays of identifiiers
|
|
if (Array.isArray(str))
|
|
{
|
|
return str.map(d.quoteIdentifiers);
|
|
}
|
|
|
|
// Handle commas
|
|
if (str.contains(','))
|
|
{
|
|
var parts = str.split(',').map(helpers.stringTrim);
|
|
str = parts.map(d.quoteIdentifiers).join(',');
|
|
}
|
|
|
|
// Split identifiers by period
|
|
hiers = str.split('.').map(d._quote);
|
|
raw = hiers.join('.');
|
|
|
|
// Fix functions
|
|
if (raw.contains('(') && raw.contains(')'))
|
|
{
|
|
var funcs = pattern.exec(raw);
|
|
|
|
// Unquote the function
|
|
raw = raw.replace(funcs[0], funcs[1]);
|
|
|
|
// Quote the identifiers inside of the parens
|
|
var inParens = funcs[3].substring(1, funcs[3].length -1);
|
|
raw = raw.replace(inParens, d.quoteIdentifiers(inParens));
|
|
}
|
|
|
|
return raw;
|
|
},
|
|
|
|
/**
|
|
* SQL to truncate the passed table
|
|
*
|
|
* @param {String} table
|
|
* @return {String} - sql
|
|
*/
|
|
truncate: function(table) {
|
|
var sql = (d.hasTruncate)
|
|
? 'TRUNCATE '
|
|
: 'DELETE FROM ';
|
|
|
|
sql += d.quoteTable(table);
|
|
|
|
return sql;
|
|
},
|
|
|
|
/**
|
|
* SQL to insert a group of rows
|
|
*
|
|
* @param {String} table - The table to insert to
|
|
* @param {Array} [data] - The array of object containing data to insert
|
|
* @return {String}
|
|
*/
|
|
insertBatch: function(table, data) {
|
|
|
|
// Get the data values to insert, so they can
|
|
// be parameterized
|
|
var vals = [];
|
|
data.forEach(function(obj) {
|
|
Object.keys(obj).forEach(function(key) {
|
|
vals.push(obj[key]);
|
|
});
|
|
});
|
|
|
|
// Get the field names from the keys of the first
|
|
// object inserted
|
|
var fields = Object.keys(data[0]);
|
|
table = d.quoteTable(table);
|
|
|
|
var sql = "INSERT INTO " + table + " ("
|
|
+ d.quoteIdentifiers(fields).join(",")
|
|
+ ") VALUES ";
|
|
|
|
// Create placeholder groups
|
|
var params = new Array(fields.length).fill('?');
|
|
var paramString = "(" + params.join(',') + ")";
|
|
var paramList = new Array(data.length).fill(paramString);
|
|
|
|
sql += paramList.join(',');
|
|
|
|
return {
|
|
sql: sql,
|
|
values: vals
|
|
};
|
|
}
|
|
|
|
};
|
|
|
|
module.exports = d;</pre>
|
|
</article>
|
|
</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>
|
|
on Mon Dec 1st 2014 using the <a
|
|
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
</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-->
|
|
|
|
|
|
</body>
|
|
</html>
|