Prettify JSON - MySQL/MariaDB

Recently I found the need to “prettify” my JSON columns in my database. https://stackoverflow.com/questions/2614862/how-can-i-beautify-json-programmatically

Before (yeesh!)

{"city": "Vassar", "referer": "https://www.google.com/", "state": "MI", "zip": "48768", "country": "US", "latitude": "43.0000", "longitude": "-84.0000", "useragent": { "isBot": false,   "browser": "Safari",   "version": "12.0",   "os": "OS X",   "platform": "iPhone"}}

After (Ahhh!)

{
    "city": "Vassar",
    "referer": "https://www.google.com/",
    "state": "MI",
    "zip": "48768",
    "country": "US",
    "latitude": "43.0000",
    "longitude": "-84.0000",
    "useragent": {
        "isBot": false,
        "browser": "Safari",
        "version": "12.0",
        "os": "OS X",
        "platform": "iPhone"
    }
}

Currently, with Sequelize, the JSON datatype columns are stored as LONGTEXT and the objects are stored as hard to read one liners.

I decided to create global hooks on afterUpdate and afterInsert to autodetect the JSON columns on all models, JSON.stringify’ing with 4 spaces. Now it’s permanently stored as beautiful human readable data, ya dig?

Two writes and one read will occur on models that contain JSON columns.

(Advertisement: https://github.com/HeidiSQL/HeidiSQL viewer rocksfor MySQL/MariaDB/MSSQL! Use it!)

**Full Config **

  var Sequelize = require('sequelize'),
    sequelize = new Sequelize(process.env.db_name, process.env.db_user, process.env.db_pass, {
    host: process.env.db_host,
    port: process.env.db_port,
    dialect: 'mariadb',
    dialectOptions: {
      timezone: process.env.db_timezone
    },
    pool: {
      min: 0,
      max: 2,
      idle: 10000
    },
    define: {
      charset: 'utf8',
      timestamps: false,
      hooks: {
        afterCreate: (model, fn) => {
          formatCols(model)
        },
        afterUpdate: (model, fn) => {
          formatCols(model)
        }
      }
    },
    benchmark: false,
    logging: false
  })
function formatCols(model) {
    for(let json_key in model.rawAttributes) {
      if(model.rawAttributes[json_key].type.key.toUpperCase() == 'JSON') {
        var obj = app.get('functions').objEscapeDblQuotes(model[json_key]),
          json_val = JSON.stringify(obj, null, app.get('json spaces'))
        json_val = json_val.replace(/\\([\s\S])|(")/g, "\\$1$2")
        json_val = json_val.replace(/'/g, "\\'")
        var raw_sql_string = "UPDATE `" + model.constructor.name + "` SET `" + json_key + "` = \'" + json_val + "\' WHERE id = " + model.id
        app.get('sequelize').query(raw_sql_string).then(([results, metadata]) => {
        })
      }
    }
}

[knoxcard]

@papb - agreed, too much for Sequelize, already moved it over to the mariadb driver npm. https://github.com/MariaDB/mariadb-connector-nodejs/issues/68

[papb]

@knoxcard Hmm, I see… Still, I think it’s a bit too specific to be built-in in sequelize. Perhaps you can write a plugin or something?

Also:

@papb - wouldn’t you still need two beforeHooks: beforeUpdate() and beforeUpdate()?

What did you really mean here?