Coder Social home page Coder Social logo

gracenode-mysql's Introduction

Mysql Module

Mysql module for gracenode framework.

This is designed to function within gracenode framework.

How to include it in my project

To add this package as your gracenode module, add the following to your package.json:

"dependencies": {
        "gracenode": "",
        "gracenode-mysql": ""
}

To use this module in your application, add the following to your gracenode bootstrap code:

var gracenode = require('gracenode');
// this tells gracenode to load the module
gracenode.use('gracenode-mysql');

To access the module:

// the prefix gracenode- will be removed automatically
gracenode.mysql

Access

gracenode.mysql

Configurations

"modules": {
	"mysql": {
		"configNameOfYourChoice": {
			"read": {
				"database": "databaseName",
				"host": "host or IP address",
				"user": "databaseUser",
				"password": "databasePassword",
				"poolSize": <int optional>,
				"options": {} // optional
			},
			"write": {
				"database": "databaseName",
				"host": "host or IP address",
				"user": "databaseUser",
				"password": "databasePassword",
				"poolSize": <int optional>
				"options": {} // optional
			}
		}{...}
	}
}

Optional Configurations:

gracenode-mysql supports connection options. To add options, add options in your configurations.

#####API: create

MySql create(String configName)

Returns an instance of MySqlGroup class

MySqlGroup class

getOne

void getOne(String sql, Array params, Function callback)

Executes a "select" SQL query and passes a result to callback.

If no result is found, the funtion will throw an error.

var mysql = gracenode.mysql.create('peopleDb');
mysql.getOne('SELECT age, gender FROM people WHERE name = ?', ['bob'], function (error, result) {
	if (error) {
		throw new Error('nothing found');
	}	
	// do something here
});

getOneFromMaster

Reads from "write-only" database.

getMany

void getMany(String sql, Array params, Function callback)

Executes a "select" SQL query and passes results to callback

If no result is found, the function will throw an error.

getManyFromMaster

Reads from "write-only" database.

searchOne

void searchOne(String sql, Array params, Function callback)

Executes a "select" SQL query and passes a result to callback

No result will NOT throw an error.

searchOneFromMaster

Reads from "write-only" database.

searchMany

void searchMany(String sql, Array params, Function callback)

Executes a "select" SQL query and passes results to callback

No result will NOT throw an error.

searchManyFromMaster

Reads from "write-only" database.

write

void write(String sql, Array params, Function callback)

Executes "insert/update/delete/truncate/alter/create/drop/" SQL query

Can NOT be executed if the type is "ro"

transaction

void transaction(Function taskCallback, Function callback)

Creates Mysql transaction and allows you to execute transactional SQL queries in taskCallback.

Commit will be executed automatically on successful execution of taskCallback

An error in taskCallback will cause auto-rollback and ends the transaction.

Can NOT be executed if the type is "ro"

var mysql = gracenode.mysql.create('animalDb');
mysql.transaction(function (transactionMysql, finishCallback) {
	transactionMysql.write('INSERT INTO animal (name, species) VALUES(?, ?)', ['dog', 'knine'], function (error, res) {
		if (error) {
			return finishCallback(error);
		}
		transactionMysql.write('INSERT INTO food (animalName, amount) VALUES(?, ?)', ['dog', 10], function (error, res) {
			if (error) {
				return finishCallback(error);
			}
			// taskCallback is done. now move forward
			finishCallback();
		});
	});
}, 
function (error) {
	if (error) {
		throw new Error(error);
	}
	// All done and committed
});

placeHolder

Array placeHolder(Array params)

Creates and returns an array of ? based on params given.

var mysql = gracenode.create('people');
var params = ['jenny', 'ben', 'krista', 'ken'];
mysql.searchMany('SELECT * FROM people WHERE name IN (' + mylsq.placeHolder(params) + ')', params, function (error, res) {
	if (error) {
		throw new Error(error);
	}	
	// do something here
});

gracenode-mysql's People

Contributors

voltrue2 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.