AddAsync() vs Add() in EF Core

Question

Ok multiple questions here:

• I am trying to understand what is the difference (outside the obvious asynchronous) between AddAsync() and Add() methods in EF Core?

• When do you choose one over the other?

• Does it matter if you choose one over the other for consistency?

Answer 1

After going through the code I agree with Henk Holterman's comment that using Add() when your code is async is an optimization. The documentation for AddAsync() is a little misleading when it says, "For all other cases the non async method should be used".

I am trying to understand what is the difference (outside the obvious asynchronous) between AddAsync() and Add() methods in EF Core?

AddAsync() is 100% async safe, while Add() is only async safe in certain conditions. Like the comment implies, one of your columns may be configured such that Entity Framework makes a query to the database to generate the value that will eventually be inserted. In that case, blocking would occur if you called Add().

When do you choose one over the other?

• If you're not writing async code, then definitely use Add().
• If you're writing async code and want to keep things simple, choose AddAsync() just as you would for other methods.
• If you really want to avoid the overhead of async calls and you know Add() will never make a database query, then use Add().

Does it matter if you choose one over the other for consistency?

No, despite the recommendation in the AddAsync() documentation.

Answer 2

From the source code:

This method is async only to allow special value generators, such as the one used by 'Microsoft.EntityFrameworkCore.Metadata.SqlServerValueGenerationStrategy.SequenceHiLo', to access the database asynchronously. For all other cases the non async method should be used.

So if you use a value generator that might need to access the DB to get new values to assign to new entries, such as the SequenceHiLo generator, then use AddAsync().