Functions
	init (_engine_settings)

	search (query, _params)

	search_keys (query)

Variables
str	engine_type = 'offline'

str	host = '127.0.0.1'

int	port = 6379

str	password = ''

int	db = 0

bool	paging = False

str	result_template = 'key-value.html'

bool	exact_match_only = True

	_redis_client = None

Detailed Description

Redis is an open source (BSD licensed), in-memory data structure (key value
based) store.  Before configuring the ``redis_server`` engine, you must install
the dependency redis_.

Configuration
=============

Select a database to search in and set its index in the option ``db``.  You can
either look for exact matches or use partial keywords to find what you are
looking for by configuring ``exact_match_only``.

Example
=======

Below is an example configuration:

.. code:: yaml

  # Required dependency: redis

  - name: myredis
    shortcut : rds
    engine: redis_server
    exact_match_only: false
    host: '127.0.0.1'
    port: 6379
    enable_http: true
    password: ''
    db: 0

Implementations
===============

Function Documentation

◆ init()

searx.engines.redis_server.init ( _engine_settings )

Definition at line 55 of file redis_server.py.

def init(_engine_settings):
    global _redis_client  # pylint: disable=global-statement
    _redis_client = redis.StrictRedis(
        host=host,
        port=port,
        db=db,
        password=password or None,
        decode_responses=True,
    )
 
 

◆ search()

searx.engines.redis_server.search	(		query,
			_params )

Definition at line 66 of file redis_server.py.

def search(query, _params):
    if not exact_match_only:
        return search_keys(query)
 
    ret = _redis_client.hgetall(query)
    if ret:
        ret['template'] = result_template
        return [ret]
 
    if ' ' in query:
        qset, rest = query.split(' ', 1)
        ret = []
        for res in _redis_client.hscan_iter(qset, match='*{}*'.format(rest)):
            ret.append(
                {
                    res[0]: res[1],
                    'template': result_template,
                }
            )
        return ret
    return []
 
 

References searx.format, and searx.engines.redis_server.search_keys().

Here is the call graph for this function:

◆ search_keys()

searx.engines.redis_server.search_keys ( query )

Definition at line 89 of file redis_server.py.

def search_keys(query):
    ret = []
    for key in _redis_client.scan_iter(match='*{}*'.format(query)):
        key_type = _redis_client.type(key)
        res = None
 
        if key_type == 'hash':
            res = _redis_client.hgetall(key)
        elif key_type == 'list':
            res = dict(enumerate(_redis_client.lrange(key, 0, -1)))
 
        if res:
            res['template'] = result_template
            res['redis_key'] = key
            ret.append(res)
    return ret

References searx.format.

Referenced by searx.engines.redis_server.search().

Here is the caller graph for this function:

Variable Documentation

◆ _redis_client

searx.engines.redis_server._redis_client = None

protected

Definition at line 52 of file redis_server.py.

◆ db

int searx.engines.redis_server.db = 0

Definition at line 45 of file redis_server.py.

◆ engine_type

str searx.engines.redis_server.engine_type = 'offline'

Definition at line 39 of file redis_server.py.

◆ exact_match_only

bool searx.engines.redis_server.exact_match_only = True

Definition at line 50 of file redis_server.py.

◆ host

str searx.engines.redis_server.host = '127.0.0.1'

Definition at line 42 of file redis_server.py.

◆ paging

bool searx.engines.redis_server.paging = False

Definition at line 48 of file redis_server.py.

◆ password

str searx.engines.redis_server.password = ''

Definition at line 44 of file redis_server.py.

◆ port

int searx.engines.redis_server.port = 6379

Definition at line 43 of file redis_server.py.

◆ result_template

str searx.engines.redis_server.result_template = 'key-value.html'

Definition at line 49 of file redis_server.py.

Functions

Variables