{"id":6378,"date":"2023-01-12T02:40:29","date_gmt":"2023-01-12T02:40:29","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=6378"},"modified":"2023-01-12T04:22:03","modified_gmt":"2023-01-12T04:22:03","slug":"django-orm-like","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/django-tutorial\/django-orm-like\/","title":{"rendered":"Django LIKE"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to query data using based on pattern matching in Django which is equivalent to the LIKE<\/code> operator.<\/p>\n\n\n\n

We’ll use the Employee<\/code> models from the HR application for the demonstration. The Employee<\/code> model maps to the hr_employee<\/code> table in the database:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

startswith and istartswith #<\/a><\/h2>\n\n\n\n

Sometimes, you want to check if a string starts with a substring. For example, you may want to find employees whose first name starts with Je. <\/p>\n\n\n\n

To do that in SQL, you use the LIKE<\/code> operator like this:<\/p>\n\n\n

SELECT * \nFROM hr_employee\nWHERE first_name LIKE 'Je%'<\/span>;<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The %<\/code> is a wildcard that matches any number of characters. And the 'Je%'<\/code> matches the strings that start with Je<\/code> and are followed by zero or more characters.<\/p>\n\n\n\n
To query data from Django using the LIKE<\/code> operator, you use the startswith<\/code> by appending it to a field name:<\/p>\n\n\n
field_name__startswith<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
For example, the following uses the filter()<\/code> method to find employees whose first names start with Je<\/code>:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__startswith='Je'<\/span>) \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,        \n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>, \n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE \"hr_employee\"<\/span>.\"first_name\"<\/span>::text LIKE 'Je%'<\/span>\n LIMIT 21<\/span>\nExecution time: 0.000998<\/span>s [Database: default]\n<QuerySet [<Employee: Jennifer Thompson>, <Employee: Jerry Cunningham>, <Employee: Jesus Reilly>, <Employee: Jessica Lewis>, <Employee: Jeanette Hendrix>, <Employee: Jeffrey Castro>, <Employee: Jessica Jackson>, <Employee: Jennifer Bender>, <Employee: Jennifer Moyer>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
If you want to find employees whose first names start with Je<\/code> case-insensitively, you can use the istartswith<\/code>:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__istartswith='je'<\/span>) \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,\n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE UPPER(\"hr_employee\"<\/span>.\"first_name\"<\/span>::text) LIKE UPPER('je%'<\/span>)\n LIMIT 21<\/span>\nExecution time: 0.001398<\/span>s [Database: default]\n<QuerySet [<Employee: Jennifer Thompson>, <Employee: Jerry Cunningham>, <Employee: Jesus Reilly>, <Employee: Jessica Lewis>, <Employee: Jeanette Hendrix>, <Employee: Jeffrey Castro>, <Employee: Jessica Jackson>, <Employee: Jennifer Bender>, <Employee: Jennifer Moyer>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
In this case,  the __istartswith<\/code> uses the uppercase version of the value for matching.<\/p>\n\n\n\n
endswith and iendswith #<\/a><\/h2>\n\n\n\n
The endswith<\/code> and iendswith<\/code> return True if a value ends with a substring. The endswith<\/code> is equivalent to the following LIKE<\/code> operator:<\/p>\n\n\n
LIKE '%substring'<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
For example, the following uses the endswith<\/code> to find employees whose first names end with er<\/code>:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__endswith='er'<\/span>)           \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,\n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE \"hr_employee\"<\/span>.\"first_name\"<\/span>::text LIKE '%er'<\/span>\n LIMIT 21<\/span>\nExecution time: 0.000999<\/span>s [Database: default]\n<QuerySet [<Employee: Jennifer Thompson>, <Employee: Tyler Briggs>, <Employee: Spencer Riggs>, <Employee: Roger Robinson>, <Employee: Hunter Boyd>, <Employee: Amber Brown>, <Employee: Tyler Coleman>, <Employee: Jennifer Bender>, <Employee: Jennifer Moyer>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
It returns the employees with the first names Jennifer<\/code>, Tyler<\/code>, Spencer<\/code>, Roger<\/code>, etc.<\/p>\n\n\n\n
The iendswith<\/code> is the case-insensitive version of the endswith<\/code>. For example:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__iendswith='ER'<\/span>) \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,\n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE UPPER(\"hr_employee\"<\/span>.\"first_name\"<\/span>::text) LIKE UPPER('%ER'<\/span>)\n LIMIT 21<\/span>\nExecution time: 0.000999<\/span>s [Database: default]\n<QuerySet [<Employee: Jennifer Thompson>, <Employee: Tyler Briggs>, <Employee: Spencer Riggs>, <Employee: Roger Robinson>, <Employee: Hunter Boyd>, <Employee: Amber Brown>, <Employee: Tyler Coleman>, <Employee: Jennifer Bender>, <Employee: Jennifer Moyer>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
contains and icontains #<\/a><\/h2>\n\n\n\n
The contains<\/code> allows you to check if a string contains a substring. It is equivalent to the following LIKE<\/code> operator:<\/p>\n\n\n
LIKE '%substring%'<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
For example, the following finds the employees whose first name contains the substring ff<\/code>:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__contains='ff'<\/span>)  \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,\n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE \"hr_employee\"<\/span>.\"first_name\"<\/span>::text LIKE '%ff%'<\/span>\n LIMIT 21<\/span>\nExecution time: 0.001293<\/span>s [Database: default]\n<QuerySet [<Employee: Tiffany Jackson>, <Employee: Tiffany Holt>, <Employee: Jeffrey Castro>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The query returns the employees with the first names Tiffany and Jeffrey.<\/p>\n\n\n\n
The icontains<\/code> is the case-insensitive version of the contains<\/code>. So you can use the icontains<\/code> to check if a string contains a substring case-insensitively:<\/p>\n\n\n
>>> <\/span>Employee.objects.filter(first_name__icontains='ff'<\/span>) \nSELECT \"hr_employee\"<\/span>.\"id\"<\/span>,\n       \"hr_employee\"<\/span>.\"first_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"last_name\"<\/span>,\n       \"hr_employee\"<\/span>.\"contact_id\"<\/span>,\n       \"hr_employee\"<\/span>.\"department_id\"<\/span>\n  FROM \"hr_employee\"<\/span>\n WHERE UPPER(\"hr_employee\"<\/span>.\"first_name\"<\/span>::text) LIKE UPPER('%ff%'<\/span>)\n LIMIT 21<\/span>\nExecution time: 0.002012<\/span>s [Database: default]\n<QuerySet [<Employee: Tiffany Jackson>, <Employee: Tiffany Holt>, <Employee: Jeffrey Castro>]><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Summary #<\/a><\/h2>\n\n\n\n
Django<\/th>SQL LIKE<\/th>Meaning<\/th><\/tr><\/thead>
field_name__startswith='substring'<\/code><\/td>field_name LIKE  '%substring'<\/code><\/td>return True if field_name<\/code> starts with a substring.<\/td><\/tr>
field_name__istartswith='substring'<\/code><\/td>UPPER(field_name) LIKE  UPPER('%substring')<\/code><\/td>return True if field_name<\/code> starts with a substring case-insensitively<\/td><\/tr>
field_name__endswith='substring'<\/code><\/td>field_name LIKE  'substring%'<\/code><\/td>return True if field_name<\/code> ends with a substring.<\/td><\/tr>
field_name__iendswith='substring'<\/code><\/td>UPPER(field_name) LIKE  UPPER('substring%')<\/code><\/td>return True if field_name<\/code> ends with a substring case-insensitively<\/td><\/tr>
field_name__contains='substring'<\/code><\/td>field_name LIKE  '%substring%'<\/code><\/td>return True if field_name<\/code> contains a substring.<\/td><\/tr>
field_name__icontains='substring'<\/code><\/td>UPPER(field_name) LIKE  UPPER('%substring%')<\/code><\/td>return True if field_name<\/code> contains a substring case insensitively.<\/td><\/tr><\/tbody><\/table><\/figure>\n
\n\t
\n\t\t
Was this tutorial helpful ?<\/div>\n\t\t
\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t
\n\t\t
\n\t\t\t
<\/div>\n\t\t\t