ABP Suite fails to add basic property #10210

12 Answer(s)

• 

  0

  AI-Bot created 21 days ago

  Support Team ABP Agent

  1. Solution

  • What happened

    • ABP Suite successfully generated code up to the EF Core migration step, then failed when running the command it shows in your log:
      • cd /d "...\src\Aludoc.EntityFrameworkCore" && dotnet ef migrations add Added_Company --startup-project ../Aludoc.HttpApi.Host --output-dir Migrations --context AludocDbContext
    • “Error occurred on DB migration step: Build started...” means the build of your solution (as invoked by dotnet ef) failed. Suite truncates the actual compiler error, so you only see the build started line.

  • Fix it step by step

    1. Reproduce the exact migration command locally to see the full error

       • Open a terminal
       • cd /d C:\Users\alutel\Documents\Projects\Aludoc\src\Aludoc.EntityFrameworkCore
       • Run: dotnet ef migrations add Added_Company --startup-project ../Aludoc.HttpApi.Host --output-dir Migrations --context AludocDbContext
       • You will now get the full build/compile error. Fix that error; then re-run the command until it succeeds. Common issues:
         • Missing or mismatched TargetFramework between projects used by dotnet ef (EntityFrameworkCore and HttpApi.Host).
         • PackageReference mismatches (EF Core / ABP versions must match across projects).
         • A compile error introduced by Suite into:
           • AludocDbContextModelCreatingExtensions or a second similarly named file
           • IAludocDbContext/DbContext interface vs implementation
           • ObjectMapping profiles
           • New DTO/AppService validation attributes
         • Design-time DbContext factory (IDesignTimeDbContextFactory) referencing wrong configuration or failing on module dependencies.
         • A non-supported type in your entity metadata (e.g., Phone as short is often too small for phone numbers; use string).

    2. If you keep two DbContext model-creating extension classes, merge into one

       • Suite expects a single *DbContextModelCreatingExtensions file per DbContext. If you have both “AludocDbContextModelCreatingExtensions” and an additional “AludocCustomDbContextModelCreatingExtensions”, Suite may mis-detect and the generated code can break the build.
       • Quick workaround:
         • Keep a single AludocDbContextModelCreatingExtensions class that contains ConfigureAludoc(ModelBuilder builder) with both generated and custom configuration in order you need.
         • After generation succeeds, you can keep your manual section at the end.

    3. Validate the entity property types and constraints

       • In your JSON, Phone is defined as short. Replace with string to avoid unexpected mapping/validation or UI issues.
       • Ensure all MaxLength attributes are consistent across Domain, DbContext Fluent API, and DTOs.

    4. Ensure references used by dotnet ef build are correct

       • The EF command uses ../Aludoc.HttpApi.Host as startup project. Make sure HttpApi.Host:
         • References the EF Core project (directly or indirectly through the infrastructure chain).
         • Compiles under the same .NET SDK version you’re using from the CLI.
         • Has the same ABP and EF Core versions aligned with the solution.

    5. If you want to generate without DB migration to proceed

       • In ABP Suite for the entity, uncheck “ShouldAddMigration” and “ShouldUpdateDatabase” and Save & Generate again. This lets you generate backend/UI and fix the migration separately once the build error is identified.

    6. After you can run dotnet ef successfully

       • Re-run Save & Generate in Suite with migration enabled, or:
       • Keep handling migrations manually:
         • dotnet ef migrations add <Name> --startup-project ../Aludoc.HttpApi.Host --output-dir Migrations --context AludocDbContext
         • dotnet ef database update --startup-project ../Aludoc.HttpApi.Host --context AludocDbContext

  • Notes aligning with ABP conventions

    • ABP solutions commonly run migrations from the EF Core project with the HttpApi.Host (or DbMigrator) as startup. The failure message you saw is typical when the build fails under dotnet ef context rather than in Visual Studio. Running the same command from terminal reveals the actual compile error to fix.
    • Keeping a single *DbContextModelCreatingExtensions per DbContext avoids Suite’s parser confusion during code-gen.

  2. Sources

  • Database migrations with EF Core in ABP:
    • https://docs.abp.io/en/abp/latest/Entity-Framework-Core#database-migrations

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Save Cancel
• 

  0

  igomez created 21 days ago

  Running in the terminal the proposed steps:

  Reproduce the exact migration command locally to see the full error

  1. Open a terminal
  2. cd /d C:\Users\alutel\Documents\Projects\Aludoc\src\Aludoc.EntityFrameworkCore
  3. Run: dotnet ef migrations add Added_Company --startup-project ../Aludoc.HttpApi.Host --output-dir Migrations --context AludocDbContext

  Gives the following error, and not sure what to do

  

  Save Cancel
• 

  0

  igomez created 21 days ago

  not sure why this is closed, reopening...

  Save Cancel
• 

  0

  EngincanV created 18 days ago

  Support Team .NET Developer

  [igomez] said: not sure why this is closed, reopening...

  Hi, sorry for the inconvenience. Our support bot automatically closes questions due to inactivity. I'll try to reproduce your problem and write back to you asap.

  Regards.

  Save Cancel
• 

  0

  EngincanV created 18 days ago

  Support Team .NET Developer

  Hi again @igomez, I have tried with a tiered solution but could not reproduce the same problem that you faced with. By any chance, can you share your solution via email to support@abp.io website with the ticker number? So, I can check it from your solution. Waiting for your reply.

  Regards.

  Save Cancel
• 

  0

  igomez created 16 days ago

  [EngincanV] said: support@abp.io

  Hi. Done, solution shared by email

  Save Cancel
• 

  0

  EngincanV created 15 days ago

  Support Team .NET Developer

  [igomez] said:

  [EngincanV] said: support@abp.io

  Hi. Done, solution shared by email

  Hi, thank you. I got your email and downloaded the solution yesterday. After I got your solution, today, I've tried to generate new CRUD pages just now, and it successfully generated the required code and migrated to the database (added two new properties, like in the figure below):

  

  

  Your database problem might be related to a temporary connection issue. Or if you have updated the dotnet-ef tool recently, it might be related to that. Can you please check these?

  dotnet-ef --version
  

  dotnet-ef version is 9.0.11 in my machine. It should be 9.0.* to successfully create migrations for v9.x.x. If it's in the correct version, please navigate to your ef core directory and try to create a new migration (via command: dotnet ef migrations add New_Migration) and then run the dbmigrator project to update your database.

  Regards.

  Save Cancel
• 

  0

  igomez created 15 days ago

  Hi,

  As informative: my dotnet-ef version is 9.0.1

  Also in EntityFrameworkCore.csproj we have this versions:

  I've done the following:

  1. From Terminal in my EntityFrameworkCore project, run the dotnet ef migrations add New_Migration and it completed successfully
  2. After that, I opened ABP Suite, added a new navigation and when clicking on "Save and generate" it failed again
  3. Tried from Terminal in EntityFrameworkCore project to clean, restore and build, and got a build error

  I'm not sure how to move forward on this.

  Save Cancel
• 

  0

  igomez created 15 days ago

  Update:

  The build error was because ABP Suite missed adding a property when executing the "Save and generate" process. Manually added in VS and now it compiles, then I build the EntityFramworkCore project and run the DbMigrator with success.

  

  Then when trying to run the solution from VS it fails because of more build errors

  Save Cancel
• 

  0

  EngincanV created 14 days ago

  Support Team .NET Developer

  [igomez] said: Hi,

  As informative: my dotnet-ef version is 9.0.1

  Also in EntityFrameworkCore.csproj we have this versions:

  I've done the following:

  1. From Terminal in my EntityFrameworkCore project, run the dotnet ef migrations add New_Migration and it completed successfully
  2. After that, I opened ABP Suite, added a new navigation and when clicking on "Save and generate" it failed again
  3. Tried from Terminal in EntityFrameworkCore project to clean, restore and build, and got a build error

  I'm not sure how to move forward on this.

  When you add a new property, you should update your DocumentManager.Extended.cs file manually. Because, it's a custom code class and ABP Suite does not make any changes on *.Extended.cs classes. (https://abp.io/docs/latest/suite/customizing-the-generated-code)

  Save Cancel
• 

  0

  igomez created 10 days ago

  Hi Engincan,

  It's not a problem to solve the extended code broken.

  However what we need to understand, and make it work is the ABP Suite. Why does it fails continuously the "Save and generate" process?

  We have repeated the process of deleting the solution, cloning it again, even starting with a blank DB, however does not matter the change we make in the entities, it fails to complete the process.

  What do we need to do to have ABP Suite working with no errors?

  Thanks

  Save Cancel
• 

  0

  EngincanV created 9 days ago

  Support Team .NET Developer

  [igomez] said: Hi Engincan,

  It's not a problem to solve the extended code broken.

  However what we need to understand, and make it work is the ABP Suite.
  Why does it fails continuously the "Save and generate" process?

  We have repeated the process of deleting the solution, cloning it again, even starting with a blank DB, however does not matter the change we make in the entities, it fails to complete the process.

  What do we need to do to have ABP Suite working with no errors?

  Thanks

  Hi, if you select the custom code support option, ABP Suite regenerates only the files that do not end with the *.Extended.cs extension, and it regenerates only the constructors in the extended files when required. Any other changes to these files are your responsibility.

  Does the issue occur in the extended files, or in other files that ABP Suite should normally regenerate but does not? Could you clarify? From what I understand and from what I’ve tried, it seems that the extended files were updated manually, rather than ABP Suite being unable to generate changes elsewhere.

  Regards.

  Save Cancel