tortoise/tortoise-orm

Feature request: filter like and ilike

Open

#421 opened on May 29, 2020

View on GitHub
 (9 comments) (0 reactions) (1 assignee)Python (3,863 stars) (333 forks)batch import
enhancementgood first issue

Description

Example of usage:

users = await User.filter(first_name__ilike="c%r")

I know this can be done with startswith and endswith, but there are cases where using the LIKE operator is better:

users = await User.filter(first_name__ilike="j_r%")

This would be used to match Jeremy, Jorge, Jordan...

Contributor guide

Tech stack
pythonsql
Domain
backenddatabase
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingSQL LIKE operatorFamiliarity with Tortoise ORM's query API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the current filter methods (e.g., startswith, endswith) in the query module (likely in tortoise/queryset.py or similar). Understand how they generate SQL WHERE clauses. Then implement support for `like` and `ilike` by adding corresponding filter operators, ensuring proper escaping and database compatibility. Check existing tests to see pattern for adding new filters.