SqlCommand.CommandTimeout Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém ou define o tempo de espera (em segundos) antes de encerrar a tentativa de executar um comando e gerar um erro.
public:
virtual property int CommandTimeout { int get(); void set(int value); };public:
property int CommandTimeout { int get(); void set(int value); };public override int CommandTimeout { get; set; }[System.Data.DataSysDescription("DbCommand_CommandTimeout")]
public int CommandTimeout { get; set; }member this.CommandTimeout : int with get, set[<System.Data.DataSysDescription("DbCommand_CommandTimeout")>]
member this.CommandTimeout : int with get, setPublic Overrides Property CommandTimeout As IntegerPublic Property CommandTimeout As IntegerValor da propriedade
O tempo em segundos para aguardar a execução do comando. O padrão é 30 segundos.
Implementações
- Atributos
Comentários
Um valor de 0 indica que nenhum limite (uma tentativa de executar um comando aguardará indefinidamente).
Observação
A CommandTimeout propriedade será ignorada por chamadas de método assíncronas do APM (Modelo de Programação Assíncrona) mais antigas, como BeginExecuteReader. Ele será respeitado por métodos TAP (Programação Assíncrona de Tarefa) mais recentes, como ExecuteReaderAsync.
CommandTimeout não tem efeito quando o comando é executado em uma conexão de contexto (uma SqlConnection aberta com "context connection=true" na cadeia de conexão).
Observação
Essa propriedade é o tempo limite cumulativo (para todos os pacotes de rede que são lidos durante a invocação de um método) para todas as leituras de rede durante a execução do comando ou o processamento dos resultados. Um tempo limite ainda pode ocorrer depois que a primeira linha é retornada e não inclui o tempo de processamento do usuário, apenas o tempo de leitura da rede.
Por exemplo, com um tempo limite de 30 segundos, se Read exigir dois pacotes de rede, ele terá 30 segundos para ler os dois pacotes de rede. Se você ligar Read novamente, ele terá mais 30 segundos para ler os dados necessários.
using System;
using System.Data.SqlClient;
///
public class A {
///
public static void Main() {
string connectionString = "";
// Wait for 5 second delay in the command
string queryString = "waitfor delay '00:00:05'";
using (SqlConnection connection = new SqlConnection(connectionString)) {
connection.Open();
SqlCommand command = new SqlCommand(queryString, connection);
// Setting command timeout to 1 second
command.CommandTimeout = 1;
try {
command.ExecuteNonQuery();
}
catch (SqlException e) {
Console.WriteLine("Got expected SqlException due to command timeout ");
Console.WriteLine(e);
}
}
}
}
