Loading...
Searching...
No Matches
Functions | |
| init (engine_settings) | |
| sqlite_cursor () | |
| EngineResults | search (query, params) |
Variables | |
| str | engine_type = "offline" |
| str | database = "" |
| str | query_str = "" |
| typing | result_type = "KeyValue" |
| int | limit = 10 |
| bool | paging = True |
Detailed Description
SQLite is a small, fast and reliable SQL database engine. It does not require
any extra dependency.
Configuration
=============
The engine has the following (additional) settings:
- :py:obj:`result_type`
Example
=======
.. _MediathekView: https://mediathekview.de/
To demonstrate the power of database engines, here is a more complex example
which reads from a MediathekView_ (DE) movie database. For this example of the
SQLite engine download the database:
- https://liste.mediathekview.de/filmliste-v2.db.bz2
and unpack into ``searx/data/filmliste-v2.db``. To search the database use e.g
Query to test: ``!mediathekview concert``
.. code:: yaml
- name: mediathekview
engine: sqlite
shortcut: mediathekview
categories: [general, videos]
result_type: MainResult
database: searx/data/filmliste-v2.db
query_str: >-
SELECT title || ' (' || time(duration, 'unixepoch') || ')' AS title,
COALESCE( NULLIF(url_video_hd,''), NULLIF(url_video_sd,''), url_video) AS url,
description AS content
FROM film
WHERE title LIKE :wildcard OR description LIKE :wildcard
ORDER BY duration DESC
Implementations
===============
Function Documentation
◆ init()
| searx.engines.sqlite.init | ( | engine_settings | ) |
Definition at line 69 of file sqlite.py.
69def init(engine_settings):
70 if 'query_str' not in engine_settings:
71 raise ValueError('query_str cannot be empty')
72
73 if not engine_settings['query_str'].lower().startswith('select '):
74 raise ValueError('only SELECT query is supported')
75
76
77@contextlib.contextmanager
◆ search()
| EngineResults searx.engines.sqlite.search | ( | query, | |
| params ) |
Definition at line 96 of file sqlite.py.
96def search(query, params) -> EngineResults:
97 res = EngineResults()
98 query_params = {
99 'query': query,
100 'wildcard': r'%' + query.replace(' ', r'%') + r'%',
101 'limit': limit,
102 'offset': (params['pageno'] - 1) * limit,
103 }
104 query_to_run = query_str + ' LIMIT :limit OFFSET :offset'
105
106 with sqlite_cursor() as cur:
107
108 cur.execute(query_to_run, query_params)
109 col_names = [cn[0] for cn in cur.description]
110
111 for row in cur.fetchall():
112 kvmap = dict(zip(col_names, map(str, row)))
113 if result_type == "MainResult":
114 item = MainResult(**kvmap) # type: ignore
115 else:
116 item = KeyValue(kvmap=kvmap)
117 res.add(item)
118
119 return res
References sqlite_cursor().
Here is the call graph for this function:◆ sqlite_cursor()
| searx.engines.sqlite.sqlite_cursor | ( | ) |
Implements a :py:obj:`Context Manager <contextlib.contextmanager>` for a :py:obj:`sqlite3.Cursor`. Open database in read only mode: if the database doesn't exist. The default mode creates an empty file on the file system. See: * https://docs.python.org/3/library/sqlite3.html#sqlite3.connect * https://www.sqlite.org/uri.html
Definition at line 78 of file sqlite.py.
78def sqlite_cursor():
79 """Implements a :py:obj:`Context Manager <contextlib.contextmanager>` for a
80 :py:obj:`sqlite3.Cursor`.
81
82 Open database in read only mode: if the database doesn't exist. The default
83 mode creates an empty file on the file system. See:
84
85 * https://docs.python.org/3/library/sqlite3.html#sqlite3.connect
86 * https://www.sqlite.org/uri.html
87
88 """
89 uri = 'file:' + database + '?mode=ro'
90 with contextlib.closing(sqlite3.connect(uri, uri=True)) as connect:
91 connect.row_factory = sqlite3.Row
92 with contextlib.closing(connect.cursor()) as cursor:
93 yield cursor
94
95
Referenced by search().
Here is the caller graph for this function: