Skip to main content

Lightweight Python client for Apache Solr.

Project description

aiosolr

AsyncIO Python client for Apache Solr

Requirements

This project requires Python 3.6+

Installation

To install with pip

pip install aiosolr

Usage

The connection to the Solr backend is defined during object initialization. The accepted kwargs to init are scheme, host, port, collection, and timeout.

Note: collection may also be passed at query time

import aiosolr

solr = aiosolr.Solr(host=localhost, collection="example", port=8983)

Once you have your Solr instance, there are methods available for querying.

You can use Solr's built-in get handler with the get method like:

solr.get(document_id)

to retrieve a single document.

You can use a pre-defined suggestions handler by using the suggestions method like:

solr.suggestions("suggest_handler", query="asdf")

You can also use the suggestions method to build your suggestions like:

solr.suggestions("suggest_handler", build=True)

Note: handler is a required argument for suggestions unlike for get or query

You can use the query method to query your search handler. The default handler used is "select". If you would like spellcheck suggestion turned on, pass spellcheck=True (default is False).

solr.query(handler="my_handler", query="asdf", spellcheck=True)

If spellcheck is True the query method returns a tuple with the first element being an array of documents and the 2nd element being an array of spellcheck suggestions. Otherwise, the query method returns a simple array of documents.

You can use the update method to access Solr's built-in update handler like:

solr.update(my_data)

At any point that you need to commit data to your collection you can use the commit method. Arguments should be the "handler" ("update" by default) and "soft" as a boolean indicating whether it should be a hard or soft commit (defaults to False).

There is one more method you might want to use before querying Solr especially if the query is coming from an untrusted end user. There is a clean method which can be used to strip out unwanted characters. The function signature allows the following arguments:

@staticmethod
def clean(
    query,  # end user query
    allow_html_tags=False,
    allow_http=False,
    allow_wildcard=False,
    escape_chars=(":", r"\:"),  # tuple of (replace_me, replace_with)
    max_len=200,
    remove_chars=r'[\&\|\!\(\)\{\}\[\]\^"~\?\\\*]',  # regex of chars to remove
):

Once you are finished with the Solr instance, you should call the method close to cleanup sessions like:

await solr.close()

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiosolr-2.4.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

aiosolr-2.4.2-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file aiosolr-2.4.2.tar.gz.

File metadata

  • Download URL: aiosolr-2.4.2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.7.4

File hashes

Hashes for aiosolr-2.4.2.tar.gz
Algorithm Hash digest
SHA256 2ad920d8765643b9dc3aa84e506f6968b343125172eb1a5e04607dbad103ff07
MD5 53616811a1122bcb5ee7729a17015b47
BLAKE2b-256 0b8f4da3d54125c7a3edf1eb5bf6804e0133e09635743facfb6f6b164eaf90b0

See more details on using hashes here.

File details

Details for the file aiosolr-2.4.2-py3-none-any.whl.

File metadata

  • Download URL: aiosolr-2.4.2-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.7.4

File hashes

Hashes for aiosolr-2.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d4984dd91f39d39314a1160722bf290876889b9d5997a65121c57d8d7d0054a4
MD5 280dc25f4b01fde0cd3031d7f9fd1741
BLAKE2b-256 fe561765e0b4bd1a5ab941b8c5cbe604e8369796f3dcfa2ba0484e34b686da8f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page