eden-mysql v0.0.36
#MySQL
DESCRIPTION
General
Installation
npm install eden-mysql
Usage
var mysql = require('eden-mysql');
var database = mysql('127.0.0.1', 3306, 'edenjs_test', 'root', 'Openovatelabs1234');
Methods
collection
eden/mysql/collection collection();
Returns collection
Parameters
Returns
eden/mysql/collection
Example
Code
database.collection('eden_user')
.add({})
.add({})
.setFoo('bar')
.setUserName('Bobby2')
.setUserEmail('bobby2@gmail.com')
.setUserFacebook(123) });
collection[0].foo;
collection[1].user_email;
Outputs
'bar'
'bobby2@gmail.com'
connect
this connect(Array);
Connects to the database
Parameters
- array - the connection options
Returns
this
Example
Code
var database = mysql('127.0.0.1', 3306, 'edenjs_test', 'root', 'Openovatelabs1234');
var connect = database.connect(['127.0.0.1', 3306, 'edenjs_test', 'root', 'Openovatelabs1234']);
database == connect;
Outputs
true
getConnection
connection resource getConnection(Array);
Returns the connection object if no connection has been made it will attempt to make it
Parameters
- array - connection options
Returns
connection resource
Example
Code
var database = mysql('127.0.0.1', 3306, 'edenjs_test', 'root', 'Openovatelabs1234');
database.getConnection();
Outputs
'127.0.0.1',
3306,
'edenjs_test',
'root',
null
getColumns
this getColumns(String, String|array|function, Function);
Returns the columns and attributes given the table name
Parameters
string - the name of the table
string|array|function
function - callback
Returns
this
Example
Code
database.getColumns('eden_post',
([1, 7, 'Take 5', 'You can work now']),
function(error, row));
row;
Outputs
7
getRow
this getRow(String, String, String, Function);
Returns a 1 row result given the column name and the value
Parameters
string - table
string - name
string - value
function - callback
Returns
this
Example
Code
database.getRow('eden_user', 'user_email', 'bob@gmail.com', function(error, row));
row.user_name;
database.getRow('eden_user', 'user_email', 'dayle@gmail.com', function(error, row));
row;
Outputs
'bobby'
null
insert
eden/mysql/insert insert(String);
Returns the insert query builder
Parameters
- string
Returns
eden/mysql/insert
Example
Code
var query = database.insert('user')
.set('user_name', 'chris')
.set('user_age', 21)
.getQuery();
query = database.insert('user')
.set('user_name', 'chris', 0)
.set('user_age', 21, 0)
.set('user_age', 22, 1)
.getQuery();
query = database.insert('user')
.set({user_name: 'chris', user_age: 21})
.set({user_name: 'dan', user_age: 22}, 1)
.getQuery();
Outputs
'INSERT INTO user (user_name, user_age) VALUES (\'chris\', 21);'
'INSERT INTO user (user_name, user_age) VALUES (\'chris\', 21), (?, 22);'
'INSERT INTO user (user_name, user_age) VALUES (\'chris\', 21), (\'dan\', 22)'
insertRow
this insertRow(String, Object, Array|bool|null, Function);
Inserts data into a table and returns the ID
Parameters
string - table
object - setting
array|bool|null
function - callback
Returns
this
Example
Code
database.insertRow('eden_user', {
user_name: 'bob',
user_email: 'bob@gmail.com',
user_facebook: 123 });
row.insertId > 1;
Outputs
true
insertRows
this insertRows(String, Object, Array|bool|null, Function);
Inserts multiple rows into a table
Parameters
string - table
object - settings
array|bool|null
function - callback
Returns
this
Example
Code
database.insertRows('eden_user', [{
user_name: 'bob',
user_email: 'bob@gmail.com',
user_facebook: 123
}, {
user_name: 'chris',
user_email: 'bob@gmail.com',
user_facebook: 312 }]);
row.insertId > 1;
Outputs
true
model
eden/mysql/model model(String);
Returns model
Parameters
- string
Returns
eden/mysql/model
Example
Code
database.model('eden_user')
.setUserName('Bobby')
.setUserEmail('bobby@gmail.com')
.setUserFacebook(123);
model.setUserName('Billy').save(function(error, model, meta));
error;
Outputs
null
query
this query(String, Array, Function);
Queries the database
Parameters
string - query
array - binded value
function - callback
Returns
this
Example
Code
database.query('SELECT * FROM eden_user');
rows.length > 0;
Outputs
true
remove
eden/mysql/delete remove(String);
Returns the delete query builder
Parameters
- string
Returns
eden/mysql/delete
Example
Code
var query = database
.remove('user')
.where('user_id = ?')
.getQuery();
Outputs
'DELETE FROM user WHERE user_id = ?;'
removeRows
this removeRows(String, Array, Function);
Removes rows that match a filter
Parameters
string - table
array - filter
function - callback
Returns
this
Example
Code
database.removeRows('eden_user',
[['user_email = ?', 'bob@gmail.com']],
function(error, row));
typeof row == 'object';
Outputs
true
select
eden/mysql/select select(String);
Returns the select query builder
Parameters
- string
Returns
eden/mysql/select
Example
Code
var query = database.select('*')
.from('user')
.innerJoin('post', 'post_user=user_id', false)
.where('user_name = ?')
.sortBy('user_name')
.groupBy('user_id')
.limit(1, 2)
.getQuery();
query = database.select('*')
.from('user')
.leftJoin('post', 'post_user=user_id', false)
.where('user_name = ?')
.sortBy('user_name', 'DESC')
.groupBy('user_id')
.limit(1, 2)
.getQuery();
query = database.select('*')
.from('user')
.rightJoin('post', 'post_user=user_id', false)
.where('user_name = ?')
.sortBy('user_name')
.getQuery();
query = database.select('*')
.from('user')
.outerJoin('post', 'post_user')
.where('user_name = ?')
.groupBy('user_id')
.limit(1, 2)
.getQuery();
Outputs
'SELECT * FROM user INNER JOIN post ON (post_user=user_id) '
+ 'WHERE user_name = ? GROUP BY user_id ORDER BY user_name ASC LIMIT 1,2;'
'SELECT * FROM user LEFT JOIN post ON (post_user=user_id) '
+ 'WHERE user_name = ? GROUP BY user_id ORDER BY user_name DESC LIMIT 1,2;'
'SELECT * FROM user RIGHT JOIN post ON (post_user=user_id) '
+ 'WHERE user_name = ? ORDER BY user_name ASC;'
'SELECT * FROM user OUTER JOIN post USING (post_user) '
+ 'WHERE user_name = ? GROUP BY user_id LIMIT 1,2;'
search
eden/mysql/search search();
Returns search
Parameters
Returns
eden/mysql/search
Example
Code
database.search('eden_user')
.addFilter('user_name = ?', 'Christian Blanquera')
.getRow(function(error, row, meta));
row.user_email;
database.search('eden_post')
.innerJoinOn('eden_user', 'post_user=user_id')
.getRows(function(error, rows));
rows.length;
Outputs
'cblanquera@gmail.com'
'number'
setRow
this setRow(String, String, String, Object, Function);
Sets only 1 row given the column name and the value
Parameters
string - table
string - name
string - value
object - setting
function - callback
Returns
this
Example
Code
database.setRow('eden_user', 'user_name', 'Christian Blanquera', {
user_email: 'cblanquera@gmail.com'
}, function(error, row));
row.user_email;
Outputs
'cblanquera@gmail.com'
update
eden/mysql/update update(String);
Returns the update query builder
Parameters
- string
Returns
eden/mysql/update
Example
Code
var query = database.update('user')
.set('user_name', 'chris')
.set('user_age', 21)
.where('user_id = ?')
.where('user_name = ?')
.getQuery();
query = database.update('user')
.set({user_name: 'chris', user_age: 21})
.where(['user_id = ?', 'user_name = ?'])
.getQuery();
Outputs
'UPDATE user SET user_name = \'chris\', user_age = 21 WHERE user_id = ? AND user_name = ?;'
'UPDATE user SET user_name = \'chris\', user_age = 21 WHERE user_id = ? AND user_name = ?;'
updatesRows
this updateRows(String, Object, Array, Array|bool|null, Function);
Updates rows that match a filter given the update settings
Parameters
string - table
object - setting
array - filter
array|bool|null
function - callback
Returns
this
Example
Code
database.updateRows('eden_user', {
user_name: 'bobby'
}, [['user_email = ?, 'bob@gmail.com']]);
typeof row == 'object';
Outputs
true
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago