Allow column comments

[Nosfistis]

I'm submitting a...

• Bug report
• Feature request
• Question

I have not found a way to support comments per column (working on MySQL). I might be missing something, but if not already supported, can it be added?

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[wzrdtales]

Column Comments are completely niche, nearly no one uses them, so it is not really high on prio. However if you want to submit a PR for it, you're welcome.

[Nosfistis]

Implementing this, I should add an entry to both node-db-migrate's interfaces as well as an implementation in the mysql driver, right?

Assuming that a comment can be either a table or a column comment, adding comment would be something like:

exports.up = function (db, callback) {
  db.createTable('pets', {
    columns: {
      id: { type: 'int', primaryKey: true, autoIncrement: true, comment: 'primary key' },
      name: 'string'  // shorthand notation
    },
    comment: 'pets table stores all pets',
    ifNotExists: true
  }, callback);
}

[wzrdtales]

No just the driver, since this is mostly MySQL exclusive stuff, most other dbs don't have that feature. But anyway, no there is no need to touch the interface, rather it would be an extension of alterColumn and createTable.

Your provided example however is ok. The shorthand notation could make sense, but I would put that outside of the scope of this addition and discuss that separately.

You will also need to move table up to the mysql driver directly

https://github.com/db-migrate/db-migrate-base/blob/7af3f80bad7fa5c64509a4435cce68891403c0d1/index.js#L172-L245

And after that you just need to handle comment accordingly.

[Nosfistis]

The sorthand notation is not part of my proposal (I'm sorry for the confusion), rather part of an example taken from the docs.

If I understand your suggestion correctly, that means the createTable logic? Maybe an altering clause after createTable finishes is cleaner:
ALTER TABLE MyTable COMMENT = 'happy comment';

[wzrdtales]

No please keep operations atomic.