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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
|
%global _empty_manifest_terminate_build 0
Name: python-django-sphinxsearch
Version: 4.2.0
Release: 1
Summary: Sphinxsearch database backend for django>=2.0
License: Beerware
URL: http://github.com/tumb1er/django_sphinxsearch
Source0: https://mirrors.aliyun.com/pypi/web/packages/5d/08/abf7a6279f0e8b0b4ff2a6a2b1924215009e77bc6787b64423f5cd34b2b2/django_sphinxsearch-4.2.0.tar.gz
BuildArch: noarch
%description
# Django-sphinxsearch
[SphinxSearch](http://sphinxsearch.com) database backend for [Django](https://www.djangoproject.com/).
[](https://codecov.io/gh/tumb1er/django_sphinxsearch)
[](https://badge.fury.io/py/django-sphinxsearch)
* Not a [django_sphinx_db](https://github.com/smartfile/django-sphinx-db) fork
* `Django>=2.0,<3.1` supported
* Tested against Django-2.2 (LTS) and Django-3.0
## Installation and usage
1. Install django-sphinxsearch package
```sh
pip install django_sphinxsearch
```
2. Configure Django settings
```python
INSTALLED_APPS += (
'sphinxsearch',
)
SPHINX_DATABASE_NAME = 'sphinx'
DATABASES[SPHINX_DATABASE_NAME] = {
'ENGINE': 'sphinxsearch.backend.sphinx',
'HOST': '127.0.0.1',
'PORT': 9306,
'OPTIONS': {
'use_unicode': False # if non-ascii letters looks bad in results
}
}
DATABASE_ROUTERS = ['sphinxsearch.routers.SphinxRouter']
```
3. Create index definitions in sphinx.conf
```
index testapp_testmodel
{
type = rt
path = /data/sphinx/testapp/testmodel/
rt_field = sphinx_field
rt_attr_uint = attr_uint
rt_attr_bool = attr_bool
rt_attr_bigint = attr_bigint
rt_attr_float = attr_float
rt_attr_multi = attr_multi
rt_attr_multi_64 = attr_multi_64
rt_attr_timestamp = attr_timestamp
rt_attr_string = attr_string
rt_attr_json = attr_json
}
```
4. Define Django model for index
```python
from datetime import datetime
from django.db import models
from sphinxsearch import models as spx_models
class FieldMixin(spx_models.SphinxModel):
# Note that NULL values are not allowed for sphinx rt-index.
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
class Meta:
abstract = True
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
sphinx_field = spx_models.SphinxField(default='')
other_field = spx_models.SphinxField(default='')
# Numeric attributes
attr_uint = spx_models.SphinxIntegerField(default=0, db_column='attr_uint_')
attr_bigint = spx_models.SphinxBigIntegerField(default=0)
attr_float = models.FloatField(default=0.0)
attr_timestamp = spx_models.SphinxDateTimeField(default=datetime.now)
attr_bool = models.BooleanField(default=False)
# String attributes
attr_string = models.CharField(max_length=32, default='')
attr_json = spx_models.JSONField(default={})
# Multi-value fields (sets of integer values)
attr_multi = spx_models.SphinxMultiField(default=[])
attr_multi_64 = spx_models.SphinxMulti64Field(default=[])
class TestModel(FieldMixin, spx_models.SphinxModel):
pass
```
5. Query index from your app
```python
# Numeric attributes filtering
TestModel.objects.filter(attr_uint=0, attr_float__gte=10, attr_multi__in=[1, 2])
# For sphinxsearch>=2.2.7, string attr filtering enabled
TestModel.objects.filter(attr_string='some test')
# Use mysql-fulltext-search filtering:
TestModel.objects.filter(sphinx_field__search='find me')
# Run match queries
TestModel.objects.match(
'find in all fields',
sphinx_field='only in this field')
# Insert and update documents to index
obj = TestModel.objects.create(**values)
obj.attr_uint = 1
obj.save()
TestModel.objects.filter(attr_bool=True).update(attr_uint=2)
```
## Run tests
```shell
docker-compose up django
```
## Notes for production usage
* Sphinxsearch engine has some issues with SQL-syntax support, and they vary
from one version to another. I.e. float attributes are not comparable,
string attributes were not comparable till v2.2.7.
* Without limits sphinxsearch returns only 20 matched documents.
* uint attributes accept -1 but return it as unsigned 32bit integer.
* bigint accept 2**63 + 1 but return it as signed 64bit integer.
* Use SphinxIntegerField and SphinxBigIntegerField instead of IntegerField and
BigIntegerField from django.db.models, because IN is an expression in
SQL (`value IN column`), but a function (`IN(value, column)`) in sphinxsearch.
* Since 3.0.1 multi64 field incorrectly parses values greater than 2**31 and is
completely unusable for bigint values.
* In 3.1.1 you can create rt index with same string field and attr from config
but you cant clone this index, so you attr-based filtering does not work.
%package -n python3-django-sphinxsearch
Summary: Sphinxsearch database backend for django>=2.0
Provides: python-django-sphinxsearch
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-django-sphinxsearch
# Django-sphinxsearch
[SphinxSearch](http://sphinxsearch.com) database backend for [Django](https://www.djangoproject.com/).
[](https://codecov.io/gh/tumb1er/django_sphinxsearch)
[](https://badge.fury.io/py/django-sphinxsearch)
* Not a [django_sphinx_db](https://github.com/smartfile/django-sphinx-db) fork
* `Django>=2.0,<3.1` supported
* Tested against Django-2.2 (LTS) and Django-3.0
## Installation and usage
1. Install django-sphinxsearch package
```sh
pip install django_sphinxsearch
```
2. Configure Django settings
```python
INSTALLED_APPS += (
'sphinxsearch',
)
SPHINX_DATABASE_NAME = 'sphinx'
DATABASES[SPHINX_DATABASE_NAME] = {
'ENGINE': 'sphinxsearch.backend.sphinx',
'HOST': '127.0.0.1',
'PORT': 9306,
'OPTIONS': {
'use_unicode': False # if non-ascii letters looks bad in results
}
}
DATABASE_ROUTERS = ['sphinxsearch.routers.SphinxRouter']
```
3. Create index definitions in sphinx.conf
```
index testapp_testmodel
{
type = rt
path = /data/sphinx/testapp/testmodel/
rt_field = sphinx_field
rt_attr_uint = attr_uint
rt_attr_bool = attr_bool
rt_attr_bigint = attr_bigint
rt_attr_float = attr_float
rt_attr_multi = attr_multi
rt_attr_multi_64 = attr_multi_64
rt_attr_timestamp = attr_timestamp
rt_attr_string = attr_string
rt_attr_json = attr_json
}
```
4. Define Django model for index
```python
from datetime import datetime
from django.db import models
from sphinxsearch import models as spx_models
class FieldMixin(spx_models.SphinxModel):
# Note that NULL values are not allowed for sphinx rt-index.
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
class Meta:
abstract = True
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
sphinx_field = spx_models.SphinxField(default='')
other_field = spx_models.SphinxField(default='')
# Numeric attributes
attr_uint = spx_models.SphinxIntegerField(default=0, db_column='attr_uint_')
attr_bigint = spx_models.SphinxBigIntegerField(default=0)
attr_float = models.FloatField(default=0.0)
attr_timestamp = spx_models.SphinxDateTimeField(default=datetime.now)
attr_bool = models.BooleanField(default=False)
# String attributes
attr_string = models.CharField(max_length=32, default='')
attr_json = spx_models.JSONField(default={})
# Multi-value fields (sets of integer values)
attr_multi = spx_models.SphinxMultiField(default=[])
attr_multi_64 = spx_models.SphinxMulti64Field(default=[])
class TestModel(FieldMixin, spx_models.SphinxModel):
pass
```
5. Query index from your app
```python
# Numeric attributes filtering
TestModel.objects.filter(attr_uint=0, attr_float__gte=10, attr_multi__in=[1, 2])
# For sphinxsearch>=2.2.7, string attr filtering enabled
TestModel.objects.filter(attr_string='some test')
# Use mysql-fulltext-search filtering:
TestModel.objects.filter(sphinx_field__search='find me')
# Run match queries
TestModel.objects.match(
'find in all fields',
sphinx_field='only in this field')
# Insert and update documents to index
obj = TestModel.objects.create(**values)
obj.attr_uint = 1
obj.save()
TestModel.objects.filter(attr_bool=True).update(attr_uint=2)
```
## Run tests
```shell
docker-compose up django
```
## Notes for production usage
* Sphinxsearch engine has some issues with SQL-syntax support, and they vary
from one version to another. I.e. float attributes are not comparable,
string attributes were not comparable till v2.2.7.
* Without limits sphinxsearch returns only 20 matched documents.
* uint attributes accept -1 but return it as unsigned 32bit integer.
* bigint accept 2**63 + 1 but return it as signed 64bit integer.
* Use SphinxIntegerField and SphinxBigIntegerField instead of IntegerField and
BigIntegerField from django.db.models, because IN is an expression in
SQL (`value IN column`), but a function (`IN(value, column)`) in sphinxsearch.
* Since 3.0.1 multi64 field incorrectly parses values greater than 2**31 and is
completely unusable for bigint values.
* In 3.1.1 you can create rt index with same string field and attr from config
but you cant clone this index, so you attr-based filtering does not work.
%package help
Summary: Development documents and examples for django-sphinxsearch
Provides: python3-django-sphinxsearch-doc
%description help
# Django-sphinxsearch
[SphinxSearch](http://sphinxsearch.com) database backend for [Django](https://www.djangoproject.com/).
[](https://codecov.io/gh/tumb1er/django_sphinxsearch)
[](https://badge.fury.io/py/django-sphinxsearch)
* Not a [django_sphinx_db](https://github.com/smartfile/django-sphinx-db) fork
* `Django>=2.0,<3.1` supported
* Tested against Django-2.2 (LTS) and Django-3.0
## Installation and usage
1. Install django-sphinxsearch package
```sh
pip install django_sphinxsearch
```
2. Configure Django settings
```python
INSTALLED_APPS += (
'sphinxsearch',
)
SPHINX_DATABASE_NAME = 'sphinx'
DATABASES[SPHINX_DATABASE_NAME] = {
'ENGINE': 'sphinxsearch.backend.sphinx',
'HOST': '127.0.0.1',
'PORT': 9306,
'OPTIONS': {
'use_unicode': False # if non-ascii letters looks bad in results
}
}
DATABASE_ROUTERS = ['sphinxsearch.routers.SphinxRouter']
```
3. Create index definitions in sphinx.conf
```
index testapp_testmodel
{
type = rt
path = /data/sphinx/testapp/testmodel/
rt_field = sphinx_field
rt_attr_uint = attr_uint
rt_attr_bool = attr_bool
rt_attr_bigint = attr_bigint
rt_attr_float = attr_float
rt_attr_multi = attr_multi
rt_attr_multi_64 = attr_multi_64
rt_attr_timestamp = attr_timestamp
rt_attr_string = attr_string
rt_attr_json = attr_json
}
```
4. Define Django model for index
```python
from datetime import datetime
from django.db import models
from sphinxsearch import models as spx_models
class FieldMixin(spx_models.SphinxModel):
# Note that NULL values are not allowed for sphinx rt-index.
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
class Meta:
abstract = True
# Indexed text field. If no attribute with same name defined, can't be
# retrieved from index.
sphinx_field = spx_models.SphinxField(default='')
other_field = spx_models.SphinxField(default='')
# Numeric attributes
attr_uint = spx_models.SphinxIntegerField(default=0, db_column='attr_uint_')
attr_bigint = spx_models.SphinxBigIntegerField(default=0)
attr_float = models.FloatField(default=0.0)
attr_timestamp = spx_models.SphinxDateTimeField(default=datetime.now)
attr_bool = models.BooleanField(default=False)
# String attributes
attr_string = models.CharField(max_length=32, default='')
attr_json = spx_models.JSONField(default={})
# Multi-value fields (sets of integer values)
attr_multi = spx_models.SphinxMultiField(default=[])
attr_multi_64 = spx_models.SphinxMulti64Field(default=[])
class TestModel(FieldMixin, spx_models.SphinxModel):
pass
```
5. Query index from your app
```python
# Numeric attributes filtering
TestModel.objects.filter(attr_uint=0, attr_float__gte=10, attr_multi__in=[1, 2])
# For sphinxsearch>=2.2.7, string attr filtering enabled
TestModel.objects.filter(attr_string='some test')
# Use mysql-fulltext-search filtering:
TestModel.objects.filter(sphinx_field__search='find me')
# Run match queries
TestModel.objects.match(
'find in all fields',
sphinx_field='only in this field')
# Insert and update documents to index
obj = TestModel.objects.create(**values)
obj.attr_uint = 1
obj.save()
TestModel.objects.filter(attr_bool=True).update(attr_uint=2)
```
## Run tests
```shell
docker-compose up django
```
## Notes for production usage
* Sphinxsearch engine has some issues with SQL-syntax support, and they vary
from one version to another. I.e. float attributes are not comparable,
string attributes were not comparable till v2.2.7.
* Without limits sphinxsearch returns only 20 matched documents.
* uint attributes accept -1 but return it as unsigned 32bit integer.
* bigint accept 2**63 + 1 but return it as signed 64bit integer.
* Use SphinxIntegerField and SphinxBigIntegerField instead of IntegerField and
BigIntegerField from django.db.models, because IN is an expression in
SQL (`value IN column`), but a function (`IN(value, column)`) in sphinxsearch.
* Since 3.0.1 multi64 field incorrectly parses values greater than 2**31 and is
completely unusable for bigint values.
* In 3.1.1 you can create rt index with same string field and attr from config
but you cant clone this index, so you attr-based filtering does not work.
%prep
%autosetup -n django_sphinxsearch-4.2.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-django-sphinxsearch -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 4.2.0-1
- Package Spec generated
|
