blob: 6e5a7d03fa2981d1e329e9116d90f2d8e0ed1a1d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>searx.engines.sqlite — SearXNG Documentation (2024.5.10+ffb1001f8)</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=4f649999" />
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css?v=a5c4661c" />
<script src="../../../_static/documentation_options.js?v=ae3a6ae6"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/tabs.js?v=3030b3cb"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2024.5.10+ffb1001f8)</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> »</li>
<li class="nav-item nav-item-this"><a href="">searx.engines.sqlite</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.engines.sqlite</h1><div class="highlight"><pre>
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
<span class="sd">"""SQLite is a small, fast and reliable SQL database engine. It does not require</span>
<span class="sd">any extra dependency.</span>
<span class="sd">Example</span>
<span class="sd">=======</span>
<span class="sd">.. _MediathekView: https://mediathekview.de/</span>
<span class="sd">To demonstrate the power of database engines, here is a more complex example</span>
<span class="sd">which reads from a MediathekView_ (DE) movie database. For this example of the</span>
<span class="sd">SQLite engine download the database:</span>
<span class="sd">- https://liste.mediathekview.de/filmliste-v2.db.bz2</span>
<span class="sd">and unpack into ``searx/data/filmliste-v2.db``. To search the database use e.g</span>
<span class="sd">Query to test: ``!mediathekview concert``</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> - name: mediathekview</span>
<span class="sd"> engine: sqlite</span>
<span class="sd"> disabled: False</span>
<span class="sd"> categories: general</span>
<span class="sd"> result_template: default.html</span>
<span class="sd"> database: searx/data/filmliste-v2.db</span>
<span class="sd"> query_str: >-</span>
<span class="sd"> SELECT title || ' (' || time(duration, 'unixepoch') || ')' AS title,</span>
<span class="sd"> COALESCE( NULLIF(url_video_hd,''), NULLIF(url_video_sd,''), url_video) AS url,</span>
<span class="sd"> description AS content</span>
<span class="sd"> FROM film</span>
<span class="sd"> WHERE title LIKE :wildcard OR description LIKE :wildcard</span>
<span class="sd"> ORDER BY duration DESC</span>
<span class="sd">Implementations</span>
<span class="sd">===============</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="kn">import</span> <span class="nn">contextlib</span>
<span class="n">engine_type</span> <span class="o">=</span> <span class="s1">'offline'</span>
<span class="n">database</span> <span class="o">=</span> <span class="s2">""</span>
<span class="n">query_str</span> <span class="o">=</span> <span class="s2">""</span>
<span class="n">limit</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">result_template</span> <span class="o">=</span> <span class="s1">'key-value.html'</span>
<span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
<span class="k">if</span> <span class="s1">'query_str'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'query_str cannot be empty'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">'query_str'</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'select '</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'only SELECT query is supported'</span><span class="p">)</span>
<div class="viewcode-block" id="sqlite_cursor">
<a class="viewcode-back" href="../../../dev/engines/offline/sql-engines.html#searx.engines.sqlite.sqlite_cursor">[docs]</a>
<span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
<span class="k">def</span> <span class="nf">sqlite_cursor</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""Implements a :py:obj:`Context Manager <contextlib.contextmanager>` for a</span>
<span class="sd"> :py:obj:`sqlite3.Cursor`.</span>
<span class="sd"> Open database in read only mode: if the database doesn't exist. The default</span>
<span class="sd"
|
