npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wsuite-team/ws-mysql-easy-model

v1.0.50

Published

MySQL Easy Model

Downloads

51

Readme

mysql-easy-model

MySQL Easy Model is a MySQL object modeling tool designed to work in an asynchronous environment.

Installation

Install from npm package:

npm install ws-mysql-easy-model

Or install from git:

npm install git://github.com/mayuri-jatakiya/mysql-easy-model.git

Usage

Connecting to MySQL

First, we need to define a connection.

var mysqlEasyModel = require('ws-mysql-easy-model');

mysqlEasyModel.createConnection({
	connectionLimit : 10,
    host            : 'localhost',
    user            : 'root',
    password		: '',
    database        : 'test'
});

Defining a Model

Models are defined through the name and options object. var User = mysqlEasyModel.model(name, options)

var User = mysqlEasyModel.model('user', {
  table: 'user',
  fields: ['id', 'name', 'email'],
  primary: ['id']
});

Accessing a Model

After define a model, we can access it through the same function. The argument is the name of the your model.

var User = mysqlEasyModel.model('user');

Find

Model.find(selector, callback) Selector and callback are optional.

User.find(function(err, users){
	if(!err) console.log(users);
}

Find with filter

Model.find(selector, callback) Selector and callback are optional.

User.find({id: 1}, function(err, users){
	if(!err) console.log(users);
}

Read a model

model.load(callback) Callback is optional.

var user = new User();
user.id = 1;
user.read(function(err){
  console.log(err);
  if(!err) console.log(user.name);
});

Find with dynamic query

Model.query(sql, params, callback)

User.query('select * from user where email = ?', ['[email protected]'], function(err, users){
	if(!err) console.log(users);
});

Create a new Model

var user = new User({name: 'John Smith', email: '[email protected]'});
user.create(function(err, result){
	if(!err) console.log('created');
});

Find one and update

User.findOne({email: '[email protected]'}, function(err, user){
	if(user){
		//Update the name
		user.name = 'John Smith';

		user.update(function(err, result){
			if(!err) console.log('updated');
		})
	}
});

Update without find

You can set the primary key value and update without finding.

var user = new User({id: 1, name: 'John Smith'});
user.update(function(err, result){
	if(!err) console.log('updated');
});

or

var user = new User();
user.id = 1;
user.name = 'John Smith';
user.update(function(err, result){
	if(!err) console.log('updated');
});

Find one and destroy

User.findOne({email: '[email protected]'}, function(err, user){
	if(user) user.destroy(function(err, result){
		if(!err) console.log('removed');
	});
});

Destroy without find

You can set the primary key value and delete without finding

var user = new User({id: 1});
user.destroy(function(err, result){
	if(!err) console.log('removed');
});

or

var user = new User();
user.id = 1;
user.destroy(function(err, result){
	if(!err) console.log('removed');
});

Examples

Contains runnable sample mysql-easy-model programs.

Bugs

If you'd like to leave feedback, please open an issue on GitHub.

License

mysql-easy-model is released under MIT license.

Credits

mysql-easy-model was created by MAyuri Jatakiya.