Functions
	init (_)

	request (query, params)

EngineResults	response (SXNG_Response resp)

Variables
str	base_url = 'http://localhost:8983'

str	collection = ''

int	rows = 10

str	sort = ''

str	field_list = 'name'

str	default_fields = ''

str	query_fields = ''

str	_search_url = ''

bool	paging = True

Detailed Description

.. sidebar:: info

   - :origin:`solr.py <searx/engines/solr.py>`
   - `Solr <https://solr.apache.org>`_
   - `Solr Resources <https://solr.apache.org/resources.html>`_
   - `Install Solr <https://solr.apache.org/guide/installing-solr.html>`_

Solr_ is a popular search engine based on Lucene, just like Elasticsearch_.  But
instead of searching in indices, you can search in collections.

Example
=======

This is an example configuration for searching in the collection
``my-collection`` and get the results in ascending order.

.. code:: yaml

  - name: solr
    engine: solr
    shortcut: slr
    base_url: http://localhost:8983
    collection: my-collection
    sort: asc
    enable_http: true

Function Documentation

◆ init()

searx.engines.solr.init ( _ )

Definition at line 49 of file solr.py.

def init(_):
    if collection == '':
        raise ValueError('collection cannot be empty')
 
    global _search_url
    _search_url = base_url + '/solr/' + collection + '/select?{params}'
 
 

◆ request()

searx.engines.solr.request	(		query,
			params )

Definition at line 57 of file solr.py.

def request(query, params):
    query_params = {'q': query, 'rows': rows}
    if field_list != '':
        query_params['fl'] = field_list
    if query_fields != '':
        query_params['qf'] = query_fields
    if default_fields != '':
        query_params['df'] = default_fields
    if sort != '':
        query_params['sort'] = sort
 
    if 'pageno' in params:
        query_params['start'] = rows * (params['pageno'] - 1)
 
    params['url'] = _search_url.format(params=urlencode(query_params))
 
    return params
 
 

◆ response()

EngineResults searx.engines.solr.response ( SXNG_Response resp )

Definition at line 76 of file solr.py.

def response(resp: SXNG_Response) -> EngineResults:
    try:
        resp_json = resp.json()
    except Exception as e:
        raise SearxEngineAPIException("failed to parse response") from e
 
    if "error" in resp_json:
        raise SearxEngineAPIException(resp_json["error"]["msg"])
 
    res = EngineResults()
 
    for result in resp_json["response"]["docs"]:
        kvmap = {key: str(value) for key, value in result.items()}
        if not kvmap:
            continue
        res.add(res.types.KeyValue(kvmap=kvmap))
 
    return res

Variable Documentation

◆ _search_url

str searx.engines.solr._search_url = ''

protected

Definition at line 45 of file solr.py.

◆ base_url

str searx.engines.solr.base_url = 'http://localhost:8983'

Definition at line 38 of file solr.py.

◆ collection

str searx.engines.solr.collection = ''

Definition at line 39 of file solr.py.

◆ default_fields

str searx.engines.solr.default_fields = ''

Definition at line 43 of file solr.py.

◆ field_list

str searx.engines.solr.field_list = 'name'

Definition at line 42 of file solr.py.

◆ paging

bool searx.engines.solr.paging = True

Definition at line 46 of file solr.py.

◆ query_fields

str searx.engines.solr.query_fields = ''

Definition at line 44 of file solr.py.

◆ rows

int searx.engines.solr.rows = 10

Definition at line 40 of file solr.py.

◆ sort

str searx.engines.solr.sort = ''

Definition at line 41 of file solr.py.

Functions

Variables