In EF Core, how to check whether a migration is needed or not?

Question

I am using Entity Framework Core in an Xamarin.iOS application.

In my core project that contains code (.netstandard 2.0) that is shared between the iOS application and other applications, I would like to know if a migration is needed so that I can perform some other operations as well.

Here is the context:

public void Initialize()
{
   using (var dbContext = new MyDbContext(m_dbContextOptions))
   {
       --> bool isNeeded = demoTapeDbContext.Database.IsMigrationNeeded()

       demoTapeDbContext.Database.Migrate();
   }
}

The closest I have found is calling the method GetPendingMigrationsAsync() and check the amount of pending migrations but I am unsure whether it is the safest way to do such check in Entity Framework:

public async Task InitializeAsync()
{
   using (var dbContext = new MyDbContext(m_dbContextOptions))
   {
       bool isMigrationNeeded = (await demoTapeDbContext.Database.GetPendingMigrationsAsync()).Any();

       demoTapeDbContext.Database.Migrate();
   }
}

Answer 1

You are correct that the GetPendingMigrationsAsync method is what you should use. From the docs:

Asynchronously gets all migrations that are defined in the assembly but haven't been applied to the target database.

If you look at the code, you can trace how it works. It gets all of the migrations defined in your assembly and removes the ones it finds by querying the database.