public function SolrConnectorPluginBase::extract in Search API Solr 4.x

Same name and namespace in other branches

1. 8.3 src/SolrConnector/SolrConnectorPluginBase.php \Drupal\search_api_solr\SolrConnector\SolrConnectorPluginBase::extract()
2. 8 src/SolrConnector/SolrConnectorPluginBase.php \Drupal\search_api_solr\SolrConnector\SolrConnectorPluginBase::extract()
3. 8.2 src/SolrConnector/SolrConnectorPluginBase.php \Drupal\search_api_solr\SolrConnector\SolrConnectorPluginBase::extract()

Executes an extract query.

Parameters

\Solarium\Core\Query\QueryInterface|\Solarium\QueryType\Extract\Query $query: The Solarium extract query object.

\Solarium\Core\Client\Endpoint|null $endpoint: (optional) The Solarium endpoint object.

Return value

\Solarium\QueryType\Extract\Result The Solarium extract result object.

Throws

\Drupal\search_api_solr\SearchApiSolrException

Overrides SolrConnectorInterface::extract

File

src/SolrConnector/SolrConnectorPluginBase.php, line 1161

Class

SolrConnectorPluginBase

Defines a base class for Solr connector plugins.

Namespace

Drupal\search_api_solr\SolrConnector

Code

public function extract(QueryInterface $query, ?Endpoint $endpoint = NULL) {
  $this
    ->useTimeout(self::INDEX_TIMEOUT, $endpoint);
  return $this
    ->execute($query, $endpoint);
}