dbcrud

Create MySQL-backed REST services in seconds: smart, flexible, automated CRUD and more

npm install dbcrud
3 downloads in the last week
22 downloads in the last month

dbCRUD

Create MySQL-backed REST services in seconds: smart, flexible, automated CRUD and more

Built on node and mysql, optimized for express

Features

  • JavaScript-driven database management
    • dbCRUD creates and manages your database for you, using your JavaScript data model
  • Work with logical object trees
    • dbCRUD knows your data structure and relationships, and it saves and loads entire tree structures automatically
  • Don't think about the database for simple CRUD operations
    • save and retrieve JavaScript objects like you would with Couch or Mongo
  • Utilize the power of SQL when you need it
    • flexible query syntax for more complex logic
  • Automated Express route definitions
    • get a REST server up and running with very little code

Installation

$ npm install dbcrud

The Quick Pitch

Using a fresh MySQL install (no databases defined), this code will create a fully-functional REST service, backed by an automatically managed, queryable, MySQL database:

var express = require('express'),
    server  = express.createServer(),
    client  = require('mysql').createClient({ user:'root' }),
    dbcrud  = require('dbcrud').init(client, 'contacts', {
        families: {
            id: { name: 'id', type: 'id' },
            name: { name: 'name', type: 'varchar(64)', orderBy: true },
            notes: { name: 'notes', type: 'varchar(255)' }
        },
        people: {
            id: { name: 'id', type: 'id' },
            name: { name: 'name', type: 'varchar(64)', nullable: true, orderBy: true },
            family: { name: 'family', type: 'families' }
        }
    });
dbcrud.addRoutes(server);
server.use(express.bodyParser());
server.listen(80);

With just those few lines, the local server will now respond to the following routes and update the database appropriately (as well as create it to begin with):

GET   http://localhost/people/
GET   http://localhost/people/{id}
POST  http://localhost/people/        <- does create or update automatically
GET   http://localhost/families/
GET   http://localhost/families/{id}  <- will also embed associated "people"
POST  http://localhost/families/      <- will also store associated "people"

What dbCRUD Can Do

With dbCRUD, you define your data model as a JavaScript object, such as:

var model = {
    families: {
        id: { name: 'id', type: 'id' },
        name: { name: 'name', type: 'varchar(64)', orderBy: true },
        notes: { name: 'description', type: 'varchar(255)' }
    },
    people: {
        id: { name: 'id', type: 'id' },
        name: { name: 'name', type: 'varchar(64)', nullable: true, orderBy: true },
        family: { name: 'family', type: 'families' }
    }
}

Then you initialize dbCRUD with a mysql client, database name, and the data model:

var client = require('mysql').createClient({ user: 'root', password: '' });
var db = require('dbcrud').init(client, 'contacts', model);

dbCRUD will create the database if it doesn't exist, create each table if it doesn't exist, and create each column if it doesn't exist.

Simple CRUD

Now that dbCRUD knows your data model structure, it exposes simple CRUD methods:

db.fetch(db.model.families, 14, callback);
db.save(db.model.families, myFamily, callback);

The save method will do INSERT or UPDATE as appropriate, based on whether or not the object's ID field has a value. It is also very lenient and will only update fields defined in the JavaScript object. Here is a valid call that will only update the "notes" field of "family" ID 14:

db.save(db.model.families, { id: 14, notes: 'updated notes' }, callback);

Object Trees

dbCRUD is aware of table relations, and it can fetch object trees automatically:

db.fetchTree(db.model.families, 1, callback);

which will return not only the "family" object requested, but will also embed an array of "people" objects which have a foreign-key of that "family" id

db.saveTree(db.model.families, myFamily, callback);

will save not only the "family" object, but its child "people" objects as well, if they are present in an embedded array

Query Syntax

dbCRUD also exposes a more powerful query syntax for returning lists of objects:

db.select({
    from: db.model.people,
    where: { field: db.model.people.name, equals: 'John' },
    orderBy: db.model.people.name,
    success: callback
});

Using Express

In all the above examples, the "callback" method simply takes one parameter: the object or array returned from the database.

If you are using Express, you can pass the response object instead of a callback method, and dbCRUD will automatically send the data it retrieves as the response. This allows you to create one-line REST routes:

app.get('/family/:id', function(request, response)
{
    db.fetchTree(db.model.family, request.params.id, response);
});

In fact, if you only want these simple routes defined for your objects (POST new/update, GET list, GET by id), dbCRUD can automatically generate them for you as well:

db.addRoutes(app);

To Do

Deleting is half-baked at the moment. When you issue a save on any object, if "_destroy" is defined and true in that object, dbCRUD will DELETE it. That's currently the only way to delete, and it works well enough. But clearly some devoted methods are in order.

The "select" syntax is very limited and has much room to expand.

Tree fetch/save is only one level deep, and it might be worthwhile to allow deeper nesting.


License

The MIT License (MIT)

Copyright (c) 2012 John Roers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you