Opened 6 months ago

Closed 6 weeks ago

#35839 closed Bug (fixed)

GeneratedField with db_comment causes syntax error

Reported by: Jason Christa Owned by: JaeHyuckSa
Component: Migrations Version: 5.0
Severity: Normal Keywords:
Cc: Jason Christa, Mariusz Felisiak Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no
Pull Requests:19199 merged

Description

Adding a new GeneratedField with the db_comment argument cause invalid SQL to be generated for MySQL (maybe others but that is all I tested). Altering a GeneratedField with a db_comment seems to work fine.

Change History (10)

comment:1 by Simon Charette, 6 months ago

Component: Database layer (models, ORM) → Migrations
Triage Stage: Unreviewed → Accepted

Reproduced with the following test

  • TabularUnified tests/schema/tests.py 

    diff --git a/tests/schema/tests.py b/tests/schema/tests.py
index 33a4bc527b..1dbbd5fe02 100644
    a b def test_add_db_comment_charfield(self):  
    48614861            comment,
    48624862        )
    48634863
     4864    @skipUnlessDBFeature("supports_comments")
     4865    def test_add_db_comment_generated_field(self):
     4866        comment = "Custom comment"
     4867        field = GeneratedField(
     4868            expression=Value(1),
     4869            db_persist=True,
     4870            output_field=IntegerField(),
     4871            db_comment=comment,
     4872        )
     4873        field.set_attributes_from_name("volume")
     4874        with connection.schema_editor() as editor:
     4875            editor.create_model(Author)
     4876            editor.add_field(Author, field)
     4877        self.assertEqual(
     4878            self.get_column_comment(Author._meta.db_table, "volume"),
     4879            comment,
     4880        )
     4881
    48644882    @skipUnlessDBFeature("supports_comments")
    48654883    def test_add_db_comment_and_default_charfield(self):
    48664884        comment = "Custom comment with default"

It appears that the problem is due to the order the the COMMENT and GENERATED clause in the generated SQL.

MySQL expects COMMENT to come after GENERATED while we do the opposite

ALTER TABLE `schema_author` ADD COLUMN `volume` integer COMMENT 'Custom comment' GENERATED ALWAYS AS (1) STORED

Crashes while

ALTER TABLE `schema_author` ADD COLUMN `volume` integer GENERATED ALWAYS AS (1) STORED COMMENT 'Custom comment'

passes.

comment:2 by Simon Charette, 6 months ago

Jason, If you're interested in submitting a patch it seems that the solution lies in changing the order of the generated SQL in _iter_column_sql.

comment:3 by Mariusz Felisiak, 6 months ago

Cc: Mariusz Felisiak added

comment:4 by JasonCalm, 6 months ago

Owner: set to JasonCalm
Status: new → assigned

I'd like to try resolving this ticket!

in reply to:  4 ; comment:5 by Mariusz Felisiak, 5 months ago

Replying to JasonCalm:

I'd like to try resolving this ticket!

Jason, are you working on this? If not, I'd be happy to pass this to my Djangonauts.

in reply to:  5 comment:6 by JasonCalm, 5 months ago

Replying to Mariusz Felisiak:

Replying to JasonCalm:

I'd like to try resolving this ticket!

Jason, are you working on this? If not, I'd be happy to pass this to my Djangonauts.

Yes, I'm currently working on this part!

comment:7 by JaeHyuckSa, 6 weeks ago

Owner: changed from JasonCalm to JaeHyuckSa

comment:8 by JaeHyuckSa, 6 weeks ago

Has patch: set

comment:9 by Mariusz Felisiak, 6 weeks ago

Triage Stage: Accepted → Ready for checkin

comment:10 by Mariusz Felisiak <felisiak.mariusz@…>, 6 weeks ago

Resolution: → fixed
Status: assigned → closed

In f7017db:

Fixed #35839 -- Fixed crash when adding GeneratedField with db_comment on MySQL.

Thanks Simon Charette for the test.

Signed-off-by: saJaeHyukc <wogur981208@…>

Note: See TracTickets for help on using tickets.
Back to Top