{"id":13534382,"url":"https://github.com/django-haystack/pysolr","last_synced_at":"2025-12-17T22:42:26.326Z","repository":{"id":604376,"uuid":"240864","full_name":"django-haystack/pysolr","owner":"django-haystack","description":"Pysolr — Python Solr client","archived":false,"fork":false,"pushed_at":"2025-05-07T13:18:58.000Z","size":722,"stargazers_count":673,"open_issues_count":29,"forks_count":341,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-05-13T04:41:15.734Z","etag":null,"topics":["pysolr","python","solr","solr-client","solr-search"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"stretchr/goweb","license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/django-haystack.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2009-07-01T17:54:08.000Z","updated_at":"2025-05-10T14:08:10.000Z","dependencies_parsed_at":"2023-10-14T15:22:39.112Z","dependency_job_id":"dcfa76c0-606f-410a-9a1a-7b0db592cd1b","html_url":"https://github.com/django-haystack/pysolr","commit_stats":{"total_commits":494,"total_committers":72,"mean_commits":6.861111111111111,"dds":0.6234817813765182,"last_synced_commit":"f109ac02b5b4cb3fe85a3a9c10faf9634a5e85ab"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-haystack%2Fpysolr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-haystack%2Fpysolr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-haystack%2Fpysolr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-haystack%2Fpysolr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/django-haystack","download_url":"https://codeload.github.com/django-haystack/pysolr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253878833,"owners_count":21977882,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pysolr","python","solr","solr-client","solr-search"],"created_at":"2024-08-01T07:01:31.820Z","updated_at":"2025-12-17T22:42:21.281Z","avatar_url":"https://github.com/django-haystack.png","language":"Python","funding_links":[],"categories":["Search","资源列表","Python","搜索","Search [🔝](#readme)","Awesome Python","Database Clients"],"sub_categories":["搜索","Search"],"readme":"======\npysolr\n======\n\n``pysolr`` is a lightweight Python client for `Apache Solr`_. It provides an\ninterface that queries the server and returns results based on the query.\n\n.. _`Apache Solr`: https://solr.apache.org/\n\nStatus\n======\n\n`Changelog \u003chttps://github.com/django-haystack/pysolr/blob/master/CHANGELOG.rst\u003e`_\n\nFeatures\n========\n\n* Basic operations such as selecting, updating \u0026 deleting.\n* Index optimization.\n* `\"More Like This\" \u003chttp://wiki.apache.org/solr/MoreLikeThis\u003e`_ support (if set up in Solr).\n* `Spelling correction \u003chttp://wiki.apache.org/solr/SpellCheckComponent\u003e`_ (if set up in Solr).\n* Timeout support.\n* SolrCloud awareness\n\nRequirements\n============\n\n* A supported version of Python 3\n* Requests 2.9.1+\n* **Optional** - ``simplejson``\n* **Optional** - ``kazoo`` for SolrCloud mode\n\nInstallation\n============\n\npysolr is on PyPI:\n\n.. code-block:: console\n\n   $ pip install pysolr\n\nOr if you want to install directly from the repository:\n\n.. code-block:: console\n\n    $ python setup.py install\n\nUsage\n=====\n\nBasic usage looks like:\n\n.. code-block:: python\n\n    # If on Python 2.X\n    from __future__ import print_function\n\n    import pysolr\n\n    # Create a client instance. The timeout and authentication options are not required.\n    solr = pysolr.Solr('http://localhost:8983/solr/', always_commit=True, [timeout=10], [auth=\u003ctype of authentication\u003e])\n\n    # Note that auto_commit defaults to False for performance. You can set\n    # `auto_commit=True` to have commands always update the index immediately, make\n    # an update call with `commit=True`, or use Solr's `autoCommit` / `commitWithin`\n    # to have your data be committed following a particular policy.\n\n    # Do a health check.\n    solr.ping()\n\n    # How you'd index data.\n    solr.add([\n        {\n            \"id\": \"doc_1\",\n            \"title\": \"A test document\",\n        },\n        {\n            \"id\": \"doc_2\",\n            \"title\": \"The Banana: Tasty or Dangerous?\",\n            \"_doc\": [\n                { \"id\": \"child_doc_1\", \"title\": \"peel\" },\n                { \"id\": \"child_doc_2\", \"title\": \"seed\" },\n            ]\n        },\n    ])\n\n    # You can index a parent/child document relationship by\n    # associating a list of child documents with the special key '_doc'. This\n    # is helpful for queries that join together conditions on children and parent\n    # documents.\n\n    # Later, searching is easy. In the simple case, just a plain Lucene-style\n    # query is fine.\n    results = solr.search('bananas')\n\n    # The ``Results`` object stores total results found, by default the top\n    # ten most relevant results and any additional data like\n    # facets/highlighting/spelling/etc.\n    print(\"Saw {0} result(s).\".format(len(results)))\n\n    # Just loop over it to access the results.\n    for result in results:\n        print(\"The title is '{0}'.\".format(result['title']))\n\n    # For a more advanced query, say involving highlighting, you can pass\n    # additional options to Solr.\n    results = solr.search('bananas', **{\n        'hl': 'true',\n        'hl.fragsize': 10,\n    })\n\n    # Traverse a cursor using its iterator:\n    for doc in solr.search('*:*',fl='id',sort='id ASC',cursorMark='*'):\n        print(doc['id'])\n\n    # You can also perform More Like This searches, if your Solr is configured\n    # correctly.\n    similar = solr.more_like_this(q='id:doc_2', mltfl='text')\n\n    # Finally, you can delete either individual documents,\n    solr.delete(id='doc_1')\n\n    # also in batches...\n    solr.delete(id=['doc_1', 'doc_2'])\n\n    # ...or all documents.\n    solr.delete(q='*:*')\n\n.. code-block:: python\n\n    # For SolrCloud mode, initialize your Solr like this:\n\n    zookeeper = pysolr.ZooKeeper(\"zkhost1:2181,zkhost2:2181,zkhost3:2181\")\n    solr = pysolr.SolrCloud(zookeeper, \"collection1\", auth=\u003ctype of authentication\u003e)\n\n\nMulticore Index\n~~~~~~~~~~~~~~~\n\nSimply point the URL to the index core:\n\n.. code-block:: python\n\n    # Setup a Solr instance. The timeout is optional.\n    solr = pysolr.Solr('http://localhost:8983/solr/core_0/', timeout=10)\n\n\nCustom Request Handlers\n~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    # Setup a Solr instance. The trailing slash is optional.\n    solr = pysolr.Solr('http://localhost:8983/solr/core_0/', search_handler='/autocomplete', use_qt_param=False)\n\n\nIf ``use_qt_param`` is ``True`` it is essential that the name of the handler is\nexactly what is configured in ``solrconfig.xml``, including the leading slash\nif any. If ``use_qt_param`` is ``False`` (default), the leading and trailing\nslashes can be omitted.\n\nIf ``search_handler`` is not specified, pysolr will default to ``/select``.\n\nThe handlers for MoreLikeThis, Update, Terms etc. all default to the values set\nin the ``solrconfig.xml`` SOLR ships with: ``mlt``, ``update``, ``terms`` etc.\nThe specific methods of pysolr's ``Solr`` class (like ``more_like_this``,\n``suggest_terms`` etc.) allow for a kwarg ``handler`` to override that value.\nThis includes the ``search`` method. Setting a handler in ``search`` explicitly\noverrides the ``search_handler`` setting (if any).\n\n\nCustom Authentication\n~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    # Setup a Solr instance in a kerborized environment\n    from requests_kerberos import HTTPKerberosAuth, OPTIONAL\n    kerberos_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL, sanitize_mutual_error_response=False)\n\n    solr = pysolr.Solr('http://localhost:8983/solr/', auth=kerberos_auth)\n\n.. code-block:: python\n\n    # Setup a CloudSolr instance in a kerborized environment\n    from requests_kerberos import HTTPKerberosAuth, OPTIONAL\n    kerberos_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL, sanitize_mutual_error_response=False)\n\n    zookeeper = pysolr.ZooKeeper(\"zkhost1:2181/solr, zkhost2:2181,...,zkhostN:2181\")\n    solr = pysolr.SolrCloud(zookeeper, \"collection\", auth=kerberos_auth)\n\n\nIf your Solr servers run off https\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    # Setup a Solr instance in an https environment\n    solr = pysolr.Solr('http://localhost:8983/solr/', verify=path/to/cert.pem)\n\n.. code-block:: python\n\n    # Setup a CloudSolr instance in a kerborized environment\n\n    zookeeper = pysolr.ZooKeeper(\"zkhost1:2181/solr, zkhost2:2181,...,zkhostN:2181\")\n    solr = pysolr.SolrCloud(zookeeper, \"collection\", verify=path/to/cert.perm)\n\n\nCustom Commit Policy\n~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    # Setup a Solr instance. The trailing slash is optional.\n    # All requests to Solr will be immediately committed because `always_commit=True`:\n    solr = pysolr.Solr('http://localhost:8983/solr/core_0/', search_handler='/autocomplete', always_commit=True)\n\n``always_commit`` signals to the Solr object to either commit or not commit by\ndefault for any solr request. Be sure to change this to ``True`` if you are\nupgrading from a version where the default policy was always commit by default.\n\nFunctions like ``add`` and ``delete`` also still provide a way to override the\ndefault by passing the ``commit`` kwarg.\n\nIt is generally good practice to limit the amount of commits to Solr as\nexcessive commits risk opening too many searchers or excessive system\nresource consumption. See the Solr documentation for more information and\ndetails about the ``autoCommit`` and ``commitWithin`` options:\n\nhttps://lucene.apache.org/solr/guide/7_7/updatehandlers-in-solrconfig.html#UpdateHandlersinSolrConfig-autoCommit\n\n\nLICENSE\n=======\n\n``pysolr`` is licensed under the New BSD license.\n\nContributing to pysolr\n======================\n\nFor consistency, this project uses `pre-commit \u003chttps://pre-commit.com/\u003e`_ to manage Git commit hooks:\n\n#. Install the `pre-commit` package: e.g. `brew install pre-commit`,\n   `pip install pre-commit`, etc.\n#. Run `pre-commit install` each time you check out a new copy of this Git\n   repository to ensure that every subsequent commit will be processed by\n   running `pre-commit run`, which you may also do as desired. To test the\n   entire repository or in a CI scenario, you can check every file rather than\n   just the staged ones using `pre-commit run --all`.\n\n\nRunning Tests\n=============\n\nThe ``run-tests.py`` script will automatically perform the steps below and is\nrecommended for testing by default unless you need more control.\n\nRunning a test Solr instance\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownloading, configuring and running Solr 4 looks like this::\n\n    ./start-solr-test-server.sh\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\n.. code-block:: console\n\n    $ python -m unittest tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-haystack%2Fpysolr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjango-haystack%2Fpysolr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-haystack%2Fpysolr/lists"}