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

Метод collate класса ColumnElement применяет к строковому столбцу или выражению правило сортировки (collation). Первым параметром метод принимает строку с названием правила, например 'NOCASE' или 'utf8_bin'. Правило сортировки определяет, как база данных сравнивает и упорядочивает строки: с учетом регистра, с учетом диакритики или без них.

Синтаксис

column.collate(collation)

Пример

Давайте создадим правило сортировки без учета регистра для столбца title и выведем полученный SQL-запрос:

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]

stmt = select(Article.title.collate('NOCASE'))
print(stmt)

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

SELECT articles.title COLLATE "NOCASE" AS title_1 
FROM articles

Пример

Давайте применим правило сортировки 'NOCASE' в условии where и выполним запрос к базе данных:

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]

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

with Session(engine) as session:
	session.add_all([
		Article(title='article 1'),
		Article(title='ARTICLE 2'),
		Article(title='Article 3')
	])
	session.commit()
	
	stmt = select(Article.title).where(
		Article.title.collate('NOCASE') == 'article 2'
	)
	res = session.execute(stmt).scalars().all()
	print(res)

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

['ARTICLE 2']

Пример

Давайте зададим правило сортировки непосредственно при определении столбца модели через параметр collation:

from sqlalchemy import String
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] = mapped_column(String(255, collation='NOCASE'))

Теперь при сортировке по столбцу title база данных будет игнорировать регистр символов.

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

класс ColumnElement,
который представляет базовый элемент столбца
метод label,
который задает псевдоним для выражения
метод asc,
который сортирует результат по возрастанию
метод desc,
который сортирует результат по убыванию