SolrCommitTrait.php in Search API Solr 8.3

Namespace

Drupal\search_api_solr\Utility

File

src/Utility/SolrCommitTrait.php

<?php

namespace Drupal\search_api_solr\Utility;

use Drupal\search_api\IndexInterface;
defined('SOLR_INDEX_WAIT') || define('SOLR_INDEX_WAIT', getenv('SOLR_INDEX_WAIT') ?: 0);

/**
 * Helper to ensure that solr index is up to date.
 */
trait SolrCommitTrait {

  /**
   * Explicitly sends a commit command to a Solr server.
   *
   * @param \Drupal\search_api\IndexInterface $index
   *   The Search API server entity.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\search_api\SearchApiException
   */
  protected function ensureCommit(IndexInterface $index) {
    if ($server = $index
      ->getServerInstance()) {

      /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
      $backend = $server
        ->getBackend();

      /** @var \Drupal\search_api_solr\SolrConnectorInterface $connector */
      $connector = $backend
        ->getSolrConnector();
      $update = $connector
        ->getUpdateQuery();
      $update
        ->addCommit(TRUE, TRUE, TRUE);
      $connector
        ->update($update, $backend
        ->getCollectionEndpoint($index));
      if (SOLR_INDEX_WAIT) {
        sleep(SOLR_INDEX_WAIT);
      }
    }
  }

}

Traits

Name	Description
SolrCommitTrait	Helper to ensure that solr index is up to date.