mkhanal / knex-case-converter-plugin

Knexjs - convert snake_case column names to camelCase on query and the reverse when using parameters

knex-case-converter-plugin

convert snake_case column names to camelCase on query and the reverse when using parameters

Getting Started

Install it via npm:

npm install knex-case-converter-plugin

Or Yarn it:

yarn add knex-case-converter-plugin

And include in your project:

import plugin from 'knex-case-converter-plugin';

//sample
let knexConfig = {
  "client": "mysql2",
  "debug": true,
  "connection": {
    "host": "localhost",
    "user": "root",
    "password": "root",
    "database": "db_test"
  }
}

Object.assign(knexConfig, plugin)
// OR
//knexConfig.wrapIdentifier = plugin.wrapIdentifier;
//knexConfig.postProcessResponse = plugin.postProcessResponse;

License

GPL-3.0

knex-case-converter-plugin's Issues

Plugin does not update the model attributes on save

When a record will be saved then the save promise doesn't return anymore the model which contains the attributes from the database (id remains undefined...)

const response = await Role.forge({
      title: '12',
      active: 1,
    }).save();


ModelBase {
  attributes: [Object: null prototype] { title: '12', active: 1 },
  _previousAttributes: {},
  changed: [Object: null prototype] {},
  relations: {},
  cid: 'c1',
  _knex: null,
  id: undefined
}

Plugin doesn't seem to work with .raw()

Have you run into any issues where writing queries with knex.raw(...) don't return converted rows?

Currently if I do a query like

database.raw(`
      SELECT associate.*, market_id
      FROM associate
      JOIN store ON store.id = associate.store_id
      JOIN market ON market.id = store.market_id
      WHERE associate.active = true
      AND market.id = ${marketId}
`);

the rows getting returned have fields like market_id.

where when I run the query using knex methods like

database('associate')
      .join('store', 'store.id', '=', 'associate.store_id')
      .join('market', 'market.id', '=', 'store.market_id')
      .where('associate.active', '=', active)
      .andWhere('market.id', '=', marketId)
      .select('associate.*', 'market_id');

the rows returned have camelcase fields like marketId

I am not sure if I am doing anything wrong, any insight would be appreciated.
Thank you