Index Exists | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

index.exists?

About this method

Returns whether an index exists or not.

Algolia lets you instantiate indices with any name, even if they haven’t been previously created. An initialized index is created when you call save objects or set settings on it. This can result in the accidental creation of new indices, or modification of existing ones.

The exists method returns a boolean that indicates whether an initialized index has been created.

You should be careful when using this method to execute code conditionally. Due to the asynchronous nature of saving objects, the existence of an index may change between the time a condition is met, and when the conditional code executes. Be mindful of the surrounding code, and of any process that may be altering your indices.

Examples

Check if an index exists

1
$index->exists();

1
index.exists?

1
2
3
index.exists().then(result => {
  console.log(result);
});

1
index.exists()

1
2
3
4
5
index.exists { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
// Not implemented yet

1
2
3
4
index.Exists();

// Asynchronous
await index.ExistsAsync();

1
index.exists();

1
ok, err := index.Exists()

1
// Not implemented yet

1
index.exists()

Parameters

No parameters for this method.

Response

No response.