Download the PHP package pantheon-systems/search_api_pantheon without Composer

On this page you can find all versions of the php package pantheon-systems/search_api_pantheon. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package search_api_pantheon

Search API Pantheon: Solr 8/9 & Drupal 10+ Integration

Search API Pantheon Actively Maintained

Table of Contents

Overview

This module provides Drupal 10+ integration with Apache Solr (versions 8 and 9) on Pantheon's Platform, simplifying the usage of Search API and Search API Solr.

Search API Solr provides the ability to connect to any Solr server by providing numerous configuration options. This module automatically sets the Solr connection options by extending the plugin from Search API Solr. The module also changes its connection information based on different Pantheon environments and each Pantheon Environment has its own Solr Core. Doing so eliminates the need to do extra work setting up Solr servers for each environment.

Solr Versions on Pantheon

Requirements

Installation

Stable Release

Development Version

Upgrading

Upgrading from an earlier version? See UPGRADE.md for detailed migration guides:

Setup

Enable Solr on Pantheon

Under "Settings" in your Pantheon site dashboard, enable Solr as an add on. This feature is available for sandbox sites as well as paid plans at the Professional level and above.

Configure pantheon.yml

Add or update the following in your pantheon.yml file:

Or, to use Solr 8:

As you deploy code, the pantheon.yml file will follow the code through environments enabling the Solr server. However you will need to create an index for each environment and ensure the content is indexed after creation. Solr indices are environment-specific and cannot be exported or moved once created.

Enable the Modules

OPTIONAL: Disable Drupal Core's search module

If you are using Search API, you probably will not be using Drupal Core's Search module. Uninstall it to save some confusion in the further configuration steps: admin/modules/uninstall.

Verify Installation

Use the Server with an Index

When you enable the Search API Pantheon module, a Primary index is automatically created and linked to the Pantheon search server. You can use this default index or create your own custom index.

To use the default 'Primary' index:

To create a custom index:

Search the Index

Export Your Changes

It is a best practice in Drupal to export your changes to yml files. Using Terminus while in SFTP mode, you can run terminus drush <site>.<env> -- "config:export -y" to export the configuration changes you have made. Once committed, these changes can be deployed out to Test and Live environments.

Schema Updates

The default schema Pantheon provisions with a new Solr container depends on the Solr version:

When you first create your index or alter it significantly, you will need to update the schema on the Solr server.

Running with an outdated schema can cause broken search, indexing errors, and missing features such as highlighting or autocomplete. Specifically, you should update the schema:

Schema updates can be performed using:

The [path] argument is optional. Provide it only if you want to use a custom config-set directory. If omitted, the module uses Search API Solr to generate config files that match your installed module version and Solr version.

Once you have enabled the Search API Pantheon module, when you reload the schema the module will use the config-set for the version of the Search API Solr module installed in your codebase. See the Search API Solr 4.3.0 release notes for more information about upgrading to a 4.3.0+ compatible schema.

Examples

Auto-generated config: Generates schema files based on your Solr version, Search API Solr version, and index configuration.

Jump-start config-set from Search API Solr: Uses the pre-built config-set bundled with the Search API Solr module. Useful if you want a known baseline without any site-specific customizations.

Custom config-set directory: Uses your own schema files. For advanced use cases where you need custom analyzers, tokenizers, or field types beyond what the module generates.

For more details on using custom Solr configurations, see Pantheon's custom config guide.

Core Reloading

Automatic Core Reload

Search API Pantheon automatically reloads the Solr core after schema updates to prevent schema reversions and maintain index integrity.

Manual Core Reload

If needed, manually reload the core using:

Pantheon Environments

Each Pantheon environment (Dev, Test, Live, and Multidevs) has its own Solr server. Indexing and searching in one environment does not impact any other environment.

When you enable the Search API Pantheon module, 'Pantheon Search' server is automatically installed by default. The Pantheon connector supports only a single Search API server per environment. Creating additional servers using the Pantheon connector will cause all servers to point to the same Solr core, which may result in schema conflicts or unexpected indexing behavior.

Diagnostic Commands

Diagnostic commands automatically use the first server connected via Pantheon connector. The server_id argument is no longer needed or accepted.

Command Alias Arguments Description
drush search-api-pantheon:diagnose sapd None Checks the various pieces of the Search API install and throws errors on pieces that are not working.
drush search-api-pantheon:select saps <query> (required) Runs the given query against Solr server. Use ?debug=true in any Solr page to get a good query to pass to this command.
drush search-api-pantheon:force-cleanup sapfc None Deletes all of the contents for the Solr server (no matter if hash or index_id have changed).
drush search-api-pantheon:postSchema sapps [path] (optional) Uploads schema files to the solr server. Can reset a schema to default, upgrade a schema, or use a custom config set.
drush search-api-pantheon:test-index-and-query sap-tiq None Connects to the search server, indexes a single item, and immediately queries it.

Troubleshooting

Common Issues

Issue Solution
Schema reverts unexpectedly Ensure core reload is happening after updates
Search index corruption Try reposting schema and reindexing content
Core reload failures Check Solr logs and connection status
Error after Search API Solr upgrade Schema incompatibility from 4.2.x → 4.3.x. See UPGRADE.md

Solr Jargon

Term Definition
Commit To make document changes permanent in the index.
Core An instance of the Solr server suitable for creating zero or more indices.
Collection Solr Cloud's version of a "CORE". Not currently used at Pantheon.
Document A group of fields and their values. The basic unit of data in a collection.
Facet The arrangement of search results into categories based on indexed terms.
Field The content to be indexed/searched along with metadata.
Index A group of metadata entries gathered by Solr into a searchable catalog.
Schema A series of plain text and XML files that describe the data Solr will be indexing.

Feedback and Collaboration

Bug reports, feature requests, and feedback should be posted in the drupal.org issue queue. For code changes, please submit pull requests against the GitHub repository.

All versions of search_api_pantheon with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
drupal/search_api_solr Version ^4.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pantheon-systems/search_api_pantheon contains the following files

Loading the files please wait ...