PySolr

Warnings

• breaking PySolr has progressively dropped support for older Python versions. As of v3.9.0, Python 3.4 support was dropped. With v3.11.0, support for Python 3.9 and below has been explicitly removed. PySolr now strictly requires Python >=3.10.
  Fix: Ensure your Python environment is running version 3.10 or newer before upgrading to recent PySolr versions.
• breaking The default commit behavior for add/delete operations changed significantly in v3.8.1. Previously, these operations would implicitly commit changes to Solr. From v3.8.1 onwards, `always_commit` defaults to `False` for performance. This means changes are buffered and not immediately searchable unless explicitly committed.
  Fix: To maintain immediate indexing, initialize the Solr client with `pysolr.Solr(..., always_commit=True)`, or explicitly pass `commit=True` to individual `add()` or `delete()` calls (e.g., `solr.add(docs, commit=True)`). Alternatively, configure Solr's `autoCommit` or `commitWithin` policies.
• gotcha PySolr v3.9.0 introduced a JSON interface which can offer significantly faster data loading (up to 15-20 times faster) compared to the older XML-based conversion. Users may inadvertently stick to less performant methods.
  Fix: Review your Solr configuration and PySolr usage to ensure you are leveraging the JSON interface for optimal performance, especially for bulk indexing. PySolr handles JSON conversion automatically when passing Python dicts/lists, but awareness of the underlying mechanism is beneficial.
• gotcha When using custom Solr request handlers (often with `use_qt_param=True`), the handler name specified in the PySolr URL must precisely match the configuration in `solrconfig.xml`, including any leading slashes (e.g., `/update`). If `use_qt_param` is `False` (the default), leading/trailing slashes can be omitted.
  Fix: Carefully verify the Solr core URL and handler names, especially when moving between different Solr configurations or custom handlers. Consult your Solr `solrconfig.xml` for exact handler path specifications.
• deprecated As part of the shift to Python 3, PySolr v3.11.0 explicitly removed the Python 2 tag from its distribution metadata. While Python 2 compatibility was waning in earlier 3.x releases, this action definitively signals the end of any remaining support. Attempting to use newer PySolr versions with Python 2 tooling or environments may lead to installation failures or runtime errors.
  Fix: Ensure all development and deployment environments are standardized on Python 3.10 or newer. Update any dependency management or CI/CD configurations that might implicitly assume Python 2 compatibility.

Install

• pip install pysolr Install PySolr

Imports

• Solr

  import pysolr
  solr = pysolr.Solr('http://localhost:8983/solr/')

  The primary class for interacting with a Solr instance.

Quickstart

This quickstart demonstrates how to connect to a Solr instance, index documents, perform a search, and delete documents. It uses `os.environ.get` for the Solr URL to support flexible deployment, defaulting to a local Solr instance. Note the use of `always_commit=True` due to a significant change in default behavior in recent versions.

import os
import pysolr

solr_url = os.environ.get('SOLR_URL', 'http://localhost:8983/solr/')

try:
    # Connect to Solr with explicit commit behavior
    solr = pysolr.Solr(solr_url, always_commit=True, timeout=10)

    # Do a health check
    solr.ping()
    print(f"Successfully connected to Solr at {solr_url}")

    # Index some data
    docs_to_add = [
        {"id": "doc_1", "title": "The Quick Brown Fox"},
        {"id": "doc_2", "title": "Jumps Over The Lazy Dog"},
    ]
    solr.add(docs_to_add)
    print("Added documents.")

    # Search for data
    results = solr.search('fox')

    print(f"Found {len(results)} result(s) for 'fox':")
    for result in results:
        print(f"  - ID: {result['id']}, Title: {result['title']}")

    # Delete a document
    solr.delete(id='doc_1')
    print("Deleted doc_1.")

    # Search again to confirm deletion
    results_after_delete = solr.search('fox')
    print(f"Found {len(results_after_delete)} result(s) for 'fox' after deletion.")

except Exception as e:
    print(f"An error occurred: {e}")