Ticket #2559: django-search_fields-operators-docs_pre_magic_removal.diff

docs/model-api.txt

@@ -1386 +1386 @@
     WHERE (first_name ILIKE '%john%' OR last_name ILIKE '%john%')
     AND (first_name ILIKE '%lennon%' OR last_name ILIKE '%lennon%')
 
+For faster and/or more restrictive searches, prefix the field name
+with an operator:
+
+`^`
+    Matches the beginning of the field. For example, if
+    ``search_fields`` is set to ``['^first_name', '^last_name']`` and
+    a user searches for ``john lennon``, Django will do the equivalent
+    of this SQL ``WHERE`` clause::
+
+        WHERE (first_name ILIKE 'john%' OR last_name ILIKE 'john%')
+        AND (first_name ILIKE 'lennon%' OR last_name ILIKE 'lennon%')
+
+`=`
+    Matches exactly, case-insensitive. For example, if
+    ``search_fields`` is set to ``['=first_name', '=last_name']`` and
+    a user searches for ``john lennon``, Django will do the equivalent
+    of this SQL ``WHERE`` clause::
+
+        WHERE (first_name ILIKE 'john' OR last_name ILIKE 'john')
+        AND (first_name ILIKE 'lennon' OR last_name ILIKE 'lennon')
+
+`@`
+    Performs a full-text match. This is like the default search but
+    uses an index. Currently this is only available for MySQL.
+
 Managers
 ========