API Reference / API Methods / Advanced / Configuring timeouts

Feb. 26, 2019

Configuring Timeouts

Required API Key: no ACL required

Method signature

$config = SearchConfig::create('YourApplicationID', 'YourAdminAPIKey');
$config->setConnectTimeout(integer connectTimeout);
$config->setReadTimeout(integer readTimeout);
$config->setWriteTimeout(integer writeTimeout);

SearchClient::createWithConfig($config);

Algolia.init({
  application_id: 'YourApplicationID',
  api_key: 'YourAdminAPIKey',
  connect_timeout: Integer connectTimeout,
  send_timeout: Integer requestTimeout,
  receive_timeout: Integer readTimeout,
  batch_timeout: Integer searchBatchTimeout,
  search_timeout: Integer searchReadTimeout
})

client.setTimeouts({
  connect: integer connectTimeout,
  read: integer readTimeout,
  write: integer writeTimeout
})

config = SearchConfig('YourApplicationID', 'YourAdminAPIKey')
config.connect_timeout = int connectTimeout
config.read_timeout = int readTimeout
config.write_timeout =  int writeTimeout

client = SearchClient.create_with_config(config)

client.timeout = int readTimeout
client.searchTimeout = int requestTimeout

data class ConfigurationSearch(
    val applicationID: ApplicationID,
    val apiKey: APIKey,
    val writeTimeout: Long = defaultWriteTimeout,
    val readTimeout: Long = defaultReadTimeout,
) : Configuration

client.setConnectTimeout(int connectTimeout)
client.setReadTimeout(int readTimeout)
client.setSearchTimeout(int requestTimeout)
client.setHostDownDelay(int hostDownDelay)

var configuration = new SearchConfig("YourApplicationID", "YourAdminAPIKey")
{
    ReadTimeout = Integer,
    WriteTimeout = Integer
};

SearchConfig config =
    new SearchConfig.Builder("YourApplicationID", "YourAdminAPIKey")
      .setReadTimeOut(Integer writeTimeout)
      .setWriteTimeOut(Integer readTimeout)
      .setConnectTimeOut(Integer connectTimeout)
      .build();

search.NewClientWithConfig(search.Configuration{
  AppID:        "YourApplicationID",
  APIKey:       "YourAdminAPIKey",
  ReadTimeout:  int readTimeout 30 * time.Second,
  WriteTimeout:  int writeTimeout 30 * time.Second,
})

AlgoliaClientConfiguration(
  httpConnectTimeoutMs = int connectTimeout,
  httpReadTimeoutMs = int readTimeout,
  httpRequestTimeoutMs = int requestTimeout,
  dnsTimeoutMs = int dnsTimeout,
  hostDownTimeoutMs = int hostDownDelay
)

See code examples

About this method

Override the pre-configured timeouts.

Network & DNS resolution can be slow. That is why we have pre-configured timeouts. We do not advise to change them, but it could make sense to change them in some special cases.

Note: Not all parameters are available for every language. See Parameters below.

Examples

Copy

$config = SearchConfig::create('YourApplicationID', 'YourAdminAPIKey');
$config->setConnectTimeout(2);
$config->setReadTimeout(30);
$config->setWriteTimeout(30);

SearchClient::createWithConfig($config);

Algolia.init({
  application_id: 'YourApplicationID',
  api_key: 'YourAdminAPIKey',
  connect_timeout: 2,
  send_timeout: 30,
  receive_timeout: 30,
  batch_timeout: 120,  # send_timeout override for batches
  search_timeout: 5    # send_timeout override for queries
})

// at init time:
const client = algoliasearch(appId, apiKey, {
  timeouts: {
    connect: 1000,
    read: 2 * 1000,
    write: 30 * 1000
  }
});

// after initialization:
client.setTimeouts({
  connect: 1000,
  read: 2 * 1000,
  write: 30 * 1000
});

// timers in JavaScript are specified in milliseconds

config = SearchConfig('YourApplicationID', 'YourAdminAPIKey')
config.connect_timeout = 2
config.read_timeout = 30
config.write_timeout =  30

client = SearchClient.create_with_config(config)

APIClient client = new ApiClient(...);
client.setConnectTimeout(2000); // connection timeout
client.setReadTimeout(30000); // read timeout
client.setSearchTimeout(5000) // read timeout for search requests
client.setHostDownDelay(5000); // delay before retrying a host we know was down

SearchConfig configuration =
new SearchConfig.Builder("YourApplicationID", "YourAdminAPIKey")
  .setReadTimeOut(4000) // milliseconds
  .setWriteTimeOut(4000) 
  .setConnectTimeOut(4000)
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

config := search.Configuration{
  AppID:        "YourApplicationID",
  APIKey:       "YourAdminAPIKey",
  ReadTimeout:  30 * time.Second,
  WriteTimeout: 30 * time.Second,
}

client := search.NewClientWithConfig(config)

val configuration = AlgoliaClientConfiguration(
  httpConnectTimeoutMs = 2 * 1000,
  httpReadTimeoutMs = 2 * 1000,
  httpRequestTimeoutMs = 2 * 1000,
  dnsTimeoutMs = 2 * 100,
  hostDownTimeoutMs = 5 * 60 * 1000
)
new AlgoliaClient(applicationId, apiKey, configuration = configuration)

val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourAdminAPIKey"),
    readTimeout = 30,
    writeTimeout = 30
)
ClientSearch(configuration)

Parameters

`connectTimeout`	type: integer default: Optional Timeout for the tcp session to connect. Only available for the following languages: javascript, php, python, ruby, java, android, go, scala.
`readTimeout`	type: integer default: Optional Timeout for the read on the tcp socket. Available in all languages.
`writeTimeout`	type: integer default: Optional Same as requestTimeout but applies only to write operations. Only available for the following languages: javascript, kotlin, csharp.
`hostDownDelay`	type: integer default: Optional The expected period of time for a down host to get back up again. Impacts the time between API Client retries. Only available for the following languages: java, android, scala.
`dnsTimeout`	type: integer default: Optional Timeout for the dns resolution. Only available for the following languages: csharp, scala.
`searchBatchTimeout`	type: integer default: Optional Same as requestTimeout but applies only to batch operations. Only available for the following language: ruby.
`searchReadTimeout`	type: integer default: Optional Same as requestTimeout but applies only to search operations. Only available for the following languages: php, python, ruby.
`requestTimeout`	type: integer default: Optional HTTP timeout for the request. Only available for the following languages: ruby, android, swift, scala.

Response

No response

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Configuring Timeouts

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page