Functions
	init (engine_settings)
EngineResults	search (query, params)

Variables
str	engine_type = 'offline'
str	host = "127.0.0.1"
int	port = 3306
str	database = ""
str	username = ""
str	password = ""
str	query_str = ""
int	limit = 10
bool	paging = True
	_connection = None

Detailed Description

MariaDB is a community driven fork of MySQL. Before enabling MariaDB engine,
you must the install the pip package ``mariadb`` along with the necessary
prerequities.

`See the following documentation for more details
<https://mariadb.com/docs/server/connect/programming-languages/c/install/>`_

Example
=======

This is an example configuration for querying a MariaDB server:

.. code:: yaml

   - name: my_database
     engine: mariadb_server
     database: my_database
     username: searxng
     password: password
     limit: 5
     query_str: 'SELECT * from my_table WHERE my_column=%(query)s'

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

Function Documentation

◆ init()

searx.engines.mariadb_server.init ( engine_settings )

Definition at line 63 of file mariadb_server.py.

def init(engine_settings):
    global _connection  # pylint: disable=global-statement
 
    if 'query_str' not in engine_settings:
        raise ValueError('query_str cannot be empty')
 
    if not engine_settings['query_str'].lower().startswith('select '):
        raise ValueError('only SELECT query is supported')
 
    _connection = mariadb.connect(database=database, user=username, password=password, host=host, port=port)

◆ search()

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

Definition at line 75 of file mariadb_server.py.

def search(query, params) -> EngineResults:
    query_params = {'query': query}
    query_to_run = query_str + ' LIMIT {0} OFFSET {1}'.format(limit, (params['pageno'] - 1) * limit)
    logger.debug("SQL Query: %s", query_to_run)
    res = EngineResults()
 
    with _connection.cursor() as cur:
        cur.execute(query_to_run, query_params)
        col_names = [i[0] for i in cur.description]
        for row in cur:
            kvmap = dict(zip(col_names, map(str, row)))
            res.add(res.types.KeyValue(kvmap=kvmap))
    return res

Variable Documentation

◆ _connection

searx.engines.mariadb_server._connection = None

protected

Definition at line 60 of file mariadb_server.py.

◆ database

str searx.engines.mariadb_server.database = ""

Definition at line 46 of file mariadb_server.py.

◆ engine_type

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

Definition at line 38 of file mariadb_server.py.

◆ host

str searx.engines.mariadb_server.host = "127.0.0.1"

Definition at line 40 of file mariadb_server.py.

◆ limit

int searx.engines.mariadb_server.limit = 10

Definition at line 58 of file mariadb_server.py.

◆ paging

bool searx.engines.mariadb_server.paging = True

Definition at line 59 of file mariadb_server.py.

◆ password

str searx.engines.mariadb_server.password = ""

Definition at line 52 of file mariadb_server.py.

◆ port

int searx.engines.mariadb_server.port = 3306

Definition at line 43 of file mariadb_server.py.

◆ query_str

str searx.engines.mariadb_server.query_str = ""

Definition at line 55 of file mariadb_server.py.

◆ username

str searx.engines.mariadb_server.username = ""

Definition at line 49 of file mariadb_server.py.

Functions

Variables