db2objection

db2objection

Generate ObjectionJS (or plain object) models from database tables. (Note: This is an ESM package from v0.1.0)

Install

Install cli globally with npm or your preferred package manager.

$ npm install -g db2objection

Supported databases

db2objection currently supports the following databases:

• MySQL
• PostgreSQL
• SQLite

Commands

(Step 1) Initialize with db2obj init

Create the db2objection config js file. This should be the first step to using db2objection in your project. The config file is where you would configure the database connection parameters that db2objection will use to connect to your database.

Options:
  --reset-config  Reset the config file if it already exists.

Generate models with db2obj generate

Generate ObjectionJS model classes.

Options:
  -c | --case <char>       (snake | camel | ignore) Indicate the naming case for the generated model properties.
  --pojo                   Specify whether plain Typescript model classes will be generated, and not classes extending Objection.js Model class.
  --db, --database <char>  Specify the database to connect to. This overrides the database value that is set in the config file.
  --dir <char>             Specify target directory path relative to the project root.
  --scope <char>           Used to create a folder namespace for generated models.

Test your db connection with db2obj test-connection

This returns "ok" if db2objection is able to connect to the database successfully.

The config file

The db2objection config file is a js module with the following contents:

require('dotenv').config({
    path: '.env'
});

module.exports = {
    /**
     * Knex configurations.
     */
    knex: {
        client: 'mysql2',
        connection: {
            database: process.env.DB_NAME,
            host: process.env.DB_HOST,
            port: process.env.DB_PORT,
            user: process.env.DB_USER,
            password: process.env.DB_PASSWORD
        }
    },

    modelsOutputDir: '__db2obj/generated/', // Relative path where the objection models would be saved. If path does not exist, the default path will be used.

    ignoreTables: [], // Tables to be ignored. e.g. migration tables and other tables used by frameworks.

    case: 'camel' // 'camel' | 'snake' | 'ignore'
};