Functions
	init (_engine_settings)
EngineResults	search (query, _params)
list[dict]	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
bool	exact_match_only = True
	_valkey_client = None

Detailed Description

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

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: valkey

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

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

Function Documentation

◆ init()

searx.engines.valkey_server.init ( _engine_settings )

Definition at line 56 of file valkey_server.py.

def init(_engine_settings):
    global _valkey_client  # pylint: disable=global-statement
    _valkey_client = valkey.StrictValkey(
        host=host,
        port=port,
        db=db,
        password=password or None,
        decode_responses=True,
    )
 
 

◆ search()

EngineResults searx.engines.valkey_server.search	(		query,
			_params )

Definition at line 67 of file valkey_server.py.

def search(query, _params) -> EngineResults:
    res = EngineResults()
 
    if not exact_match_only:
        for kvmap in search_keys(query):
            res.add(res.types.KeyValue(kvmap=kvmap))
        return res
 
    kvmap: dict[str, str] = _valkey_client.hgetall(query)
    if kvmap:
        res.add(res.types.KeyValue(kvmap=kvmap))
    elif " " in query:
        qset, rest = query.split(" ", 1)
        for row in _valkey_client.hscan_iter(qset, match='*{}*'.format(rest)):
            res.add(res.types.KeyValue(kvmap={row[0]: row[1]}))
    return res
 
 

References search_keys().

Here is the call graph for this function:

◆ search_keys()

list[dict] searx.engines.valkey_server.search_keys ( query )

Definition at line 85 of file valkey_server.py.

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

Referenced by search().

Here is the caller graph for this function:

Variable Documentation

◆ _valkey_client

searx.engines.valkey_server._valkey_client = None

protected

Definition at line 53 of file valkey_server.py.

◆ db

int searx.engines.valkey_server.db = 0

Definition at line 47 of file valkey_server.py.

◆ engine_type

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

Definition at line 41 of file valkey_server.py.

◆ exact_match_only

bool searx.engines.valkey_server.exact_match_only = True

Definition at line 51 of file valkey_server.py.

◆ host

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

Definition at line 44 of file valkey_server.py.

◆ paging

bool searx.engines.valkey_server.paging = False

Definition at line 50 of file valkey_server.py.

◆ password

str searx.engines.valkey_server.password = ''

Definition at line 46 of file valkey_server.py.

◆ port

int searx.engines.valkey_server.port = 6379

Definition at line 45 of file valkey_server.py.

Functions

Variables