1 Code-first migrations

Code-first migrations allow you to apply incremental changes to your database schema using code. You can use the EF tools or the Package Manager Console to generate migration classes that contain the logic to update your database. You can also customize the migration code or add seed data. To apply the migrations, you can use the EF tools, the Package Manager Console, or the MigrateDatabaseToLatestVersion initializer. Code-first migrations are useful when you want to have full control over your code and database, and when you work with a source control system.

2 Database-first scaffolding

Database-first scaffolding allows you to generate model classes and a DbContext based on an existing database. You can use the EF tools or the Scaffold-DbContext command to create the model files. You can also specify which tables, views, and stored procedures to include, and how to handle pluralization and naming conventions. Database-first scaffolding is useful when you want to work with a legacy or complex database, or when you don't need to make frequent changes to your schema.

3 Updating your models

Whether you use code-first migrations or database-first scaffolding, you may need to update your models when you make changes to your database or code. For code-first migrations, you can use the Add-Migration and Update-Database commands to create and apply new migrations. You can also use the Remove-Migration command to undo the last migration. For database-first scaffolding, you can use the Update Model from Database option in the EF tools, or run the Scaffold-DbContext command again with the -Force parameter to overwrite the existing model files.

4 Updating your database

Similarly, you may need to update your database when you make changes to your models or code. For code-first migrations, you can use the Update-Database command to apply the pending migrations to your database. You can also use the -Script parameter to generate a SQL script that you can run manually. For database-first scaffolding, you can use the Generate Database from Model option in the EF tools, or use a third-party tool like SQL Server Data Tools (SSDT) to compare and synchronize your schema.

5 Handling conflicts

Sometimes, you may encounter conflicts between your models and database, such as incompatible data types, missing columns, or different constraints. To resolve these conflicts, you need to identify the source of the discrepancy and decide whether to modify your code or your database. For code-first migrations, you can use the -Verbose parameter to see the SQL statements that are executed by the Update-Database command, and compare them with your database schema. For database-first scaffolding, you can use the Model Browser in the EF tools to see the differences between your model and your database.

6 Best practices

To ensure your EF models and database are in sync, it is best to use a consistent naming convention for models, migrations, and database objects. Additionally, data annotations or fluent API should be used to configure models and relationships. Furthermore, it is important to avoid making changes outside of the EF tools or commands. Testing migrations or scaffolding on a local or development database before applying them to a production database is also recommended. Lastly, source control systems should be used to track and manage code and migration files.

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?