Query operators

The following types of comparisons are supported by peewee:

Because I ran out of operators to override, there are some additional query operations available as methods:

To combine clauses using logical operators, use:

Here is how you might use some of these query operators:

# Find the user whose username is "charlie".

User.select().where(User.username == 'charlie')

# Find the users whose username is in [charlie, huey, mickey]

User.select().where(User.username << ['charlie', 'huey', 'mickey'])

Employee.select().where(Employee.salary.between(50000, 60000))

Employee.select().where(Employee.name.startswith('C'))

Blog.select().where(Blog.title.contains(search_string))

Here is how you might combine expressions. Comparisons can be arbitrarily complex.

Note

Note that the actual comparisons are wrapped in parentheses. Python’s operator precedence necessitates that comparisons be wrapped in parentheses.

# Find any users who are active administrations.

User.select().where(

  (User.is_admin == True) &

  (User.is_active == True))

# Find any users who are either administrators or super-users.

User.select().where(

  (User.is_admin == True) |

  (User.is_superuser == True))

# Find any Tweets by users who are not admins (NOT IN).

admins = User.select().where(User.is_admin == True)

non_admin_tweets = Tweet.select().where(

  ~(Tweet.user << admins))

# Find any users who are not my friends (strangers).

friends = User.select().where(

  User.username << ['charlie', 'huey', 'mickey'])

strangers = User.select().where(~(User.id << friends))

Warning

Although you may be tempted to use python’s in, and, or and not operators in your query expressions, these will not work. The return value of an in expression is always coerced to a boolean value. Similarly, and, or and not all treat their arguments as boolean values and cannot be overloaded.

So just remember:

• Use << instead of in
• Use & instead of and
• Use | instead of or
• Use ~ instead of not
• Don’t forget to wrap your comparisons in parentheses when using logical operators.

For more examples, see the Expressions section.

Note

LIKE and ILIKE with SQLite

Because SQLite’s LIKE operation is case-insensitive by default, peewee will use the SQLite GLOB operation for case-sensitive searches. The glob operation uses asterisks for wildcards as opposed to the usual percent-sign. If you are using SQLite and want case-sensitive partial string matching, remember to use asterisks for the wildcard.