Idempotent Migrations on HasDefaultValueSql or HasComputedColumnSql with line breaks adds whitespace

Open
#20,391 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, sql
Domain
databases

Research direction

Reproduce the issue with HasDefaultValueSql and HasComputedColumnSql values containing line breaks, then run Script-Migration -Idempotent and inspect the generated SQL. Trace the idempotent migration script generation and add coverage showing that multiline SQL preserves its original whitespace without indentation; the workaround should no longer be needed.

Written by the indexing model from the issue text.

Description

area-migrations

If the user creates a model using HasDefaultValueSql(xyz) and the string xyz has line breaks in it, and if the user produces an idempotent SQL script by using Script-Migration -Idemptotent, then extra spaces are added to the value they passed in. E.g. if they call

HasDefaultValueSql("'Don't
GO
this way'")

then the SQL generated will look like this:

IF NOT EXISTS(SELECT * FROM [__EFMigrationsHistory] WHERE [MigrationId] = N'some_migration_identifier')
BEGIN
    CREATE TABLE [TestEntity] (
        [Id] int NOT NULL IDENTITY,
        [Name] nvarchar(max) NULL DEFAULT N'Don''t
    GO
    this way',
        CONSTRAINT [PK_TestEntity] PRIMARY KEY ([Id])
    );
END;

Note that, because of the indentation, extra spaces have been added before 'GO' and 'this way'.

Similarly for HasComputedColumnSql().

But note: there is a workaround - the user can pass the following instead:

HasDefaultValueSql("CONCAT('Don't, CHAR(13), CHAR(10), 'GO', CHAR(13), CHAR(10), 'this way')")
Dominant language
C#
Stars
14.8k
Forks
3.4k
Avg merge
2d 5h
Merged PRs (30d)
134

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/efcore

All issues in dotnet/efcore

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.