interface SolrCloudConnectorInterface in Search API Solr 4.x

The Solr Cloud connector interface.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\search_api_solr\SolrConnectorInterface
    • interface \Drupal\search_api_solr\SolrCloudConnectorInterface

6 files declare their use of SolrCloudConnectorInterface

SearchApiSolrAdminCommands.php in modules/search_api_solr_admin/src/Commands/SearchApiSolrAdminCommands.php

SearchApiSolrBackend.php in src/Plugin/search_api/backend/SearchApiSolrBackend.php

SearchApiSolrCommands.php in src/Commands/SearchApiSolrCommands.php

StandardSolrCloudConnector.php in src/Plugin/SolrConnector/StandardSolrCloudConnector.php

StreamingExpressionBuilder.php in src/Utility/StreamingExpressionBuilder.php

... See full list

File

src/SolrCloudConnectorInterface.php, line 13

Namespace

Drupal\search_api_solr

interface SolrCloudConnectorInterface extends SolrConnectorInterface {

  /**
   * Returns the Solr collection name.
   *
   * @return string
   *   The Solr collection name.
   */
  public function getCollectionName();

  /**
   * Temporarily set a different collection name for the connection.
   *
   * @param \Solarium\Core\Client\Endpoint|null $endpoint
   *   Solr endpoint.
   */
  public function setCollectionNameFromEndpoint(Endpoint $endpoint);

  /**
   * Returns the Solr collection name used to store topic checkpoints.
   *
   * @return string
   *   Solr collection name.
   */
  public function getCheckpointsCollectionName();

  /**
   * Returns the Solr collection endpoint used to store topic checkpoints.
   *
   * @return \Solarium\Core\Client\Endpoint|null
   *   Solr endpoint.
   */
  public function getCheckpointsCollectionEndpoint() : ?Endpoint;

  /**
   * Deletes all checkpoints for given index/site.
   *
   * @param string $index_id
   *   Id of the index.
   * @param string $site_hash
   *   The site hash.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function deleteCheckpoints(string $index_id, string $site_hash);

  /**
   * Returns a link to the Solr collection, if the necessary options are set.
   *
   * @return \Drupal\Core\Link
   *   The link to the Solr collection.
   */
  public function getCollectionLink();

  /**
   * Gets information about the Solr Collection.
   *
   * @param bool $reset
   *   If TRUE the server will be asked regardless if a previous call is cached.
   *
   * @return object
   *   A response object with system information.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function getCollectionInfo($reset = FALSE);

  /**
   * Gets information about the cluster status of a Solr Collection.
   *
   * @param string|null $collection
   *   Collection.
   *
   * @return ClusterState|null
   *   A response object with system information.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function getClusterStatus(?string $collection = NULL) : ?ClusterState;

  /**
   * Reloads collection.
   *
   * @param string|null $collection
   *   Collection.
   *
   * @return bool
   *   TRUE if successful, FALSE otherwise.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function reloadCollection(?string $collection = NULL) : bool;

  /**
   * Creates collection.
   *
   * @param array $options
   *
   * @param string|null $collection
   *   Collection.
   *
   * @return bool
   *   TRUE if successful, FALSE otherwise.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function createCollection(array $options, ?string $collection = NULL) : bool;

  /**
   * Deletes collection.
   *
   * @param string|null $collection
   *   Collection.
   *
   * @return bool
   *   TRUE if successful, FALSE otherwise.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function deleteCollection(?string $collection = NULL) : bool;

  /**
   * Upload a configset to Solr Cloud
   *
   * @param string $name
   *   The name of the configset within Solr
   *
   * @param string $filename
   *   The file name of the configset to uplaod.
   *
   * @return bool
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function uploadConfigset(string $name, string $filename) : bool;

  /**
   * Pings the Solr collection to tell whether it can be accessed.
   *
   * @return mixed
   *   The latency in milliseconds if the core can be accessed,
   *   otherwise FALSE.
   */
  public function pingCollection();

  /**
   * Creates a new Solarium stream query.
   *
   * @return \Solarium\QueryType\Stream\Query
   *   The Stream query.
   */
  public function getStreamQuery();

  /**
   * Creates a new Solarium graph query.
   *
   * @return \Solarium\QueryType\Graph\Query
   *   The Graph query.
   */
  public function getGraphQuery();

  /**
   * Executes a stream query.
   *
   * @param \Solarium\QueryType\Stream\Query $query
   *   The Solarium stream query.
   * @param \Solarium\Core\Client\Endpoint|null $endpoint
   *   (optional) The Solarium endpoint.
   *
   * @return \Solarium\QueryType\Stream\Result
   *   The Solarium stream result.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function stream(StreamQuery $query, ?Endpoint $endpoint = NULL);

  /**
   * Executes a graph query.
   *
   * @param \Solarium\QueryType\Graph\Query $query
   *   The Solarium graph query.
   * @param \Solarium\Core\Client\Endpoint|null $endpoint
   *   (optional) The Solarium endpoint.
   *
   * @return \Solarium\QueryType\Graph\Result
   *   The Solarium graph result.
   *
   * @throws \Drupal\search_api_solr\SearchApiSolrException
   */
  public function graph(GraphQuery $query, ?Endpoint $endpoint = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
SolrCloudConnectorInterface::createCollection	public	function	Creates collection.	1
SolrCloudConnectorInterface::deleteCheckpoints	public	function	Deletes all checkpoints for given index/site.	1
SolrCloudConnectorInterface::deleteCollection	public	function	Deletes collection.	1
SolrCloudConnectorInterface::getCheckpointsCollectionEndpoint	public	function	Returns the Solr collection endpoint used to store topic checkpoints.	1
SolrCloudConnectorInterface::getCheckpointsCollectionName	public	function	Returns the Solr collection name used to store topic checkpoints.	1
SolrCloudConnectorInterface::getClusterStatus	public	function	Gets information about the cluster status of a Solr Collection.	1
SolrCloudConnectorInterface::getCollectionInfo	public	function	Gets information about the Solr Collection.	1
SolrCloudConnectorInterface::getCollectionLink	public	function	Returns a link to the Solr collection, if the necessary options are set.	1
SolrCloudConnectorInterface::getCollectionName	public	function	Returns the Solr collection name.	1
SolrCloudConnectorInterface::getGraphQuery	public	function	Creates a new Solarium graph query.	1
SolrCloudConnectorInterface::getStreamQuery	public	function	Creates a new Solarium stream query.	1
SolrCloudConnectorInterface::graph	public	function	Executes a graph query.	1
SolrCloudConnectorInterface::pingCollection	public	function	Pings the Solr collection to tell whether it can be accessed.	1
SolrCloudConnectorInterface::reloadCollection	public	function	Reloads collection.	1
SolrCloudConnectorInterface::setCollectionNameFromEndpoint	public	function	Temporarily set a different collection name for the connection.	1
SolrCloudConnectorInterface::stream	public	function	Executes a stream query.	1
SolrCloudConnectorInterface::uploadConfigset	public	function	Upload a configset to Solr Cloud	1
SolrConnectorInterface::adjustTimeout	public	function	Sets a new timeout for queries, but not for indexing or optimization.	1
SolrConnectorInterface::alterConfigFiles	public	function	Alter the newly assembled Solr configuration files.	1
SolrConnectorInterface::alterConfigZip	public	function	Alter the zip archive of newly assembled Solr configuration files.	1
SolrConnectorInterface::autocomplete	public	function	Executes a search query and returns the raw response.	1
SolrConnectorInterface::coreRestGet	public	function	Sends a REST GET request to the Solr core and returns the result.	1
SolrConnectorInterface::coreRestPost	public	function	Sends a REST POST request to the Solr core and returns the result.	1
SolrConnectorInterface::createEndpoint	public	function	Creates an endpoint.	1
SolrConnectorInterface::createSearchResult	public	function	Creates a result from a response.	1
SolrConnectorInterface::execute	public	function	Executes any query.	1
SolrConnectorInterface::executeRequest	public	function	Executes a request and returns the response.	1
SolrConnectorInterface::extract	public	function	Executes an extract query.	1
SolrConnectorInterface::FINALIZE_TIMEOUT		constant
SolrConnectorInterface::getAutocompleteQuery	public	function	Creates a new Solarium autocomplete query.	1
SolrConnectorInterface::getConfigSetName	public	function	Gets the name of the used configset.	1
SolrConnectorInterface::getContentFromExtractResult	public	function	Gets the content from an extract query result.	1
SolrConnectorInterface::getCoreInfo	public	function	Gets information about the Solr Core.	1
SolrConnectorInterface::getCoreLink	public	function	Returns a link to the Solr core, if the necessary options are set.	1
SolrConnectorInterface::getEndpoint	public	function	Returns an endpoint.	1
SolrConnectorInterface::getExtractQuery	public	function	Creates a new Solarium extract query.	1
SolrConnectorInterface::getFile	public	function	Retrieves a config file or file list from the Solr server.	1
SolrConnectorInterface::getFinalizeTimeout	public	function	Get the finalize timeout.	1
SolrConnectorInterface::getIndexTimeout	public	function	Get the index timeout.	1
SolrConnectorInterface::getLuceneMatchVersion	public	function	Gets the LuceneMatchVersion string.	1
SolrConnectorInterface::getLuke	public	function	Gets meta-data about the index.	1
SolrConnectorInterface::getMoreLikeThisQuery	public	function	Creates a new Solarium more like this query.	1
SolrConnectorInterface::getOptimizeTimeout	public	function	Get the optimize timeout.	1
SolrConnectorInterface::getQueryHelper	public	function	Returns a Solarium query helper object.	1
SolrConnectorInterface::getSchemaTargetedSolrBranch	public	function	Gets the Solr branch targeted by the schema.	1
SolrConnectorInterface::getSchemaVersion	public	function	Gets the schema version number.	1
SolrConnectorInterface::getSchemaVersionString	public	function	Gets the full schema version string the core is using.	1
SolrConnectorInterface::getSelectQuery	public	function	Creates a new Solarium update query.	1
SolrConnectorInterface::getServerInfo	public	function	Gets information about the Solr server.	1
SolrConnectorInterface::getServerLink	public	function	Returns a link to the Solr server.	1
SolrConnectorInterface::getSolrBranch	public	function	Gets the current Solr branch name.	1
SolrConnectorInterface::getSolrMajorVersion	public	function	Gets the current Solr major version.	1
SolrConnectorInterface::getSolrVersion	public	function	Gets the current Solr version.	1
SolrConnectorInterface::getSpellcheckQuery	public	function	Creates a new Solarium suggester query.	1
SolrConnectorInterface::getStatsSummary	public	function	Gets summary information about the Solr Core.	1
SolrConnectorInterface::getSuggesterQuery	public	function	Creates a new Solarium suggester query.	1
SolrConnectorInterface::getTermsQuery	public	function	Creates a new Solarium terms query.	1
SolrConnectorInterface::getTimeout	public	function	Get the query timeout.	1
SolrConnectorInterface::getUpdateQuery	public	function	Creates a new Solarium update query.	1
SolrConnectorInterface::INDEX_TIMEOUT		constant
SolrConnectorInterface::isCloud	public	function	Returns TRUE for Cloud.	1
SolrConnectorInterface::isJumpStartConfigSet	public	function	Indicates if the Solr config-set is our jum-start config-set.	1
SolrConnectorInterface::optimize	public	function	Optimizes the Solr index.	1
SolrConnectorInterface::OPTIMIZE_TIMEOUT		constant
SolrConnectorInterface::pingCore	public	function	Pings the Solr core to tell whether it can be accessed.	1
SolrConnectorInterface::pingEndpoint	public	function	Pings the Solr endpoint to tell whether it can be accessed.	1
SolrConnectorInterface::pingServer	public	function	Pings the Solr server to tell whether it can be accessed.	1
SolrConnectorInterface::QUERY_TIMEOUT		constant
SolrConnectorInterface::reloadCore	public	function	Reloads the Solr core.	2
SolrConnectorInterface::search	public	function	Executes a search query and returns the raw response.	1
SolrConnectorInterface::serverRestGet	public	function	Sends a REST GET request to the Solr server and returns the result.	1
SolrConnectorInterface::serverRestPost	public	function	Sends a REST POST request to the Solr server and returns the result.	1
SolrConnectorInterface::setEventDispatcher	public	function	Sets the event dispatcher.	1
SolrConnectorInterface::update	public	function	Executes an update query and applies some tweaks.	1
SolrConnectorInterface::viewSettings	public	function	Returns additional, connector-specific information about this server.	1