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

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

Alternatively you may instantiate via passing a connection URL like:

import aiosolr

client = aiosolr.Solr(connection_url="http://host:1234/path/to/solr/collection")

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:

client.get(document_id)

to retrieve a single document.

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

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

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

client.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).

client.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:

client.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,
    # regex of chars to remove
    remove_chars=r'[\&\|\!\(\)\{\}\[\]\^"~\?\\;]',
):

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

await client.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-3.4.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

aiosolr-3.4.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiosolr-3.4.0.tar.gz
Algorithm Hash digest
SHA256 934e755e8d319dd7c8748932a5bf2e1effbd12b400f8fd0241a99e486a8a8eff
MD5 51b0f82ee71e113e9015442588da6397
BLAKE2b-256 af35ebebf67e6ea23d8d4d987a019a3d27073c257556dcc062c8db6e1c5396fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiosolr-3.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 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/49.2.1 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.8.7

File hashes

Hashes for aiosolr-3.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e6c100c0fc07f2e4d6c9003ce661b7860e4a80ed7a7983a5ca0e7d37d413af2
MD5 4ec149042a7c5d14d93ffde2d93d7e52
BLAKE2b-256 c6c160d35cd2f3a50630a36f473f769e37ed324b7cdbd9b29bbc12f164394366

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