How to set command timeout in aspnetcore/entityframeworkcore

Question

The place where the command timeout is set is no longer the same as earlier versions.

However, I cannot find anywhere that says how to change this.

What I am doing is uploading very large files which takes longer than the default 30 seconds to save.

Note that I ask about Command Timeout, not Migration Timeout as in another question.

Take a look at [How to set Entity Framework Core migration timeout?](http://stackoverflow.com/questions/39006847/how-to-set-entity-framework-core-migration-timeout) - the answer with `Database.SetCommandTimeout` — Ivan Stoev, Aug 20 '16 at 20:50
Possible duplicate of [How to set Entity Framework Core migration timeout?](https://stackoverflow.com/questions/39006847/how-to-set-entity-framework-core-migration-timeout) — Mike Brind, Apr 27 '18 at 14:36

score 143 · Accepted Answer · edited Jul 20 '18 at 19:27

143

If you're using the DI container to manage the DbContext (i.e. you're adding the DbContext to the service collection), the command timeout can be specified in the options.

In Startup.ConfigureServices:

services.AddDbContext<YourDbContext>(options => options.UseSqlServer(
    this.Configuration.GetConnectionString("YourConnectionString"),
    sqlServerOptions => sqlServerOptions.CommandTimeout(60))
);

edited Jul 20 '18 at 19:27

Massimiliano Kraus

3,433
5
24
45

answered Nov 15 '17 at 17:02

Carl Sharman

3,935
1
29
29

1

This is most reasonable approach, uses built in configuration APIs, configuration is decoupled and easy to change, is part of class responsible for configiration. All other offets are sort of hacks. – Edgars Pivovarenoks Dec 30 '20 at 13:46

score 59 · Answer 2 · answered Sep 01 '17 at 06:37

59

you can change it through your context

public class ApplicationDbContext : DbContext
{
    public ApplicationDbContext()
    {
        Database.SetCommandTimeout(150000);
    }
}

answered Sep 01 '17 at 06:37

The Integrator

1,784
1
10
11

Oleg · Answer 3 · 2021-04-28T18:38:21.027

19

If you would like a temporary increase timeout only for one Context instance.

Let's say for 1 request (default Scoped context lifetime)

Change this before long running query:

Context.Database.SetCommandTimeout(TimeSpan.FromMinutes(20))

With scoped lifetime you can specify timeout only once and you do not have to specify it in any subsequent services constructors injections.

edited Apr 28 '21 at 18:38

answered Apr 16 '21 at 00:31

Oleg

1,307
4
23
39

Thanks for your answer which specifically addressed my concern about the lifetime of making such a change. However, I am curious as to how you know the value used in `SetCommandTimeout` is scoped only to the one context provided via DI and not to **every** instance of the context? Do you have a reference to documentation to support this? – Blair Allen Aug 24 '21 at 00:44
where should I put this line? Inside controllers IActionResult, inside using of dbContext statement, inside constructor of dbContext? – usernumber124153 Jan 24 '22 at 10:29

score 7 · Answer 4 · answered Jun 24 '21 at 01:27

In EF Core 3 and above, you can now configure this via connection string. But you need to migrate from 'System.Data.SqlClient' to 'Microsoft.Data.SqlClient'.

Replace System.Data.SqlClient with Microsoft.Data.SqlClient version 2.1.0 or greater.

Then in your connection string simply append the command timeout like so:

"Data Source=SqlExpress;Initial Catalog=YourDatabase;Integrated Security=true;Command Timeout=300"

This will only work with Microsoft.Data.SqlClient 2.1.0 or above, you will get exception if you try this with System.Data.SqlClient.

score 6 · Answer 5 · edited Jan 16 '19 at 09:19

The better option is to use CommandTimeout during your context setup like:

public class DbConnect: IConnnectDb
{
    private dbentitient _context;

    // inject this to a db entity from constructor. 

    //inside each method now use the follow before u actually run the query to db.  

    _context.Database.SetCommandTimeout(400);
}

Note: EF Core will only execute the query with less than 100 seconds time. If it's more than that it keeps retrying and you never get to see the result.

That's my experience as of now, so let me know if you are able to fix it EF Core 1.0 does timeout even more fast than EF Core 2.0.

This doesn't seem to be right. EF Core doesn't retry anything by default? — Kyberias, Apr 13 '21 at 08:32

How to set command timeout in aspnetcore/entityframeworkcore

5 Answers5

Linked