API Reference / API Methods / Advanced / Wait for operations

Feb. 26, 2019

Wait for Operations

Required API Key: any key with the addObject ACL

Method signature

$index->saveObject(...)->wait();
$index->saveObjects(...)->wait();
$index->partialUpdateObject(...)->wait();
$index->partialUpdateObjects(...)->wait();
$index->replaceAllObjects(...)->wait();
$index->deleteObject(...)->wait();
$index->deleteObjects(...)->wait();
$index->deleteBy(...)->wait();
$index->clearObjects(...)->wait();
$index->batch(...)->wait();

$index->setSettings(...)->wait();

$index->saveSynonym(...)->wait();
$index->saveSynonyms(...)->wait();
$index->replaceAllSynonyms(...)->wait();
$index->deleteSynonym(...)->wait();
$index->clearSynonyms(...)->wait();

$index->saveRule(...)->wait();
$index->saveRules(...)->wait();
$index->replaceAllRules(...)->wait();
$index->deleteRule(...)->wait();
$index->clearRules(...)->wait();


$client->moveIndex(...)->wait();
$client->copyIndex(...)->wait();
$client->copyRules(...)->wait();
$client->copySynonyms(...)->wait();
$client->copySettings(...)->wait();

$client->addApiKey(...)->wait();
$client->updateApiKey(...)->wait();
$client->deleteApiKey(...)->wait();
$client->multipleBatch(...)->wait();

index.wait_task(Integer taskID)

index.waitTask(integer taskID, callback)

index.save_object(...).wait()
index.save_objects(...).wait()
index.partial_update_object(...).wait()
index.partial_update_objects(...).wait()
index.replace_all_objects(...).wait()
index.delete_object(...).wait()
index.delete_objects(...).wait()
index.delete_by(...).wait()
index.clear_objects(...).wait()
index.batch(...).wait()

index.set_settings(...).wait()

index.save_synonym(...).wait()
index.save_synonyms(...).wait()
index.replace_all_synonyms(...).wait()
index.delete_synonym(...).wait()
index.clear_synonyms(...).wait()

index.save_rule(...).wait()
index.save_rules(...).wait()
index.replace_all_rules(...).wait()
index.delete_rule(...).wait()
index.clear_rules(...).wait()


client.move_index(...).wait()
client.copy_index(...).wait()
client.copy_rules(...).wait()
client.copy_synonyms(...).wait()
client.copy_settings(...).wait()

client.add_api_key(...).wait()
client.update_api_key(...).wait()
client.delete_api_key(...).wait()
client.multiple_batch(...).wait()

index.waitTask(
  withID: int,
  completionHandler: completionHandler
)
index.waitTask(
  withID: int,
  requestOptions: RequestOptions,
  completionHandler: completionHandler
)

suspend fun waitTask(
    taskID: TaskID,
    timeout: Long? = null,
    requestOptions: RequestOptions? = null
): TaskStatus

suspend fun Task.wait(
    timeout: Long? = null,
    requestOptions: RequestOptions? = null
): TaskStatus

suspend fun List<Task>.wait(
    timeout: Long? = null,
    requestOptions: RequestOptions? = null
): List<TaskStatus>

index.waitTask(int taskID, completionHandler)

index.SaveObject(...).Wait();
index.SaveObjects(...).Wait();
index.PartialUpdateObject(...).Wait();
index.PartialUpdateObjects(...).Wait();
index.ReplaceAllObjects(...).Wait();
index.DeleteObject(...).Wait();
index.DeleteObjects(...).Wait();
index.DeleteBy(...).Wait();
index.ClearObjects(...).Wait();
index.Batch(...).Wait();

index.SetSettings(...).Wait();

index.SaveSynonym(...).Wait();
index.SaveSynonyms(...).Wait();
index.ReplaceAllSynonyms(...).Wait();
index.DeleteSynonym(...).Wait();
index.ClearSynonyms(...).Wait();

index.SaveRule(...).Wait();
index.SaveRules(...).Wait();
index.ReplaceAllRules(...).Wait();
index.DeleteRule(...).Wait();
index.ClearRules(...).Wait();


client.MoveIndex(...).Wait();
client.CopyIndex(...).Wait();
client.CopyRules(...).Wait();
client.CopySynonyms(...).Wait();
client.CopySettings(...).Wait();

client.AddApiKey(...).Wait();
client.UpdateApiKey(...).Wait();
client.DeleteApiKey(...).Wait();
client.MultipleBatch(...).Wait();

index.saveObject(...).waitTask();
index.saveObjects(...).waitTask();
index.partialUpdateObject(...).waitTask();
index.partialUpdateObjects(...).waitTask();
index.replaceAllObjects(...).waitTask();
index.deleteObject(...).waitTask();
index.deleteObjects(...).waitTask();
index.deleteBy(...).waitTask();
index.clearObjects(...).waitTask();

index.setSettings(...).waitTask();

index.saveSynonym(...).waitTask();
index.saveSynonyms(...).waitTask();
index.replaceAllSynonyms(...).waitTask();
index.deleteSynonym(...).waitTask();
index.clearSynonyms(...).waitTask();

index.saveRule(...).waitTask();
index.saveRules(...).waitTask();
index.replaceAllRules(...).waitTask();
index.deleteRule(...).waitTask();
index.clearRules(...).waitTask();


client.moveIndex(...).waitTask();
client.copyIndex(...).waitTask();
client.copyRules(...).waitTask();
client.copySynonyms(...).waitTask();
client.copySettings(...).waitTask();

client.addApiKey(...).waitTask();
client.updateApiKey(...).waitTask();
client.deleteApiKey(...).waitTask();
client.multipleBatch(...).waitTask();

index.WaitTask(int taskID)

waitFor task taskID from "indexName"
waitFor task taskID from "indexName" options requestOptions

See code examples

About this method

Wait for a task to complete before executing the next line of code, to synchronize index updates.

All write operations in Algolia are asynchronous by design.

It means that when you add or update an object to your index, our servers will reply to your request with a taskID as soon as they understood the write operation. The actual insert and indexing will be done after replying to your code. You can wait for a task to complete by using the `taskID’ and this method.

Check out our full discussion about asynchronous methods.

Examples

Wait for indexing of a new object:

Copy

$index->addObject(
  [
    'firstname' => 'Jimmie',
    'lastname'  => 'Barninger'
  ]
)->wait();

# Asynchronous call and wait_task
res = index.add_object({ firstname: 'Jimmie', lastname: 'Barninger' })
index.wait_task(res['taskID'])

# Synchronous call, that does the wait_task internally
index.add_object!({ firstname: 'Jimmie', lastname: 'Barninger' })

const object = {
  firstname: 'Jimmie',
  lastname: 'Barninger'
};

index.addObject(object, (err, { taskID, objectID } = {}) => {
  index.waitTask(taskID, err => {
    if (!err) {
      console.log(`object ${objectID} indexed`);
    }
  });
});

index.addObject(
  newObject,
  completionHandler: { (content, error) -> Void in
    if error != nil {
        return
    }
    guard let taskID = content!["taskID"] as? Int else {
        return // could not retrieve task ID
    }
    index.waitTask(
      withID: taskID,
      completionHandler: { (content, error) -> Void in
        if error == nil {
            print("New object is indexed!")
        }
      }
    )
  }
)

JSONObject object = new JSONObject()
  .put("firstname", "Jimmie")
  .put("lastname", "Barninger");

index.addObjectAsync(object, new CompletionHandler() {
  @Override
  public void requestCompleted(JSONObject content, AlgoliaException error) {
    if (error != null) {
      // Handle error.
    } else {
      String taskID = content.optString("taskID", null);
      if (taskID == null) {
        // Handle error.
      } else {
        index.waitTaskAsync(taskID, new CompletionHandler() {
          @Override
          public void requestCompleted(JSONObject content, AlgoliaException error) {
            if (error == null) {
              // Task is published.
            }
          }
        });
      }
    }
  }
});

Contact contact = new Contact
{
  Firstname = "Jimmie",
  Lastname = "Barninger"
};

index.SaveObject(contact, autoGenerateObjectId: true).Wait();

// Asynchronous
var resp = await index.SaveObjectsAsync(contacts, autoGenerateObjectId: true);
resp.Wait();

BatchIndexingResponse resp = index.saveObject(
  new Contact().setFirstname("Jimmie").setLastname("Barninger")
);

// All objects implementing the AlgoliaWaitableResponse interface
// Can be awaited with the .waitTask() method
resp.waitTask();

type Contact struct {
    Firstname string `json:"firstname"`
    Lastname  string `json:"lastname"`
}

contact := Contact{
    Firstname: "Jimmie",
    Lastname:  "Barninger",
}

res, err := index.SaveObject(contact, opt.AutoGenerateObjectIDIfNotExist(true))
err = res.Wait()

If you want to ensure multiple objects have been indexed, you only need to check the highest taskID (last operation)

Wait for indexing of a new object and send extra http header

Copy

$index->addObject(
  [
    'firstname' => 'Jimmie',
    'lastname'  => 'Barninger'
  ]
)->wait([
  'X-Forwarded-For' => '94.228.178.246'
]);

client.setExtraHeader('X-Forwarded-For', '94.228.178.246');

const object = {
  firstname: 'Jimmie',
  lastname: 'Barninger'
};

index.addObject(object, (err, { taskID, objectID } = {}) => {
  index.waitTask(taskID, err => {
    if (!err) {
      console.log(`object ${objectID} indexed`);
    }
  });
});

let requestOptions = RequestOptions()
requestOptions.headers["X-Algolia-User-ID"] = "user123"

index.addObject(
  newObject,
  requestOptions: requestOptions,
  completionHandler: { (content, error) -> Void in
    if error != nil {
        return
    }
    guard let taskID = content!["taskID"] as? Int else {
        return // could not retrieve task ID
    }

    index.waitTask(
      withID: taskID,
      completionHandler: { (content, error) -> Void in
        if error == nil {
            print("New object is indexed!")
        }
      }
    )
  }
)

JSONObject object = new JSONObject()
  .put("firstname", "Jimmie")
  .put("lastname", "Barninger");

index.addObjectAsync(object, new CompletionHandler() {
  @Override
  public void requestCompleted(JSONObject content, AlgoliaException error) {
    if (error != null) {
      // Handle error.
    } else {
      String taskID = content.optString("taskID", null);
      if (taskID == null) {
        // Handle error.
      } else {
        index.waitTaskAsync(taskID, new CompletionHandler() {
          @Override
          public void requestCompleted(JSONObject content, AlgoliaException error) {
            if (error == null) {
              // Task is published.
            }
          }
        });
      }
    }
  }
});

List<Contact> contacts = new List<Contact>
{
    new Contact
    {
      ObjectID = "myID1",
      Firstname = "Jimmie",
      Lastname = "Barninger"
    },
    new Contact
    {
      ObjectID = "myID2",
      Firstname = "Warren",
      Lastname = "Speach"
    }
};

RequestOptions requestOptions = new RequestOptions
{
    Headers = new Dictionary<string,string>{ { "X-Algolia-User-ID", "user123" } }
};

index.SaveObjects(contacts, requestOptions).Wait();

// Asynchronous
var resp = await index.SaveObjectsAsync(contacts, requestOptions);
resp.Wait();

BatchIndexingResponse resp = index.saveObject(
  new Contact().setFirstname("Jimmie").setLastname("Barninger"),
  new RequestOptions().addExtraHeader("X-Algolia-User-ID", "user123")
);

// All objects implementing the AlgoliaWaitableResponse interface
// Can be awaited with the .waitTask() method
resp.waitTask();

type Contact struct {
    Firstname string `json:"firstname"`
    Lastname  string `json:"lastname"`
}

contact := Contact{
    Firstname: "Jimmie",
    Lastname:  "Barninger",
}

opts := []interface{}{
    opt.AutoGenerateObjectIDIfNotExist(true),
    opt.ExtraHeaders(map[string]string{"X-Algolia-User-ID": "userID2"}),
}

res, err := index.SaveObject(contact, opts...)
err = res.Wait()

for {
  t <- client.execute { index into "toto" `object` MyObject("test") }
  r <- client.execute {
    waitFor task t from "toto" options RequestOptions(
      extraHeaders = Some(Map("X-Algolia-User-ID" => "user123"))
    )
  }
} yield "indexing is done"

Parameters

`taskID`	type: string Required taskID of the indexing task to wait for.
`requestOptions`	type: list default: No requestOptions Optional A list of request options to send along with the query.

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

Wait for Operations

About this method

Examples

Wait for indexing of a new object:

Wait for indexing of a new object and send extra http header

Parameters

Response

Did you find this page helpful?

On this page