Index exists

Required API Key: any key with the settings ACL

Method signature

$index->exists()

index.exists?()

index.exists()

index.exists()

index.exists(completion: Result<Bool> -> Void)

suspend fun Index.exists(): Boolean

index.Exists()

index.exists()

index.Exists()

Not implemented yet.

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Check if an index exists or not.

You can initialize an index with any name. The index is created on Algolia’s servers when you add objects or set settings. To prevent accidentally creating new indices, or changing existing indices, you can use the exists method. The exists method returns a boolean that indicates whether an initialized index has been created.

Be careful when using this method to execute code conditionally. Because index operations are asynchronous, an index might not yet exist when you call the exist method, but it might exist when the conditional code runs. Be mindful of the surrounding code, and of any process that might change your indices.

Examples

Read the Algolia CLI documentation for more information.

Check if an index exists

Copy

1
2
3
4
5
6
7
8
9
10
11
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\SearchClient;

// Use an API key with `settings` ACL
$client = SearchClient::create(
  'YourApplicationID', 'YourAPIKey'
);
$index = $client->initIndex('indexName');

$index->exists();

1
2
3
4
5
6
7
8
9
require 'algolia'

# Use an API key with `settings` ACL
client = Algolia::Search::Client.create(
  'YourApplicationID', 'YourAPIKey'
)
index = client.init_index('indexName')

index.exists?

1
2
3
4
5
6
7
8
9
const algoliasearch = require('algoliasearch');

// Use an API key with `settings` ACL
const client = algoliasearch('YourApplicationID', 'YourAPIKey');
const index = client.initIndex('indexName');

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

1
2
3
4
5
6
7
from algoliasearch.search_client import SearchClient

# Use an API key with `settings` ACL
client = SearchClient.create("YourApplicationID", "YourAPIKey")
index = client.init_index("indexName")

index.exists()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import AlgoliaSearchClient

// Use an API key with `deleteIndex` ACL
let client = SearchClient(
  appID: "YourApplicationID",
  apiKey: "YourAPIKey"
)
let index = client.index(withName: "indexName")

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

1
2
3
4
5
6
7
8
// Use an API key with `settings` ACL
val client = ClientSearch(
  ApplicationID("YourApplicationID"),
  APIKey("YourAPIKey")
)
val index = client.initIndex(IndexName("indexName"))

index.exists()

1
2
3
4
5
6
7
8
// Use an API key with `settings` ACL
var client = new SearchClient("YourApplicationID", "YourAPIKey");
var index = client.InitIndex("indexName");

index.Exists();

// Asynchronous
await index.ExistsAsync();

1
2
3
4
5
// Use an API key with `settings` ACL
SearchClient client = DefaultSearchClient.create("YourApplicationID", "YourAPIKey");
SearchIndex<Record> index = client.initIndex("indexName", Record.class);

index.exists();

1
2
3
4
// Use an API key with `settings` ACL
client := search.NewClient('YourApplicationID', 'YourAPIKey')
index := client.InitIndex('indexName')
ok, err := index.Exists()

Parameters

This method doesn't take any parameters.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

This method returns true if the index exists, and false otherwise.

Did you find this page helpful?