diff options
Diffstat (limited to 'python-django-sphinxsearch.spec')
| -rw-r--r-- | python-django-sphinxsearch.spec | 540 |
1 files changed, 540 insertions, 0 deletions
diff --git a/python-django-sphinxsearch.spec b/python-django-sphinxsearch.spec new file mode 100644 index 0000000..3f2f9fb --- /dev/null +++ b/python-django-sphinxsearch.spec @@ -0,0 +1,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 |