feat(comment-property): allow column level comments (#4386)

[mirkojotic]

Pull Request check-list

Please make sure to review and check all of these items:

• Does npm run test or npm run test-DIALECT pass with this change (including linting)?
• Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
• Have you added new tests to prevent regressions?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description of change

Re-introducing column level comments for mysql, postgres and mssql (sqlite doesn't support comments) #4386

[sushantdhiman]

Commit is mixed with changes from 7525ef0

Please just include your own changes

[codecov]

Codecov Report

Merging #9573 into master will increase coverage by <.01%.
The diff coverage is 100%.

[mirkojotic]

Removed code from another commit ( sorry about that ). Not sure what to do with mssql test suite failing. It doesn't seem like I've changed at that much and the error seems general. Would appreciate any and all feedback and suggestions.

[sushantdhiman]

LGTM, just need one integration test

https://github.com/sequelize/sequelize/blob/master/test/integration/query-interface.test.js#L147

Modify this test add comment on one or more attributes, assert comment is properly available on all supported dialects as result of describeTable

Need docs in https://github.com/sequelize/sequelize/blob/master/docs/models-definition.md

On top you will see example of attribute definition, please add one more with comment property and a comment that this is only supported for Postgres, MySQL and MSSQL

[mirkojotic]

@sushantdhiman I've added integration tests for mysql and postgres. In order to check for comment field I had to change describeTable statements for both dialects. I can change the mssql statement as well but my tests for mssql integration tests are all failing in docker environment and I've already spent some time exploring why. Since I'm running Ubuntu on my machine I was experiencing difficulties installing it locally.

I will work on documentation. Added an example and a note that it's only available in MySQL, PostgreSQL and MSSQL

[sushantdhiman]

LGTM, one comment and waiting for tests

[sushantdhiman]

For MySQL? override this method in mysql/query-generator instead

New changes as per review

[sushantdhiman]

Since I'm running Ubuntu on my machine I was experiencing difficulties installing it locally.

If you are using docker, you can just

$ cd /to/sequelize/dev/folder
$ docker-compose up -d mssql

# I recommend .only to run only partial test suite as MSSQL image on Ubnutu fails for transactions
$ DIALECT=mssql npm run test-docker-integration

[mirkojotic]

Still needs a bit more work. I'll try to finish it up later today.

[mirkojotic]

@sushantdhiman hopefully this will do. Let me know if I need to make any corrections. Thank you for all the help and feedback!

[theRichu]

In migration process, addColumn and comment is not working

Postgres 10,

        return queryInterface.addColumn(
          {
            schema: 'project',
            tableName: 'scheduleAssigns'
          },
          'timeLogger',
          {
            type: Sequelize.JSONB,
            comment: 'Time Log on JSON',
            defaultValue: {}
          }
        )

Generated Query:

ALTER TABLE "project"."scheduleAssigns" ADD COLUMN "timeLogger" JSONB DEFAULT '{}' COMMENT Time Log on JSON;

I've got ERROR: syntax error at or near "COMMENT"

Should Be:

ALTER TABLE "project"."scheduleAssigns" ADD COLUMN "timeLogger" JSONB DEFAULT '{}'; COMMENT ON "project"."scheduleAssigns"."timeLogger" IS 'Time Log on JSON';

[mirkojotic]

@theRichu PR you are referencing only adds comments as a part of create table statement. It will not work when modifying table definition. Could be added as a separate issue @sushantdhiman

[sushantdhiman]

Now that @theRichu has opened a new PR #10076 we can discuss there