Setup

  • Solr version:
  • Drupal Core version:
  • Search API version:
  • Search API Solr version:
  • Configured Solr Connector:

Issue

I am uncertain which features installing the Search API Solr Admin module adds. The search_api_solr_admin.info.yml file says:

Provides various Solr administration tasks.

But I am not exactly sure which tasks, because if I uninstall it, I still see the same three buttons under an index. It seems like it also provides Drush commands.

Also, the Help and Usage for the upload-configset command is not correct.

Proposal

It would be amazing if it was specified in the search_api_solr_admin.info.yml or on a new doc page under https://www.drupal.org/docs/8/modules/search-api-solr/search-api-solr-ho... which features and Drush commands the Search API Solr Admin module adds.

Remaining tasks

  1. Fix wrong Help and Usage for the Drush command upload-configset (MR)
  2. Describe and link to Admin module in the README (MR)
  3. Add tip in the .info file to check the README, which links to doc page (MR)
  4. Review and publish new documentation page (see below)
  5. ✅ Create a Search API Solr Admin module documentation page, with content like this:

    Search API Solr Admin module

    The Search API Solr Admin module adds extra functions on the Solr server settings page, as well as Drush commands.

    A "Delete collection" button is added at the bottom, and these three buttons at the top:

    • Upload Configset
    • Reload Collection
    • Field Analysis

    Drush commands

    It also adds these Drush commands:

    search-api-solr:delete-all
    Deletes *all* documents on a Solr search server (including all indexes).

    search-api-solr:delete-collection (solr-delete-collection)
    Delete Solr collection.

    search-api-solr:reload (solr-reload)
    Reload Solr core or collection.

    search-api-solr:upload-configset (solr-upload-conf)
    Upload a configset and reload the collection or create it using the given options.

CommentFileSizeAuthor
#2 Bildschirmfoto 2026-04-29 um 10.03.46.png12.19 KBmkalkbrenner
#2 Bildschirmfoto 2026-04-29 um 10.02.57.png22.38 KBmkalkbrenner

Issue fork search_api_solr-3587376

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

ressa created an issue. See original summary.

mkalkbrenner’s picture

mkalkbrenner
Primary language German
Location 🇩🇪
commented
Issue summary: View changes
StatusFileSize
new Bildschirmfoto 2026-04-29 um 10.02.57.png22.38 KB
new Bildschirmfoto 2026-04-29 um 10.03.46.png12.19 KB

On the server page:

ressa’s picture

ressa
he/him
commented
Issue summary: View changes

Yes, in the linked issue (#3577119: pressing the clear all indexed data button is not clearing all indexed data) I commented that I had over-looked that it adds an extra "Delete collection" button. And then also the three buttons at the top. I have updated the Issue Summary with these buttons and Drush commands.

mkalkbrenner’s picture

mkalkbrenner
Primary language German
Location 🇩🇪
commented

BTW "Upload Configset" will also create the collection if it doesn't exist yet.

ressa changed the visibility of the branch 3587376-document-search-api to hidden.

ressa opened merge request !82

ressa changed the visibility of the branch 3587376-document-search-api to active.

ressa opened merge request !83

ressa changed the visibility of the branch 4.x to hidden.

ressa closed merge request !82

ressa’s picture

ressa
he/him
commented
Issue summary: View changes
Status: Active » Needs review

Thanks for the tip, I looked in the latest dev-release for "Upload Configset" to copy the string, and saw that Help and Usage were not correct (they were from the delete command) so I created an MR. I also added a mention of the module in the README.

I created a documentation page: https://www.drupal.org/docs/8/modules/search-api-solr/search-api-solr-ho...

Maybe you can review and publish it?