You are here

public function SearchApiElasticsearchBackend::isAvailable in Elasticsearch Connector 8.5

Same name and namespace in other branches
  1. 8.7 src/Plugin/search_api/backend/SearchApiElasticsearchBackend.php \Drupal\elasticsearch_connector\Plugin\search_api\backend\SearchApiElasticsearchBackend::isAvailable()
  2. 8.6 src/Plugin/search_api/backend/SearchApiElasticsearchBackend.php \Drupal\elasticsearch_connector\Plugin\search_api\backend\SearchApiElasticsearchBackend::isAvailable()

Returns a boolean with the availability of the backend.

This can implement a specific call to test if the backend is available for reading. For SOLR or elasticsearch this would be a "ping" to the server to test if it's online. If this is a db-backend that is running on a separate server, this can also be a ping. When it's a db-backend that runs in the same database as the drupal installation; just returning TRUE is enough.

Return value

bool The availability of the backend.

Overrides BackendPluginBase::isAvailable

File

src/Plugin/search_api/backend/SearchApiElasticsearchBackend.php, line 645

Class

SearchApiElasticsearchBackend
Elasticsearch Search API Backend definition.

Namespace

Drupal\elasticsearch_connector\Plugin\search_api\backend

Code

public function isAvailable() {
  return $this->client
    ->isClusterOk();
}