redentities

Red Entities

(Logo attribution)

What it is?

Red Entities is a simple but flexible and fast object-mapper & sql query builder.

This is a subproject of Mantra Framework you can use freely in your own projects.

Red Entities is focused on minimal typing when accesing data and the definition of database models using schemes (simple json objects).

A model is defined in a json object, called schema.

Data access (inserts, selects, removes and updates), are done by selectors for a fast an simple writing of the sentences.

Database engines supported

Tested with:

• PostgreSQL 8.x
• Mysql 5.x
• Mysql 8.x
• Amazon Aurora
• AWS RDS databases based on Mysql
• Sqlite3
• (future integration of Redis, MariaDB, Sql Server, Sql Azure Tables, DynamoDB, etc.)

Thus, has been fully tested with:

• Node.js 10.x
• Node.js 12.x
• Node.js 13.x
• Node.js 14.x
• Node.js 15.x
• Node.js 16.x
• Node.js 17.x

Install

$ npm i redentities --save

Test

Change database configuration providers in file located at:

/test/providersconfig.json

Testing will create many databases and tables.

Then, just run (mocha required):

$ npm run testmysql
$ npm run testsqlite
$ npm run testpostgresql

Basic sample

As a basic introduction, consider this self-explained schema:

const sampleSchema = {
    entities: [
        {
            name : "users",
            fields: [
                { name : "mail", type : "string" },
                { name : "password", type : "string" },
                { name : "created", type : "datetime"}
            ],
            indexes: [ ["mail"], ["created"] ]
        }
    ]
}

Load this schema in an Red Entities object with:

const RedEntities = require("redentities")({
    provider: "mysql",
    host: "localhost",
    user: "myuser",
    password: "mypassword"
});

Create the schema in database with:

await RedEntities.Entities(sampleSchema).CreateSchema();

From now on, you can use Red Entities powers with fast sentences like this:

const db = await RedEntities.Entities(sampleSchema);

const newUserId = await db.users.I().V( { 
    mail: "[e-mail]",
    password: "12345" ).R();

Retrieve an entity with simple sentences like:

const userEntity = await db.users.S().SingleById(userId);

Documentation

• #01 Introduction
• #02 Providers config
• #03 Defining schemas
• #04 Supported types
• #05 Indexes
• #06 Rows ids
• #07 Sample schema
• #08 Creating schemas
• #09 Query shortcuts
• #10 Inserting values
• #11 Selecting values
• #12 Updating values
• #13 Deleting values
• #14 Iterating over values
• #15 Advanced topics

Demos

You can find some demos at /demos folders.

To run them, just

node /demos/<demo name.js>

01-inserts-sample : Insert and retrieve basic values 02-insert-and-iterate : Insert a bulk of values and iterates over them 03-insert-and-deleteall : Insert a bulk of values and removed them 04-json-type : Insert a bulk of json objects and retrieve them

Credits

RedEntities has been fully written by Rafael Gómez Blanes

Professional site at Rafablanes.com

Have a look to my books at Rafa G. Blanes books

License

Licensed under MIT terms.

Copyright (c) 2019-2021:

• Mantra Framework ©
• Rafael Gómez Blanes

Contact an support

You can contact us by GitHub, accesing Mantra web site or at [e-mail].