mysql-models-orm v0.0.4

DEVELOPMENT!

This is still in development. DO NOT USE.

MySQL Models ORM

MySQL Models ORM is a package for easy ORM based on models.

Installation

Use NPM to install.

npm i mysql-models-orm

Usage

Database Connection Configuration

One time DB connection configurations. Use it ONCE.

Configure the database manualy:

const { Pool } = require("mysql-models-orm");

Pool.config({
  host: "DB HOST",
  port: "DB PORT",
  database: "DB DATABASE",
  user: "DB USER",
  password: "DB PASSWORD",
});

Or configure it in .env file with the same variable names:

DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=db_name
DB_USER=root
DB_PASSWORD=

Creating a Model

const { Model } = require("mysql-models-orm");

// Create a class model as you desire  */
class YourClassName extends Model {
  constructor() {
    super(); // Must include the super() function inside a constructor!
    // Whatever else you desire to do...
  }
}

Model Properties

Model class properties for settings.

// Set default properties for new rows creation
defaultProperties = {
  someKey: 'some value',
  someDate: 'CURRENT_TIMESTAMP()'
  etc: 'etc...'
}

License

MIT