Метод like класса ColumnElement

Метод like класса ColumnElement создает условие SQL LIKE для поиска строк, совпадающих с заданным шаблоном. Первым параметром метод принимает строку шаблона, в которой символ % соответствует любой последовательности символов, а _ - ровно одному символу. Метод возвращает объект BinaryExpression, который можно использовать в условиях where, filter и других конструкциях запросов.

Синтаксис

ColumnElement.like(other, [escape])

Пример

Давайте найдем статьи, название которых начинается со слова article:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article one', text='text 1', status='new', num=1),
		Article(title='article two', text='text 2', status='new', num=2),
		Article(title='user note', text='text 3', status='old', num=3),
	])
	session.commit()
	
	stmt = select(Article.title).where(Article.title.like('article%'))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article one', 'article two']

Пример

Давайте используем символ _ для поиска строк, где слово article стоит первым, а после него идет ровно четыре символа:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article one', text='text 1', status='new', num=1),
		Article(title='article two', text='text 2', status='new', num=2),
		Article(title='article', text='text 3', status='old', num=3),
	])
	session.commit()
	
	stmt = select(Article.title).where(Article.title.like('article____'))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article one', 'article two']

Пример

Давайте передадим параметр escape, чтобы экранировать символ % внутри шаблона:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article 100%', text='text 1', status='new', num=1),
		Article(title='article 200', text='text 2', status='new', num=2),
	])
	session.commit()
	
	stmt = select(Article.title).where(Article.title.like('article 100\\%', escape='\\'))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article 100%']

Пример

Давайте посмотрим, какой SQL-запрос генерирует метод like:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

stmt = select(Article.title).where(Article.title.like('article%'))
print(stmt)

Итоговый SQL запрос:

SELECT articles.title
FROM articles
WHERE articles.title LIKE :title_1

Смотрите также

класс ColumnElement,
который представляет элемент столбца
метод ilike,
который выполняет регистронезависимый поиск по шаблону
метод notlike,
который создает условие NOT LIKE
метод startswith,
который ищет строки, начинающиеся с подстроки