Scribd
Upload
158 views

Ef Aspnet Cheat Sheet

This document provides a summary of how to use Entity Framework Core (EF Core) to work with databases in .NET applications. It covers installing EF Core, creating data models, defining the database connection string, creating a DbContext class, querying and saving data, and managing the database schema using migrations.

Uploaded by

rtfm pliz
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
158 views

Ef Aspnet Cheat Sheet

This document provides a summary of how to use Entity Framework Core (EF Core) to work with databases in .NET applications. It covers installing EF Core, creating data models, defining the database connection string, creating a DbContext class, querying and saving data, and managing the database schema using migrations.

Uploaded by

rtfm pliz
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

EF/ASP.

NET Core Cheat Sheet


Install EF Core
Documentation...

Install EF Tools globally


dotnet tool install --global dotnet-ef
Update with dotnet tool update --global dotnet-ef (add --version 3.1.0-preview... to install a
prerelease)
dotnet add package Microsoft.EntityFrameworkCore.SqlServer

Choose your DB provider...


dotnet add package Microsoft.EntityFrameworkCore.Design

Create Model
Documentation...
Consider conventions

Property named Id or <type name>Id -> key of an entity


Keys that are int or Guid -> generated values on add
Nullable CLR types (e.g. string , int? , byte[] ) -> optional (string, int?, byte[], etc.)

Not nullable CLR types (e.g. decimal , int , bool ) -> required
Default maximum length is provider-specific. Example: SQL Server strings -> nvarchar(max)
Shadow properties will be auto-created in the DB for foreign keys if no foreign key property is found in
the dependent class.
Index is created for each property that is used as a foreign key
Name of the DbSet<TEntity> property -> table name

, if not property exists, class name -> table name


Default behavior for inheritance: Table-per-Hierarchy (TPH)
Configure your model using...
...Fluent API in DbContext.OnModelCreating or
...Data Annotations
Documentation...

// Fluent API Example:

class MyContext : DbContext


{
   public DbSet<Blog> Blogs { get; set; }

   protected override void OnModelCreating(ModelBuilder modelBuilder)


  {
       modelBuilder.Entity<Blog>()
          .Property(b => b.Url)
          .IsRequired();
  }
}
// Data Annotations Example:

public class Blog


{
   public int BlogId { get; set; }
  [Required]
   public string Url { get; set; }
}

Connection String in appsettings.json


Documentation...
Create appsettings.json file:

{
 "ConnectionStrings": {
   "DefaultConnection": "Server=(localdb)\\dev;Database=AddressBook;Trusted_Connection=True"
}
}

Read connection string in ASP.NET Core's startup class:

public class Startup


{
   private IConfiguration configuration;

   public Startup(IConfiguration configuration)


  {
       this.configuration = configuration;
  }

   public void ConfigureServices(IServiceCollection services)


  {
      ...
       services.AddDbContext<AddressBookContext>(options => options.UseSqlServer(
           Configuration["ConnectionStrings:DefaultConnection"]));
      ...
  }

  ...
}

Create a DbContext
Documentation...
DbContextOptions in Constructor:

public class BloggingContext : DbContext


{
   public BloggingContext(DbContextOptions<BloggingContext> options)
      : base(options)
  { }

   public DbSet<Blog> Blogs { get; set; }


}
Add DbContext to ASP.NET Core Dependency Injection:

public void ConfigureServices(IServiceCollection services)


{
   services.AddDbContext<BloggingContext>(options => options.UseSqlServer(
       configuration["ConnectionStrings:DefaultConnection"]));
}

Option: Add logging (documentation...)

public static readonly ILoggerFactory MyLoggerFactory


   = LoggerFactory.Create(builder => { builder.AddConsole(); });
...

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)


   => optionsBuilder.UseLoggerFactory(MyLoggerFactory);

Option: Switch to Newtonsoft.Json by installing the Microsoft.AspNetCore.Mvc.NewtonsoftJson NuGet


package and adding the following code to Startup.cs (documentation...):

public void ConfigureServices(IServiceCollection services)


{
  ...
   services.AddControllers().AddNewtonsoftJson(settings =>
       settings.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore);
  ...
}

Query Data
Documentation

Task Operation

Load all data ToListAsync

Load single row Single

Filter Where

Load related data Include , ThenInclude , Entry , Collection

No-tracking query AsNoTracking

Raw SQL queries FromSql

Sorting OrderBy , OrderByDescending

Saving Data
Documentation
Task Operation

Add instance Add

Delete instance Remove

Save SaveChangesAsync

Transactions:

using (var transaction = context.Database.BeginTransaction())


{
   try
  {
      ...
       context.SaveChanges();
      ...
       context.SaveChanges();
       transaction.Commit();
  }
   catch (Exception)
  {
       // TODO: Handle failure
  }
}

Set state of external object to modified: context.Entry(obj).State = EntityState.Modified;

Manage DB Schema
Documentation
Add Migration: dotnet ef migrations add <MigrationName>
Update target database: dotnet ef database update
Remove last Migration: dotnet ef migrations remove
Generate SQL script from Migrations: dotnet ef migrations script

You might also like