1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

Fixed #26285 -- Deprecated the MySQL-specific __search lookup.

This commit is contained in:
Marc Tamlyn 2015-06-05 12:31:44 +01:00 committed by Tim Graham
parent 04240b2365
commit 8ddc79a799
9 changed files with 46 additions and 10 deletions

View File

@ -191,6 +191,7 @@ class BaseDatabaseOperations(object):
search of the given field_name. Note that the resulting string should search of the given field_name. Note that the resulting string should
contain a '%s' placeholder for the value being searched against. contain a '%s' placeholder for the value being searched against.
""" """
# RemovedInDjango20Warning
raise NotImplementedError('Full-text search is not implemented for this database backend') raise NotImplementedError('Full-text search is not implemented for this database backend')
def last_executed_query(self, cursor, sql, params): def last_executed_query(self, cursor, sql, params):

View File

@ -91,6 +91,7 @@ class DatabaseOperations(BaseDatabaseOperations):
return [(None, ("NULL", [], False))] return [(None, ("NULL", [], False))]
def fulltext_search_sql(self, field_name): def fulltext_search_sql(self, field_name):
# RemovedInDjango20Warning
return 'MATCH (%s) AGAINST (%%s IN BOOLEAN MODE)' % field_name return 'MATCH (%s) AGAINST (%%s IN BOOLEAN MODE)' % field_name
def last_executed_query(self, cursor, sql, params): def last_executed_query(self, cursor, sql, params):

View File

@ -1,3 +1,4 @@
import warnings
from copy import copy from copy import copy
from django.conf import settings from django.conf import settings
@ -7,6 +8,7 @@ from django.db.models.fields import (
) )
from django.db.models.query_utils import RegisterLookupMixin from django.db.models.query_utils import RegisterLookupMixin
from django.utils import timezone from django.utils import timezone
from django.utils.deprecation import RemovedInDjango20Warning
from django.utils.functional import cached_property from django.utils.functional import cached_property
from django.utils.six.moves import range from django.utils.six.moves import range
@ -373,6 +375,10 @@ class Search(BuiltinLookup):
lookup_name = 'search' lookup_name = 'search'
def as_sql(self, compiler, connection): def as_sql(self, compiler, connection):
warnings.warn(
'The `__search` lookup is deprecated. See the 1.10 release notes '
'for how to replace it.', RemovedInDjango20Warning, stacklevel=2
)
lhs, lhs_params = self.process_lhs(compiler, connection) lhs, lhs_params = self.process_lhs(compiler, connection)
rhs, rhs_params = self.process_rhs(compiler, connection) rhs, rhs_params = self.process_rhs(compiler, connection)
sql_template = connection.ops.fulltext_search_sql(field_name=lhs) sql_template = connection.ops.fulltext_search_sql(field_name=lhs)

View File

@ -141,6 +141,9 @@ details on these changes.
* Support for query lookups using the model name when * Support for query lookups using the model name when
``Meta.default_related_name`` is set will be removed. ``Meta.default_related_name`` is set will be removed.
* The ``__search`` query lookup and the
``DatabaseOperations.fulltext_search_sql()`` method will be removed.
.. _deprecation-removed-in-1.10: .. _deprecation-removed-in-1.10:
1.10 1.10

View File

@ -1847,15 +1847,8 @@ Field API reference
.. method:: get_prep_lookup(lookup_type, value) .. method:: get_prep_lookup(lookup_type, value)
Prepares ``value`` to the database prior to be used in a lookup. Prepares ``value`` to the database prior to be used in a lookup.
The ``lookup_type`` will be one of the valid Django filter lookups: The ``lookup_type`` will be the registered name of the lookup. For
``"exact"``, ``"iexact"``, ``"contains"``, ``"icontains"``, example: ``"exact"``, ``"iexact"``, or ``"contains"``.
``"gt"``, ``"gte"``, ``"lt"``, ``"lte"``, ``"in"``, ``"startswith"``,
``"istartswith"``, ``"endswith"``, ``"iendswith"``, ``"range"``,
``"year"``, ``"month"``, ``"day"``, ``"isnull"``, ``"search"``,
``"regex"``, and ``"iregex"``.
If you are using :doc:`Custom lookups </ref/models/lookups>` the
``lookup_type`` can be any ``lookup_name`` registered in the field.
See :ref:`preparing-values-for-use-in-database-lookups` for usage. See :ref:`preparing-values-for-use-in-database-lookups` for usage.

View File

@ -2771,6 +2771,11 @@ SQL equivalent::
``search`` ``search``
~~~~~~~~~~ ~~~~~~~~~~
.. deprecated:: 1.10
See :ref:`the 1.10 release notes <search-lookup-replacement>` for how to
replace it.
A boolean full-text search, taking advantage of full-text indexing. This is A boolean full-text search, taking advantage of full-text indexing. This is
like :lookup:`contains` but is significantly faster due to full-text indexing. like :lookup:`contains` but is significantly faster due to full-text indexing.

View File

@ -740,6 +740,28 @@ use the default_related_name ``bars``::
>>> Foo.object.get(bars=bar) >>> Foo.object.get(bars=bar)
.. _search-lookup-replacement:
``__search`` query lookup
-------------------------
The ``search`` lookup, which supports MySQL only and is extremely limited in
features, is deprecated. Replace it with a custom lookup::
from django.db import models
class Search(models.Lookup):
lookup_name = 'search'
def as_mysql(self, compiler, connection):
lhs, lhs_params = self.process_lhs(compiler, connection)
rhs, rhs_params = self.process_rhs(compiler, connection)
params = lhs_params + rhs_params
return 'MATCH (%s) AGAINST (%s IN BOOLEAN MODE)' % (lhs, rhs), params
models.CharField.register_lookup(Search)
models.TextField.register_lookup(Search)
Miscellaneous Miscellaneous
------------- -------------

View File

@ -79,6 +79,7 @@ class Player(models.Model):
# is only available when using MySQL 5.6, or when using MyISAM # is only available when using MySQL 5.6, or when using MyISAM
# tables. As 5.6 isn't common yet, lets use MyISAM table for # tables. As 5.6 isn't common yet, lets use MyISAM table for
# testing. The table is manually created by the test method. # testing. The table is manually created by the test method.
# RemovedInDjango20Warning
class MyISAMArticle(models.Model): class MyISAMArticle(models.Model):
headline = models.CharField(max_length=100) headline = models.CharField(max_length=100)

View File

@ -7,7 +7,10 @@ from unittest import skipUnless
from django.core.exceptions import FieldError from django.core.exceptions import FieldError
from django.db import connection from django.db import connection
from django.test import TestCase, TransactionTestCase, skipUnlessDBFeature from django.test import (
TestCase, TransactionTestCase, ignore_warnings, skipUnlessDBFeature,
)
from django.utils.deprecation import RemovedInDjango20Warning
from .models import Article, Author, Game, MyISAMArticle, Player, Season, Tag from .models import Article, Author, Game, MyISAMArticle, Player, Season, Tag
@ -792,6 +795,7 @@ class LookupTests(TestCase):
class LookupTransactionTests(TransactionTestCase): class LookupTransactionTests(TransactionTestCase):
available_apps = ['lookup'] available_apps = ['lookup']
@ignore_warnings(category=RemovedInDjango20Warning)
@skipUnless(connection.vendor == 'mysql', 'requires MySQL') @skipUnless(connection.vendor == 'mysql', 'requires MySQL')
def test_mysql_lookup_search(self): def test_mysql_lookup_search(self):
# To use fulltext indexes on MySQL either version 5.6 is needed, or one must use # To use fulltext indexes on MySQL either version 5.6 is needed, or one must use