Functions
	init (_)
	connect ()
EngineResults	search (query, params)

Variables
str	engine_type = 'offline'
str	host = '127.0.0.1'
int	port = 27017
str	username = ''
str	password = ''
	database = None
	collection = None
	key = None
bool	paging = True
int	results_per_page = 20
bool	exact_match_only = False
	_client = None

Detailed Description

MongoDB_ is a document based database program that handles JSON like data.
Before configuring the ``mongodb`` engine, you must install the dependency
pymongo_.

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

In order to query MongoDB_, you have to select a ``database`` and a
``collection``.  Furthermore, you have to select a ``key`` that is going to be
searched.  MongoDB_ also supports the option ``exact_match_only``, so configure
it as you wish.

Example
=======

Below is an example configuration for using a MongoDB collection:

.. code:: yaml

  # MongoDB engine
  # Required dependency: pymongo

  - name: mymongo
    engine: mongodb
    shortcut: md
    exact_match_only: false
    host: '127.0.0.1'
    port: 27017
    enable_http: true
    results_per_page: 20
    database: 'business'
    collection: 'reviews'  # name of the db collection
    key: 'name'            # key in the collection to search for

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

Function Documentation

◆ connect()

searx.engines.mongodb.connect ( )

Definition at line 76 of file mongodb.py.

def connect():
    global _client  # pylint: disable=global-statement
    kwargs: dict[str, str | int] = {'port': port}
    if username:
        kwargs['username'] = username
    if password:
        kwargs['password'] = password
    _client = MongoClient(host, **kwargs)[database][collection]
 
 

Referenced by init().

Here is the caller graph for this function:

◆ init()

searx.engines.mongodb.init ( _ )

Definition at line 72 of file mongodb.py.

def init(_):
    connect()

References connect().

Here is the call graph for this function:

◆ search()

EngineResults searx.engines.mongodb.search	(		query,
			params )

Definition at line 86 of file mongodb.py.

def search(query, params) -> EngineResults:
    res = EngineResults()
    if exact_match_only:
        q = {'$eq': query}
    else:
        _re = re.compile('.*{0}.*'.format(re.escape(query)), re.I | re.M)
        q = {'$regex': _re}
 
    query = _client.find({key: q}).skip((params['pageno'] - 1) * results_per_page).limit(results_per_page)
 
    res.add(res.types.LegacyResult(number_of_results=query.count()))
    for row in query:
        del row['_id']
        kvmap = {str(k): str(v) for k, v in row.items()}
        res.add(res.types.KeyValue(kvmap=kvmap))
 
    return res

Variable Documentation

◆ _client

searx.engines.mongodb._client = None

protected

Definition at line 69 of file mongodb.py.

◆ collection

searx.engines.mongodb.collection = None

Definition at line 61 of file mongodb.py.

◆ database

searx.engines.mongodb.database = None

Definition at line 60 of file mongodb.py.

◆ engine_type

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

Definition at line 53 of file mongodb.py.

◆ exact_match_only

bool searx.engines.mongodb.exact_match_only = False

Definition at line 67 of file mongodb.py.

◆ host

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

Definition at line 56 of file mongodb.py.

◆ key

searx.engines.mongodb.key = None

Definition at line 62 of file mongodb.py.

◆ paging

bool searx.engines.mongodb.paging = True

Definition at line 65 of file mongodb.py.

◆ password

str searx.engines.mongodb.password = ''

Definition at line 59 of file mongodb.py.

◆ port

int searx.engines.mongodb.port = 27017

Definition at line 57 of file mongodb.py.

◆ results_per_page

int searx.engines.mongodb.results_per_page = 20

Definition at line 66 of file mongodb.py.

◆ username

str searx.engines.mongodb.username = ''

Definition at line 58 of file mongodb.py.

Functions

Variables