abp/docs/en/Tutorials/Part-7.md

Web Application Development Tutorial - Part 7: Authors: Database Integration

//[doc-params]
{
    "UI": ["MVC","NG"],
    "DB": ["EF","Mongo"]
}

{{ if UI == "MVC" UI_Text="mvc" else if UI == "NG" UI_Text="angular" else UI_Text="?" end if DB == "EF" DB_Text="Entity Framework Core" else if DB == "Mongo" DB_Text="MongoDB" else DB_Text="?" end }}

About This Tutorial

In this tutorial series, you will build an ABP based web application named Acme.BookStore. This application is used to manage a list of books and their authors. It is developed using the following technologies:

• {{DB_Text}} as the ORM provider.
• {{UI_Value}} as the UI Framework.

This tutorial is organized as the following parts;

• Part 1: Creating the server side
• Part 2: The book list page
• Part 3: Creating, updating and deleting books
• Part 4: Integration tests
• Part 5: Authorization
• Part 6: Authors: Domain layer
• Part 7: Authors: Database Integration (this part)
• Part 8: Authors: Application Layer
• Part 9: Authors: User Interface
• Part 10: Book to Author Relation

Download the Source Code

This tutorials has multiple versions based on your UI and Database preferences. We've prepared two combinations of the source code to be downloaded:

• MVC (Razor Pages) UI with EF Core
• Angular UI with MongoDB

Introduction

This part explains how to configure the database integration for the Author entity introduced in the previous part.

{{if DB=="EF"}}

DB Context

Open the BookStoreDbContext in the Acme.BookStore.EntityFrameworkCore project and add the following DbSet property:

public DbSet<Author> Authors { get; set; }

Then open the BookStoreDbContextModelCreatingExtensions class in the same project and add the following lines to the end of the ConfigureBookStore method:

builder.Entity<Author>(b =>
{
    b.ToTable(BookStoreConsts.DbTablePrefix + "Authors",
        BookStoreConsts.DbSchema);
    
    b.ConfigureByConvention();
    
    b.Property(x => x.Name)
        .IsRequired()
        .HasMaxLength(AuthorConsts.MaxNameLength);

    b.HasIndex(x => x.Name);
});

This is just like done for the Book entity before, so no need to explain again.

Create a new Database Migration

Open the Package Manager Console on Visual Studio and ensure that the Default project is Acme.BookStore.EntityFrameworkCore.DbMigrations in the Package Manager Console, as shown on the picture below. Also, set the Acme.BookStore.Web as the startup project (right click it on the solution explorer and click to "Set as Startup Project").

Run the following command to create a new database migration:

This will create a new migration class. Then run the Update-Database command to create the table on the database.

See the Microsoft's documentation for more about the EF Core database migrations.

{{else if DB=="Mongo"}}

DB Context

Open the BookStoreMongoDbContext in the MongoDb folder of the Acme.BookStore.MongoDB project and add the following property to the class:

public IMongoCollection<Author> Authors => Collection<Author>();

{{end}}

Implementing the IAuthorRepository

{{if DB=="EF"}}

Create a new class, named EfCoreAuthorRepository inside the Acme.BookStore.EntityFrameworkCore project (in the Authors folder) and paste the following code:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Dynamic.Core;
using System.Threading.Tasks;
using Acme.BookStore.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore;
using Volo.Abp.Domain.Repositories.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Acme.BookStore.Authors
{
    public class EfCoreAuthorRepository
        : EfCoreRepository<BookStoreDbContext, Author, Guid>,
            IAuthorRepository
    {
        public EfCoreAuthorRepository(
            IDbContextProvider<BookStoreDbContext> dbContextProvider)
            : base(dbContextProvider)
        {
        }

        public async Task<Author> FindByNameAsync(string name)
        {
            return await DbSet.FirstOrDefaultAsync(author => author.Name == name);
        }

        public async Task<List<Author>> GetListAsync(
            int skipCount,
            int maxResultCount,
            string sorting,
            string filter = null)
        {
            return await DbSet
                .WhereIf(
                    !filter.IsNullOrWhiteSpace(),
                    author => author.Name.Contains(filter)
                 )
                .OrderBy(sorting)
                .Skip(skipCount)
                .Take(maxResultCount)
                .ToListAsync();
        }
    }
}

• Inherited from the EfCoreAuthorRepository, so it inherits the standard repository method implementations.
• WhereIf is a shortcut extension method of the ABP Framework. It adds the Where condition only if the first condition meets (it filters by name, only if the filter was provided). You could do the same yourself, but these type of shortcut methods makes our life easier.
• sorting can be a string like Name, Name ASC or Name DESC. It is possible by using the System.Linq.Dynamic.Core NuGet package.

See the EF Core Integration document for more information on the EF Core based repositories.

{{else if DB=="Mongo"}}

Create a new class, named MongoDbAuthorRepository inside the Acme.BookStore.MongoDB project (in the Authors folder) and paste the following code:

using System;
using System.Linq;
using System.Linq.Dynamic.Core;
using System.Collections.Generic;
using System.Threading.Tasks;
using Acme.BookStore.MongoDB;
using MongoDB.Driver;
using MongoDB.Driver.Linq;
using Volo.Abp.Domain.Repositories.MongoDB;
using Volo.Abp.MongoDB;

namespace Acme.BookStore.Authors
{
    public class MongoDbAuthorRepository
        : MongoDbRepository<BookStoreMongoDbContext, Author, Guid>,
        IAuthorRepository
    {
        public MongoDbAuthorRepository(
            IMongoDbContextProvider<BookStoreMongoDbContext> dbContextProvider
            ) : base(dbContextProvider)
        {
        }

        public async Task<Author> FindByNameAsync(string name)
        {
            return await GetMongoQueryable()
                .FirstOrDefaultAsync(author => author.Name == name);
        }

        public async Task<List<Author>> GetListAsync(
            int skipCount,
            int maxResultCount,
            string sorting,
            string filter = null)
        {
            return await GetMongoQueryable()
                .WhereIf<Author, IMongoQueryable<Author>>(
                    !filter.IsNullOrWhiteSpace(),
                    author => author.Name.Contains(filter)
                )
                .OrderBy(sorting)
                .As<IMongoQueryable<Author>>()
                .Skip(skipCount)
                .Take(maxResultCount)
                .ToListAsync();
        }
    }
}

• Inherited from the MongoDbAuthorRepository, so it inherits the standard repository method implementations.
• WhereIf is a shortcut extension method of the ABP Framework. It adds the Where condition only if the first condition meets (it filters by name, only if the filter was provided). You could do the same yourself, but these type of shortcut methods makes our life easier.
• sorting can be a string like Name, Name ASC or Name DESC. It is possible by using the System.Linq.Dynamic.Core NuGet package.

See the MongoDB Integration document for more information on the MongoDB based repositories.

{{end}}

The Next Part

See the next part of this tutorial.