Skip to content

Latest commit

 

History

History
196 lines (125 loc) · 9.33 KB

new-field.md

File metadata and controls

196 lines (125 loc) · 9.33 KB
Raw
title author description ms.author ms.date uid
Part 7, add a new field
wadepickett
Part 7 of tutorial series on Razor Pages.
wpickett
06/23/2024
tutorials/razor-pages/new-field

Part 7, add a new field to a Razor Page in ASP.NET Core

[!INCLUDE]

By Rick Anderson

:::moniker range=">= aspnetcore-9.0"

In this section Entity Framework Core (EF Core) is used to define the database schema based on the app's model class:

  • Add a new field to the model.
  • Migrate the new field schema change to the database.

The EF Core approach allows for a more agile development process. The developer works on the app's data model directly while the database schema is created and then syncronized, all without the developer having to switch contexts to and from a datbase management tool. For an overview of Entity Framework Core and its benefits, see Entity Framework Core.

Using EF Code to automatically create and track a database:

  • Adds an __EFMigrationsHistory table to the database to track whether the schema of the database is in sync with the model classes it was generated from.
  • Throws an exception if the model classes aren't in sync with the database.

Automatic verification that the schema and model are in sync makes it easier to find inconsistent database code issues.

Adding a Rating Property to the Movie Model

  1. Open the Models/Movie.cs file and add a Rating property: [!code-csharp]

  2. Edit Pages/Movies/Index.cshtml, and add a Rating field: [!code-cshtml]

  3. Update the following pages with a Rating field:

The app won't work until the database is updated to include the new field. Running the app without an update to the database throws a SqlException:

SqlException: Invalid column name 'Rating'.

The SqlException exception is caused by the updated Movie model class being different than the schema of the Movie table of the database. There's no Rating column in the database table.

There are a few approaches to resolving the error:

  1. Have the Entity Framework automatically drop and re-create the database using the new model class schema. This approach is convenient early in the development cycle, it allows developers to quickly evolve the model and database schema together. The downside is that existing data in the database is lost. Don't use this approach on a production database! Dropping the database on schema changes and using an initializer to automatically seed the database with test data is often a productive way to develop an app.
  2. Explicitly modify the schema of the existing database so that it matches the model classes. The advantage of this approach is to keep the data. Make this change either manually or by creating a database change script.
  3. Use EF Core Migrations to update the database schema.

For this tutorial, use EF Core Migrations.

Update the SeedData class so that it provides a value for the new column. A sample change is shown below, but make this change for each new Movie block.

[!code-csharp]

See the completed SeedData.cs file.

Build the app

Visual Studio

Press Ctrl+Shift+B

Visual Studio Code

From the View menu, select Terminal and enter the following command:

dotnet build

Visual Studio

Add a migration for the rating field

  1. From the Tools menu, select NuGet Package Manager > Package Manager Console.

  2. In the Package Manager Console (PMC), enter the following command:

    Add-Migration Rating

The Add-Migration command tells the framework to:

  • Compare the Movie model with the Movie database schema.
  • Create code to migrate the database schema to the new model.

The name "Rating" is arbitrary and is used to name the migration file. It's helpful to use a meaningful name for the migration file.

  1. In the PMC, enter the following command:

    Update-Database

The Update-Database command tells the framework to apply the schema changes to the database and to preserve existing data.

Delete all the records in the database, the initializer will seed the database and include the Rating field. Deleting can be done with the delete links in the browser or from Sql Server Object Explorer (SSOX).

Another option is to delete the database and use migrations to re-create the database. To delete the database in SSOX:

  1. Select the database in SSOX.

  2. Right-click on the database, and select Delete.

  3. Check Close existing connections.

  4. Select OK.

  5. In the PMC, update the database:

    Update-Database

Visual Studio Code

Add a migration for rating

Use the following commands to add a migration for the rating field:

dotnet ef migrations add rating
dotnet ef database update

The dotnet ef migrations add rating command tells the framework to:

  • Compare the Movie model with the Movie database schema.
  • Create code to migrate the database schema to the new model.

The name rating is arbitrary and is used to name the migration file. It's helpful to use a meaningful name for the migration file.

The dotnet ef database update command tells the framework to apply the schema changes to the database and to preserve existing data.

Delete all the records in the database, the initializer will seed the database and include the Rating field.

Optional: Drop and re-create the database for other providers

Skip this section if you successfully migrated the database.

In this tutorial, Entity Framework Core migrations features are used when possible. Migrations updates the database schema to match changes in the data model. However, migrations can only do the kinds of changes that the EF Core provider supports, and some provider's capabilities are limited. For example, adding a column may be supported, but removing or changing a column is not. If a migration is created to remove or change a column, the ef migrations add command succeeds but the ef database update command fails. Due to these limitations, you can drop and re-create the database.

The workaround for the limitations is to manually write migrations code to perform a table rebuild when something in the table changes. A table rebuild involves:

  • Creating a new table.
  • Copying data from the old table to the new table.
  • Dropping the old table.
  • Renaming the new table.

For more information, see the following resources:

  1. Delete the migration folder.

  2. Use the following commands to recreate the database.

    dotnet ef database drop
dotnet ef migrations add InitialCreate
dotnet ef database update

Run the app and verify you can create, edit, and display movies with a Rating field. If the database isn't seeded, set a break point in the SeedData.Initialize method.

Next steps

[!div class="step-by-step"] Previous: Add Search Next: Add Validation

:::moniker-end

[!INCLUDE]

[!INCLUDE]

[!INCLUDE]

[!INCLUDE]

[!INCLUDE]