bignosql v0.9.5

bignosql

Smart NoSQL wrapper for SQL.

This isn't a ORM, it just simplify the SQL usage.

Installation

$ npm install --save bignosql

# And one of the following:
$ npm install --save pg # for postgresql
$ npm install --save mysql # for mysql and like mysql

Usage

var bignosql = require('bignosql');

var client = bignosql.connect("pgsql", {
        host: "127.0.0.1",
        port: 5432,
        database: "bignosql",
        user: "vietor",
        password: ""
    }, {
        debug: true
    });

var model = client.model("test", {
        id: bignosql.Number,
        key: bignosql.String,
        value: {
           type: bignosql.Number,
           default: 0
        }
    });

model.insert({key: 'demo', value: 0}, {return: "id"}, function(err, result) {
});
model.find({id: 1}, {id: 1, key: 1, value: 1}, function(err, rows) {
});
model.find({}).select({id: 1, key: 1, value: 1}).sort({id: -1}).skip(0).limit(1).exec(function(err, rows) {
});
model.update({id: 1}, {$inc: {value: 1}}, function(err, count) {
});
model.count({value: {$gt: 0}}, function(err, count) {
});
model.remove({id: 1}, function(err, count) {
});

API

bignosql

Any

The variables definition for Schema Undefined type.
Don't direct usage the variable, it is local usage.

Number

The variables definiton for Schema Number type.

String

The variables definiton for Schema String type.

connect(type, parameters, options)

Connect the sql database, return the Client object

type & parameters

type: pgsql

use pg.pools, parameters details

type: mysql

use mysql.createPool parameters details

Object(Options)

Client

model(name, schema)

Create a model for SQL Table, return Model object.

Object(Schema)

The Schema is a simple object, Key is the column name, Value is a type definition.
The type definition may be a variable or Object(ShemaType).

Object(SchemaType)

Model

insert(doc, options, callback)

Insert one record to table.

Object(InsertOptions)

find(query, fields, callback)

Finds some records from table.

when callback was null, it return Query object

Object(Condition)

{
    "$or": [
        {
            "key": {
                "$in": ["demo", "demo2"]
            }
        }, {
            "value": {
                "gte": 1,
                "lt": 2
            }
        }, {
            "key": {
                "$regex": "^demo.*"
            }
        }
    ]
}

Query

select(fields)

Set required column names. It's a K/V Object, key is column name, V 1 or true was required.

sort(fields)

Set column sort order. It's a K/V Object, key is column name, V 1 was ASC, -1 was DESC.

skip(n)

Set skip row count in table

limit(n)

Set limit row count in result

exec(callback)

callback for result

count(query, callback)

Get count from table.

update(query, update, options, callback)

Update records from table.

Object(UpdateScript)

It was a simple record object like doc in insert, or a complex object.

{
    "$set": {
        "key": "demo"
    },
    "$inc": {
        "value": -9
    }
}

Object(UpdateOptions)

only supoort for pgsql

remove(query, callback)

Remove records from table.

License

MIT