Functions
	init (engine_settings)

	search (query, params)

	_fetch_results (cur)

Variables
str	engine_type = 'offline'

str	host = "127.0.0.1"

str	port = "5432"

str	database = ""

str	username = ""

str	password = ""

str	query_str = ""

int	limit = 10

bool	paging = True

str	result_template = 'key-value.html'

	_connection = None

Detailed Description

PostgreSQL is a powerful and robust open source database.  Before configuring
the PostgreSQL engine, you must install the dependency ``psychopg2``.

Example
=======

Below is an example configuration:

.. code:: yaml

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

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

Function Documentation

◆ _fetch_results()

searx.engines.postgresql._fetch_results ( cur )

protected

Definition at line 72 of file postgresql.py.

def _fetch_results(cur):
    results = []
    titles = []
 
    try:
        titles = [column_desc.name for column_desc in cur.description]
 
        for res in cur:
            result = dict(zip(titles, map(str, res)))
            result['template'] = result_template
            results.append(result)
 
    # no results to fetch
    except psycopg2.ProgrammingError:
        pass
 
    return results

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

Here is the caller graph for this function:

◆ init()

searx.engines.postgresql.init ( engine_settings )

Definition at line 44 of file postgresql.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 = psycopg2.connect(
        database=database,
        user=username,
        password=password,
        host=host,
        port=port,
    )
 
 

◆ search()

searx.engines.postgresql.search	(		query,
			params )

Definition at line 62 of file postgresql.py.

def search(query, params):
    query_params = {'query': query}
    query_to_run = query_str + ' LIMIT {0} OFFSET {1}'.format(limit, (params['pageno'] - 1) * limit)
 
    with _connection:
        with _connection.cursor() as cur:
            cur.execute(query_to_run, query_params)
            return _fetch_results(cur)
 
 

References searx.engines.postgresql._fetch_results(), and searx.format.

Here is the call graph for this function:

Variable Documentation

◆ _connection

searx.engines.postgresql._connection = None

protected

Definition at line 41 of file postgresql.py.

◆ database

str searx.engines.postgresql.database = ""

Definition at line 34 of file postgresql.py.

◆ engine_type

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

Definition at line 31 of file postgresql.py.

◆ host

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

Definition at line 32 of file postgresql.py.

◆ limit

int searx.engines.postgresql.limit = 10

Definition at line 38 of file postgresql.py.

◆ paging

bool searx.engines.postgresql.paging = True

Definition at line 39 of file postgresql.py.

◆ password

str searx.engines.postgresql.password = ""

Definition at line 36 of file postgresql.py.

◆ port

str searx.engines.postgresql.port = "5432"

Definition at line 33 of file postgresql.py.

◆ query_str

str searx.engines.postgresql.query_str = ""

Definition at line 37 of file postgresql.py.

◆ result_template

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

Definition at line 40 of file postgresql.py.

◆ username

str searx.engines.postgresql.username = ""

Definition at line 35 of file postgresql.py.

Functions

Variables