Package: pysolr
pysolris a lightweight Python client forApache Solr. It provides an
interface that queries the server and returns results based on the query.StatusChangelogFeaturesBasic operations such as selecting, updating & deleting.Index optimization.“More Like This”support (if set up in Solr).Spelling correction(if set up in Solr).Timeout support.SolrCloud awarenessRequirementsPython 2.7 - 3.7Requests 2.9.1+Optional-simplejsonOptional-kazoofor SolrCloud modeInstallationpysolr is on PyPI:$pipinstallpysolrOr if you want to install directly from the repository:$pythonsetup.pyinstallUsageBasic usage looks like:# If on Python 2.Xfrom__future__importprint_functionimportpysolr# Create a client instance. The timeout and authentication options are not required.solr=pysolr.Solr('http://localhost:8983/solr/',always_commit=True,[timeout=10],[auth=<typeofauthentication>])# Note that auto_commit defaults to False for performance. You can set# `auto_commit=True` to have commands always update the index immediately, make# an update call with `commit=True`, or use Solr's `autoCommit` / `commitWithin`# to have your data be committed following a particular policy.# Do a health check.solr.ping()# How you'd index data.solr.add([{"id":"doc_1","title":"A test document",},{"id":"doc_2","title":"The Banana: Tasty or Dangerous?","_doc":[{"id":"child_doc_1","title":"peel"},{"id":"child_doc_2","title":"seed"},]},])# You can index a parent/child document relationship by# associating a list of child documents with the special key '_doc'. This# is helpful for queries that join together conditions on children and parent# documents.# Later, searching is easy. In the simple case, just a plain Lucene-style# query is fine.results=solr.search('bananas')# The ``Results`` object stores total results found, by default the top# ten most relevant results and any additional data like# facets/highlighting/spelling/etc.print("Saw{0}result(s).".format(len(results)))# Just loop over it to access the results.forresultinresults:print("The title is '{0}'.".format(result['title']))# For a more advanced query, say involving highlighting, you can pass# additional options to Solr.results=solr.search('bananas',**{'hl':'true','hl.fragsize':10,})# You can also perform More Like This searches, if your Solr is configured# correctly.similar=solr.more_like_this(q='id:doc_2',mltfl='text')# Finally, you can delete either individual documents,solr.delete(id='doc_1')# also in batches...solr.delete(id=['doc_1','doc_2'])# ...or all documents.solr.delete(q='*:*')# For SolrCloud mode, initialize your Solr like this:zookeeper=pysolr.ZooKeeper("zkhost1:2181,zkhost2:2181,zkhost3:2181")solr=pysolr.SolrCloud(zookeeper,"collection1",auth=<typeofauthentication>)Multicore IndexSimply point the URL to the index core:# Setup a Solr instance. The timeout is optional.solr=pysolr.Solr('http://localhost:8983/solr/core_0/',timeout=10)Custom Request Handlers# Setup a Solr instance. The trailing slash is optional.solr=pysolr.Solr('http://localhost:8983/solr/core_0/',search_handler='/autocomplete',use_qt_param=False)Ifuse_qt_paramisTrueit is essential that the name of the handler is
exactly what is configured insolrconfig.xml, including the leading slash
if any. Ifuse_qt_paramisFalse(default), the leading and trailing
slashes can be omitted.Ifsearch_handleris not specified, pysolr will default to/select.The handlers for MoreLikeThis, Update, Terms etc. all default to the values set
in thesolrconfig.xmlSOLR ships with:mlt,update,termsetc.
The specific methods of pysolr’sSolrclass (likemore_like_this,suggest_termsetc.) allow for a kwarghandlerto override that value.
This includes thesearchmethod. Setting a handler insearchexplicitly
overrides thesearch_handlersetting (if any).Custom Authentication# Setup a Solr instance in a kerborized enviornmentfromrequests_kerberosimportHTTPKerberosAuth,OPTIONALkerberos_auth=HTTPKerberosAuth(mutual_authentication=OPTIONAL,sanitize_mutual_error_response=False)solr=pysolr.Solr('http://localhost:8983/solr/',auth=kerberos_auth)# Setup a CloudSolr instance in a kerborized environmentfromrequests_kerberosimportHTTPKerberosAuth,OPTIONALkerberos_auth=HTTPKerberosAuth(mutual_authentication=OPTIONAL,sanitize_mutual_error_response=False)zookeeper=pysolr.ZooKeeper("zkhost1:2181/solr, zkhost2:2181,...,zkhostN:2181")solr=pysolr.SolrCloud(zookeeper,"collection",auth=kerberos_auth)If your Solr servers run off https# Setup a Solr instance in an https environmentsolr=pysolr.Solr('http://localhost:8983/solr/',verify=path/to/cert.pem)# Setup a CloudSolr instance in a kerborized environmentzookeeper=pysolr.ZooKeeper("zkhost1:2181/solr, zkhost2:2181,...,zkhostN:2181")solr=pysolr.SolrCloud(zookeeper,"collection",verify=path/to/cert.perm)Custom Commit Policy# Setup a Solr instance. The trailing slash is optional.# All requests to Solr will be immediately committed because `always_commit=True`:solr=pysolr.Solr('http://localhost:8983/solr/core_0/',search_handler='/autocomplete',always_commit=True)always_commitsignals to the Solr object to either commit or not commit by
default for any solr request. Be sure to change this toTrueif you are
upgrading from a version where the default policy was always commit by default.Functions likeaddanddeletealso still provide a way to override the
default by passing thecommitkwarg.It is generally good practice to limit the amount of commits to Solr as
excessive commits risk opening too many searchers or excessive system
resource consumption. See the Solr documentation for more information and
details about theautoCommitandcommitWithinoptions:https://lucene.apache.org/solr/guide/7_7/updatehandlers-in-solrconfig.html#UpdateHandlersinSolrConfig-autoCommitLICENSEpysolris licensed under the New BSD license.Contributing to pysolrFor consistency, this project usespre-committo manage Git commit hooks:Install thepre-commitpackage: e.g.brew install pre-commit,pip install pre-commit, etc.Runpre-commit installeach time you check out a new copy of this Git
repository to ensure that every subsequent commit will be processed by
runningpre-commit run, which you may also do as desired. To test the
entire repository or in a CI scenario, you can check every file rather than
just the staged ones usingpre-commit run –all.Running TestsTherun-tests.pyscript will automatically perform the steps below and is
recommended for testing by default unless you need more control.Running a test Solr instanceDownloading, configuring and running Solr 4 looks like this:./start-solr-test-server.shRunning the tests$python-munittesttests