Учебник по языку выражений SQL (API 1.x)

Об этом документе

В этом учебнике рассматривается хорошо известный API SQLAlchemy Core, который используется уже много лет. Начиная с версии SQLAlchemy 1.4, существует два различных стиля использования Core, известных как 1.x style и 2.0 style, последний из которых вносит некоторые коррективы, в основном в области управления транзакциями, а также сужает шаблоны выполнения конструкций SQL-операторов.

Планируется, что в SQLAlchemy 2.0 те элементы стиля 1.x, которые используются в Core, будут удалены после фазы обесценивания, которая продолжится в серии 1.4. Для использования в ORM некоторые элементы стиля 1.x по-прежнему будут доступны; полный обзор см. в документе Переход на SQLAlchemy 2.0.

Данное руководство применимо для пользователей, которые хотят узнать, как SQLAlchemy Core использовался в течение многих лет, особенно для тех пользователей, которые работают с существующими приложениями или соответствующими учебными материалами, выполненными в стиле 1.x.

Введение в SQLAlchemy Core с новой точки зрения 1.4/2.0 смотрите в Самоучитель SQLAlchemy 1.4 / 2.0.

Язык выражений SQLAlchemy представляет собой систему представления структур реляционных баз данных и выражений с помощью конструкций Python. Эти конструкции смоделированы таким образом, чтобы как можно ближе походить на конструкции базовой базы данных, обеспечивая при этом некоторую абстракцию от различных различий в реализации между бэкендами баз данных. Хотя эти конструкции пытаются представить эквивалентные понятия между бэкендами с помощью согласованных структур, они не скрывают полезные понятия, которые являются уникальными для определенных подмножеств бэкендов. Таким образом, язык выражений представляет собой метод написания SQL-выражений, нейтральных к бэкендам, но не пытается обеспечить нейтральность выражений к бэкендам.

Язык выражений отличается от объектно-реляционного отобразителя, который является отдельным API, построенным на основе языка выражений. Если ORM, представленный в Объектно-реляционный учебник (API 1.x), представляет собой высокоуровневую и абстрактную модель использования, которая сама является примером прикладного использования языка выражений, то язык выражений представляет собой систему представления примитивных конструкций реляционной базы данных непосредственно без заключения.

Несмотря на то, что модели использования ORM и языка выражений совпадают, сходство более поверхностное, чем может показаться на первый взгляд. Один из них подходит к структуре и содержанию данных с точки зрения пользовательской модели domain model, которая прозрачно сохраняется и обновляется из базовой модели хранения. Другая подходит к этому с точки зрения буквальных представлений схем и выражений SQL, которые явно компонуются в сообщения, потребляемые базой данных по отдельности.

Успешное приложение может быть построено с использованием исключительно языка выражений, хотя приложение должно будет определить свою собственную систему перевода концепций приложения в отдельные сообщения базы данных и из отдельных наборов результатов базы данных. В качестве альтернативы, приложение, построенное с использованием ORM, может, в продвинутых сценариях, использовать язык выражений непосредственно в определенных областях, где требуется специфическое взаимодействие с базой данных.

Следующий учебник представлен в формате doctest, то есть каждая строка >>> представляет собой нечто, что вы можете ввести в командной строке Python, а следующий текст представляет собой ожидаемое возвращаемое значение. Учебник не имеет предварительных условий.

Проверка версии

Быстрая проверка, чтобы убедиться, что мы находимся как минимум на версии 1.4 SQLAlchemy:

>>> import sqlalchemy
>>> sqlalchemy.__version__  
1.4.0

Подключение

В этом учебнике мы будем использовать базу данных SQLite, хранящуюся только в памяти. Это простой способ тестирования без необходимости иметь где-либо определенную базу данных. Для подключения мы используем create_engine():

>>> from sqlalchemy import create_engine
>>> engine = create_engine("sqlite:///:memory:", echo=True)

Флаг echo - это короткий путь к настройке логирования SQLAlchemy, которое осуществляется с помощью стандартного модуля Python logging. Если флаг включен, мы увидим весь сгенерированный SQL. Если вы работаете над этим учебником и хотите получить меньше результатов, установите значение False. В этом учебнике SQL будет отформатирован за всплывающим окном, чтобы он не мешал нам; просто щелкните по ссылкам «SQL», чтобы увидеть, что генерируется.

Возвращаемое значение create_engine() является экземпляром Engine, и он представляет собой основной интерфейс к базе данных, адаптированный через dialect, который обрабатывает детали базы данных и DBAPI в использовании. В данном случае диалект SQLite будет интерпретировать инструкции к встроенному в Python модулю sqlite3.

При первом вызове такого метода, как Engine.execute() или Engine.connect(), Engine устанавливает реальное DBAPI соединение с базой данных, которое затем используется для выдачи SQL.

См.также

URL-адреса баз данных - включает примеры create_engine() подключения к нескольким видам баз данных со ссылками на дополнительную информацию.

Определение и создание таблиц

Язык выражений SQL в большинстве случаев строит свои выражения на основе столбцов таблицы. В SQLAlchemy столбец чаще всего представлен объектом Column, и во всех случаях Column связан с Table. Коллекция объектов Table и связанных с ними дочерних объектов называется метаданными базы данных. В этом учебнике мы явно разложим несколько объектов Table, но обратите внимание, что SA также может «импортировать» целые наборы объектов Table автоматически из существующей базы данных (этот процесс называется отражение таблицы).

Мы определяем наши таблицы в каталоге под названием MetaData, используя конструкцию Table, которая напоминает обычные операторы SQL CREATE TABLE. Мы создадим две таблицы, одна из которых представляет «пользователей» в приложении, а другая - ноль или более «адресов электронной почты» для каждой строки в таблице «пользователи»:

>>> from sqlalchemy import Table, Column, Integer, String, MetaData, ForeignKey
>>> metadata_obj = MetaData()
>>> users = Table(
...     "users",
...     metadata_obj,
...     Column("id", Integer, primary_key=True),
...     Column("name", String),
...     Column("fullname", String),
... )

>>> addresses = Table(
...     "addresses",
...     metadata_obj,
...     Column("id", Integer, primary_key=True),
...     Column("user_id", None, ForeignKey("users.id")),
...     Column("email_address", String, nullable=False),
... )

Все о том, как определять объекты Table, а также как автоматически создавать их из существующей базы данных, описано в Описание баз данных с помощью метаданных.

Далее, чтобы сообщить MetaData, что мы действительно хотим создать наш выбор таблиц в базе данных SQLite, мы используем create_all(), передавая ему экземпляр engine, который указывает на нашу базу данных. Это позволит сначала проверить наличие каждой таблицы перед созданием, поэтому можно вызывать несколько раз:

sql>>> metadata_obj.create_all(engine)

Примечание

Пользователи, знакомые с синтаксисом CREATE TABLE, могут заметить, что столбцы VARCHAR были созданы без длины; в SQLite и PostgreSQL это допустимый тип данных, но в других базах он недопустим. Поэтому, если вы используете этот учебник в одной из этих баз данных и хотите использовать SQLAlchemy для создания CREATE TABLE, можно указать «длину» для типа String, как показано ниже:

Column("name", String(50))

Поле длины в String, а также аналогичные поля точности/масштаба, доступные в Integer, Numeric и т.д., не используются SQLAlchemy иначе, чем при создании таблиц.

Кроме того, Firebird и Oracle требуют последовательности для создания новых идентификаторов первичного ключа, а SQLAlchemy не генерирует и не предполагает их без указания. Для этого используется конструкция Sequence:

from sqlalchemy import Sequence

Column("id", Integer, Sequence("user_id_seq"), primary_key=True)

Таким образом, полный, надежный Table - это:

users = Table(
    "users",
    metadata_obj,
    Column("id", Integer, Sequence("user_id_seq"), primary_key=True),
    Column("name", String(50)),
    Column("fullname", String(50)),
    Column("nickname", String(50)),
)

Мы включили эту более многословную конструкцию Table отдельно, чтобы подчеркнуть разницу между минимальной конструкцией, предназначенной в основном для использования только в Python, и той, которая будет использоваться для создания операторов CREATE TABLE на определенном наборе бэкендов с более строгими требованиями.

Вставить выражения

Первым выражением SQL, которое мы создадим, будет конструкция Insert, которая представляет собой оператор INSERT. Обычно оно создается относительно целевой таблицы:

>>> ins = users.insert()

Чтобы увидеть пример SQL, который получается при использовании этой конструкции, используйте функцию str():

>>> str(ins)
'INSERT INTO users (id, name, fullname) VALUES (:id, :name, :fullname)'

Обратите внимание, что оператор INSERT называет каждый столбец в таблице users. Это можно ограничить, используя метод values(), который устанавливает пункт VALUES оператора INSERT в явном виде:

>>> ins = users.insert().values(name="jack", fullname="Jack Jones")
>>> str(ins)
'INSERT INTO users (name, fullname) VALUES (:name, :fullname)'

Выше, хотя метод values ограничил предложение VALUES только двумя столбцами, фактические данные, которые мы поместили в values, не были выведены в строку; вместо этого мы получили именованные параметры связывания. Как оказалось, наши данные хранятся в нашей конструкции Insert, но обычно они появляются только при выполнении оператора; поскольку данные состоят из буквальных значений, SQLAlchemy автоматически генерирует для них параметры связывания. Пока что мы можем посмотреть на эти данные, взглянув на скомпилированную форму оператора:

>>> ins.compile().params  
{'fullname': 'Jack Jones', 'name': 'jack'}

Выполнение

Интересной частью Insert является его выполнение. Для этого используется соединение с базой данных, которое представлено объектом Connection. Для получения соединения мы будем использовать метод Engine.connect():

>>> conn = engine.connect()
>>> conn
<sqlalchemy.engine.base.Connection object at 0x...>

Объект Connection представляет собой активно проверяемый ресурс соединения DBAPI. Давайте передадим ему наш объект Insert и посмотрим, что произойдет:

>>> result = conn.execute(ins)
INSERT INTO users (name, fullname) VALUES (?, ?) [...] ('jack', 'Jack Jones') COMMIT

Теперь оператор INSERT был передан в базу данных. Хотя на выходе мы получили позиционные параметры привязки «qmark» вместо «именованных» параметров привязки. Как так получилось? Потому что при выполнении Connection использовался диалект SQLite, чтобы помочь сгенерировать оператор; когда мы используем функцию str(), оператор не знает об этом диалекте и возвращается к умолчанию, которое использует именованные параметры. Мы можем просмотреть это вручную следующим образом:

>>> ins.bind = engine
>>> str(ins)
'INSERT INTO users (name, fullname) VALUES (?, ?)'

А как насчет переменной result, которую мы получили при вызове execute()? Поскольку объект SQLAlchemy Connection ссылается на соединение DBAPI, результат, известный как объект CursorResult, является аналогом объекта курсора DBAPI. В случае INSERT мы можем получить из него важную информацию, например, значения первичных ключей, которые были сгенерированы из нашего оператора с помощью CursorResult.inserted_primary_key:

>>> result.inserted_primary_key
(1,)

Значение 1 было автоматически сгенерировано SQLite, но только потому, что мы не указали столбец id в нашем операторе Insert; в противном случае было бы использовано наше явное значение. В любом случае, SQLAlchemy всегда знает, как получить новое значение первичного ключа, даже если метод их генерации различен в разных базах данных; Dialect каждой базы данных знает конкретные шаги, необходимые для определения правильного значения (или значений; обратите внимание, что CursorResult.inserted_primary_key возвращает список, так что он поддерживает составные первичные ключи). Методы здесь варьируются от использования cursor.lastrowid, выбора из функции, специфичной для базы данных, до использования синтаксиса INSERT..RETURNING; все это происходит прозрачно.

Выполнение нескольких утверждений

Наш пример вставки, приведенный выше, был намеренно немного затянут, чтобы показать некоторые различные варианты поведения конструкций языка выражения. В обычном случае оператор Insert обычно компилируется с параметрами, передаваемыми методу execute() на Connection, так что нет необходимости использовать ключевое слово values с Insert. Давайте снова создадим общий оператор Insert и используем его «обычным» способом:

>>> ins = users.insert()
>>> conn.execute(ins, {"id": 2, "name": "wendy", "fullname": "Wendy Williams"})
INSERT INTO users (id, name, fullname) VALUES (?, ?, ?) [...] (2, 'wendy', 'Wendy Williams') COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Выше, поскольку мы указали все три столбца в методе execute(), скомпилированный Insert включает все три столбца. Оператор Insert компилируется во время выполнения на основе параметров, которые мы указали; если бы мы указали меньше параметров, Insert имел бы меньше записей в предложении VALUES.

Чтобы выполнить множество вставок с помощью метода DBAPI executemany(), мы можем послать список словарей, каждый из которых содержит отдельный набор параметров для вставки, как мы делаем здесь, чтобы добавить несколько адресов электронной почты:

>>> conn.execute(
...     addresses.insert(),
...     [
...         {"user_id": 1, "email_address": "jack@yahoo.com"},
...         {"user_id": 1, "email_address": "jack@msn.com"},
...         {"user_id": 2, "email_address": "www@www.org"},
...         {"user_id": 2, "email_address": "wendy@aol.com"},
...     ],
... )
INSERT INTO addresses (user_id, email_address) VALUES (?, ?) [...] ((1, 'jack@yahoo.com'), (1, 'jack@msn.com'), (2, 'www@www.org'), (2, 'wendy@aol.com')) COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Выше мы снова полагались на автоматическую генерацию SQLite идентификаторов первичных ключей для каждой строки addresses.

При выполнении нескольких наборов параметров, каждый словарь должен иметь одинаковый набор ключей; т.е. вы не можете иметь меньше ключей в одних словарях, чем в других. Это происходит потому, что оператор Insert компилируется против первого словаря в списке, и предполагается, что все последующие словари аргументов совместимы с этим оператором.

Стиль вызова «executemany» доступен для каждой из конструкций insert(), update() и delete().

Выбор

Мы начали со вставок, просто чтобы в нашей тестовой базе данных были какие-то данные. Более интересной частью данных является их выборка! Мы рассмотрим операторы UPDATE и DELETE позже. Основной конструкцией, используемой для создания операторов SELECT, является функция select():

>>> from sqlalchemy.sql import select
>>> s = select(users)
>>> result = conn.execute(s)
SELECT users.id, users.name, users.fullname FROM users [...] ()

Выше мы выполнили базовый вызов select(), поместив таблицу users в предложение COLUMNS селекта, а затем выполнив его. SQLAlchemy развернула таблицу users в набор всех ее столбцов, а также сгенерировала для нас предложение FROM.

Изменено в версии 1.4: Конструкция select() теперь принимает аргументы колонок позиционно, как select(*args). Предыдущий стиль select(), принимающий список элементов столбцов, теперь устарел. См. select(), case() now accept positional expressions.

Возвращаемым результатом снова является объект CursorResult, который действует подобно курсору DBAPI, включая такие методы, как fetchone() и fetchall(). Эти методы возвращают объекты строк, которые предоставляются через класс Row. Объект результата можно итерировать напрямую, чтобы получить итератор объектов Row:

>>> for row in result:
...     print(row)
(1, u'jack', u'Jack Jones')
(2, u'wendy', u'Wendy Williams')

Выше мы видим, что печать каждого Row дает простой кортеж. Наиболее канонический способ в Python получить доступ к значениям этих кортежей по мере получения строк - это присвоение кортежей:

sql>>> result = conn.execute(s)
>>> for id, name, fullname in result:
...     print("name:", name, "; fullname: ", fullname)
name: jack ; fullname:  Jack Jones
name: wendy ; fullname:  Wendy Williams

Объект Row фактически ведет себя как именованный кортеж в Python, поэтому мы также можем получить доступ к этим атрибутам из самой строки, используя доступ к атрибутам:

sql>>> result = conn.execute(s)
>>> for row in result:
...     print("name:", row.name, "; fullname: ", row.fullname)
name: jack ; fullname:  Jack Jones
name: wendy ; fullname:  Wendy Williams

Для доступа к столбцам по имени с помощью строк, либо когда имя столбца генерируется программно, либо содержит неасксиальные символы, можно использовать представление Row._mapping, которое обеспечивает доступ, подобный словарю:

sql>>> result = conn.execute(s)
>>> row = result.fetchone()
>>> print("name:", row._mapping["name"], "; fullname:", row._mapping["fullname"])
name: jack ; fullname: Jack Jones

Не рекомендуется, начиная с версии 1.4: В версиях SQLAlchemy до 1.4 вышеуказанный доступ с использованием Row._mapping выполнялся к самому объекту row, то есть:

row = result.fetchone()
name, fullname = row["name"], row["fullname"]

Сейчас этот шаблон устарел и будет удален в SQLAlchemy 2.0, так что объект Row теперь может вести себя полностью как именованный кортеж в Python.

Изменено в версии 1.4: Добавлено Row._mapping, которое обеспечивает доступ к объекту Row, подобный словарю, заменяя использование ключей строк/столбцов непосредственно к объекту Row.

Поскольку Row является кортежем, можно также использовать доступ к последовательности (т.е. целому числу или срезу):

>>> row = result.fetchone()
>>> print("name:", row[1], "; fullname:", row[2])
name: wendy ; fullname: Wendy Williams

Более специализированный метод доступа к столбцам заключается в использовании конструкции SQL, которая непосредственно соответствует определенному столбцу, в качестве ключа сопоставления; в данном примере это означает, что мы будем использовать объекты Column, выбранные в нашем SELECT, непосредственно в качестве ключей в сочетании с коллекцией Row._mapping:

sql>>> for row in conn.execute(s):
...     print(
...         "name:",
...         row._mapping[users.c.name],
...         "; fullname:",
...         row._mapping[users.c.fullname],
...     )
name: jack ; fullname: Jack Jones
name: wendy ; fullname: Wendy Williams

Объект CursorResult имеет функцию «автозакрытия», которая закрывает базовый объект DBAPI cursor, когда все ожидающие строки результата были получены. Если объект CursorResult должен быть отброшен до того, как произойдет такое автозакрытие, его можно явно закрыть с помощью метода CursorResult.close():

>>> result.close()

Выбор конкретных столбцов

Если мы хотим более тщательно контролировать столбцы, которые помещаются в предложение COLUMNS в select, мы ссылаемся на отдельные объекты Column из нашего Table. Они доступны в виде именованных атрибутов атрибута c объекта Table:

>>> s = select(users.c.name, users.c.fullname)
sql>>> result = conn.execute(s)
>>> for row in result:
...     print(row)
(u'jack', u'Jack Jones')
(u'wendy', u'Wendy Williams')

Заметим кое-что интересное в предложении FROM. В то время как сгенерированный оператор содержит два отдельных раздела, часть «SELECT columns» и часть «FROM table», наша конструкция select() имеет только список, содержащий столбцы. Как это работает? Давайте попробуем поместить две таблицы в наш оператор select():

sql>>> for row in conn.execute(select(users, addresses)):
...     print(row)
(1, u'jack', u'Jack Jones', 1, 1, u'jack@yahoo.com')
(1, u'jack', u'Jack Jones', 2, 1, u'jack@msn.com')
(1, u'jack', u'Jack Jones', 3, 2, u'www@www.org')
(1, u'jack', u'Jack Jones', 4, 2, u'wendy@aol.com')
(2, u'wendy', u'Wendy Williams', 1, 1, u'jack@yahoo.com')
(2, u'wendy', u'Wendy Williams', 2, 1, u'jack@msn.com')
(2, u'wendy', u'Wendy Williams', 3, 2, u'www@www.org')
(2, u'wendy', u'Wendy Williams', 4, 2, u'wendy@aol.com')

Он поместил обе таблицы в предложение FROM. Но при этом получился настоящий беспорядок. Те, кто знаком с SQL-соединениями, знают, что это картезианское произведение; каждая строка из таблицы users производится против каждой строки из таблицы addresses. Поэтому, чтобы придать этому утверждению некоторую вменяемость, нам нужно предложение WHERE. Мы сделаем это с помощью Select.where():

>>> s = select(users, addresses).where(users.c.id == addresses.c.user_id)
sql>>> for row in conn.execute(s):
...     print(row)
(1, u'jack', u'Jack Jones', 1, 1, u'jack@yahoo.com')
(1, u'jack', u'Jack Jones', 2, 1, u'jack@msn.com')
(2, u'wendy', u'Wendy Williams', 3, 2, u'www@www.org')
(2, u'wendy', u'Wendy Williams', 4, 2, u'wendy@aol.com')

Так это выглядит намного лучше, мы добавили выражение к нашему select(), которое имело эффект добавления WHERE users.id = addresses.user_id к нашему утверждению, и наши результаты управляются вниз так, что соединение строк users и addresses имеет смысл. Но давайте посмотрим на это выражение? В нем используется просто оператор равенства Python между двумя различными объектами Column. Должно быть ясно, что что-то не так. Выражение 1 == 1 дает True, а 1 == 2 дает False, а не предложение WHERE. Итак, давайте посмотрим, что именно делает это выражение:

>>> users.c.id == addresses.c.user_id
<sqlalchemy.sql.elements.BinaryExpression object at 0x...>

Ух ты, сюрприз! Это не True и не False. Что же это такое?

>>> str(users.c.id == addresses.c.user_id)
'users.id = addresses.user_id'

Как видите, оператор == производит объект, который очень похож на объекты Insert и select(), которые мы создали до сих пор, благодаря встроенной программе Python __eq__(); вы вызываете str() на нем, и он производит SQL. К настоящему моменту можно видеть, что все, с чем мы работаем, в конечном итоге является объектом одного типа. SQLAlchemy называет базовый класс всех этих выражений ColumnElement.

Операторы

Раз уж мы наткнулись на операторную парадигму SQLAlchemy, давайте рассмотрим некоторые ее возможности. Мы видели, как приравнять два столбца друг к другу:

>>> print(users.c.id == addresses.c.user_id)
users.id = addresses.user_id

Если мы используем буквальное значение (буквальное значение, а не объект клаузулы SQLAlchemy), мы получим параметр связывания:

>>> print(users.c.id == 7)
users.id = :id_1

Литерал 7 вложен в результирующий ColumnElement; чтобы увидеть его, мы можем использовать тот же трюк, что и с объектом Insert:

>>> (users.c.id == 7).compile().params
{u'id_1': 7}

Большинство операторов Python, как выяснилось, производят здесь SQL-выражение, например, equals, not equals и т.д.:

>>> print(users.c.id != 7)
users.id != :id_1

>>> # None converts to IS NULL
>>> print(users.c.name == None)
users.name IS NULL

>>> # reverse works too
>>> print("fred" > users.c.name)
users.name < :name_1

Если мы сложим вместе два целочисленных столбца, то получим выражение сложения:

>>> print(users.c.id + addresses.c.id)
users.id + addresses.id

Интересно, что тип Column важен! Если мы используем + с двумя колонками на основе строк (вспомните, что в начале мы поместили типы Integer и String на наши объекты Column), мы получим нечто иное:

>>> print(users.c.name + users.c.fullname)
users.name || users.fullname

Где || - оператор конкатенации строк, используемый в большинстве баз данных. Но не во всех. Пользователи MySQL, не бойтесь:

>>> print(
...     (users.c.name + users.c.fullname).compile(bind=create_engine("mysql://"))
... )  
concat(users.name, users.fullname)

Выше показан SQL, который генерируется для Engine, подключенного к базе данных MySQL; оператор || теперь компилируется как функция MySQL concat().

Если вы столкнулись с оператором, который действительно недоступен, вы всегда можете использовать метод Operators.op(); он генерирует любой оператор, который вам нужен:

>>> print(users.c.name.op("tiddlywinks")("foo"))
users.name tiddlywinks :name_1

Эта функция также может быть использована для того, чтобы сделать побитовые операторы явными. Например:

somecolumn.op("&")(0xFF)

является побитовым И из значения в somecolumn.

При использовании Operators.op() может быть важен возвращаемый тип выражения, особенно если оператор используется в выражении, которое будет отправлено в колонку результатов. В этом случае обязательно явно укажите тип, если он не тот, который обычно ожидается, используя type_coerce():

from sqlalchemy import type_coerce

expr = type_coerce(somecolumn.op("-%>")("foo"), MySpecialType())
stmt = select(expr)

Для булевых операторов используйте метод Operators.bool_op(), который гарантирует, что возвращаемый тип выражения будет обработан как boolean:

somecolumn.bool_op("-->")("some value")

Часто используемые операторы

Вот сводка некоторых наиболее распространенных операторов, используемых как в языке выражений Core, так и в ORM. Здесь представлены выражения, которые чаще всего встречаются при использовании метода Select.where(), но могут быть использованы и в других сценариях.

Список всех операций на уровне столбцов, общих для всех объектов типа столбцов, находится по адресу ColumnOperators.

  • ColumnOperators.__eq__():

    statement.where(users.c.name == "ed")
  • ColumnOperators.__ne__():

    statement.where(users.c.name != "ed")
  • ColumnOperators.like():

    statement.where(users.c.name.like('%ed%'))

Примечание

ColumnOperators.like() отображает оператор LIKE, который нечувствителен к регистру на некоторых бэкендах и чувствителен к регистру на других. Для гарантированного сравнения без учета регистра используйте ColumnOperators.ilike().

  • ColumnOperators.ilike() (регистронезависимый LIKE):

    statement.where(users.c.name.ilike('%ed%'))

Примечание

Большинство бэкендов не поддерживают ILIKE напрямую. Для них оператор ColumnOperators.ilike() выводит выражение, сочетающее LIKE с SQL-функцией LOWER, применяемой к каждому операнду.

  • ColumnOperators.in_():

    statement.where(users.c.name.in_(["ed", "wendy", "jack"]))
    
    # works with Select objects too:
    statement.where.filter(
        users.c.name.in_(select(users.c.name).where(users.c.name.like("%ed%")))
    )
    
    # use tuple_() for composite (multi-column) queries
    from sqlalchemy import tuple_
    
    statement.where(
        tuple_(users.c.name, users.c.nickname).in_(
            [("ed", "edsnickname"), ("wendy", "windy")]
        )
    )
  • ColumnOperators.not_in():

    statement.where(~users.c.name.in_(["ed", "wendy", "jack"]))
  • ColumnOperators.is_():

    statement.where(users.c.name == None)
    
    # alternatively, if pep8/linters are a concern
    statement.where(users.c.name.is_(None))
  • ColumnOperators.is_not():

    statement.where(users.c.name != None)
    
    # alternatively, if pep8/linters are a concern
    statement.where(users.c.name.is_not(None))
  • AND:

    # use and_()
    from sqlalchemy import and_
    statement.where(and_(users.c.name == 'ed', users.c.fullname == 'Ed Jones'))
    
    # or send multiple expressions to .where()
    statement.where(users.c.name == 'ed', users.c.fullname == 'Ed Jones')
    
    # or chain multiple where() calls
    statement.where(users.c.name == 'ed').where(users.c.fullname == 'Ed Jones')

Примечание

Убедитесь, что вы используете and_(), а не оператор Python and!

  • OR:

    from sqlalchemy import or_
    statement.where(or_(users.c.name == 'ed', users.c.name == 'wendy'))

Примечание

Убедитесь, что вы используете or_(), а не оператор Python or!

  • ColumnOperators.match():

    statement.where(users.c.name.match('wendy'))

Примечание

ColumnOperators.match() использует специфическую для базы данных функцию MATCH или CONTAINS; ее поведение зависит от бэкенда и недоступно для некоторых бэкендов, таких как SQLite.

Настройка оператора

Хотя Operators.op() удобно использовать, чтобы быстро получить пользовательский оператор, Core поддерживает фундаментальную настройку и расширение системы операторов на уровне типов. Поведение существующих операторов может быть изменено на основе каждого типа, а также могут быть определены новые операции, которые становятся доступными для всех выражений столбцов, являющихся частью данного конкретного типа. Описание см. в разделе Переопределение и создание новых операторов.

Союзы

Мы хотели бы продемонстрировать некоторые из наших операторов внутри конструкций select(). Но нам нужно еще немного объединить их вместе, поэтому давайте сначала введем конъюнкцию. Конъюнкция - это такие маленькие слова, как AND и OR, которые соединяют все вместе. Мы также рассмотрим НЕ. and_(), or_() и not_() могут работать с соответствующими функциями, которые предоставляет SQLAlchemy (обратите внимание, что мы также добавили ColumnOperators.like()):

>>> from sqlalchemy.sql import and_, or_, not_
>>> print(
...     and_(
...         users.c.name.like("j%"),
...         users.c.id == addresses.c.user_id,
...         or_(
...             addresses.c.email_address == "wendy@aol.com",
...             addresses.c.email_address == "jack@yahoo.com",
...         ),
...         not_(users.c.id > 5),
...     )
... )
users.name LIKE :name_1 AND users.id = addresses.user_id AND
(addresses.email_address = :email_address_1
   OR addresses.email_address = :email_address_2)
AND users.id <= :id_1

Вы также можете использовать побитовые операторы AND, OR и NOT, хотя из-за старшинства операторов в Python вам придется следить за скобками:

>>> print(
...     users.c.name.like("j%")
...     & (users.c.id == addresses.c.user_id)
...     & (
...         (addresses.c.email_address == "wendy@aol.com")
...         | (addresses.c.email_address == "jack@yahoo.com")
...     )
...     & ~(users.c.id > 5)
... )
users.name LIKE :name_1 AND users.id = addresses.user_id AND
(addresses.email_address = :email_address_1
    OR addresses.email_address = :email_address_2)
AND users.id <= :id_1

Итак, используя весь этот словарный запас, давайте выберем всех пользователей, имеющих адрес электронной почты в AOL или MSN, чье имя начинается с буквы от «m» до «z», а также создадим столбец, содержащий их полное имя в сочетании с адресом электронной почты. Мы добавим к этому утверждению две новые конструкции, ColumnOperators.between() и ColumnElement.label(). ColumnOperators.between() создает предложение BETWEEN, а ColumnElement.label() используется в выражении столбца для создания меток с помощью ключевого слова AS; это рекомендуется при выборе из выражений, которые иначе не имели бы имени:

>>> s = select((users.c.fullname + ", " + addresses.c.email_address).label("title")).where(
...     and_(
...         users.c.id == addresses.c.user_id,
...         users.c.name.between("m", "z"),
...         or_(
...             addresses.c.email_address.like("%@aol.com"),
...             addresses.c.email_address.like("%@msn.com"),
...         ),
...     )
... )
>>> conn.execute(s).fetchall()
SELECT users.fullname || ? || addresses.email_address AS title FROM users, addresses WHERE users.id = addresses.user_id AND users.name BETWEEN ? AND ? AND (addresses.email_address LIKE ? OR addresses.email_address LIKE ?) [...] (', ', 'm', 'z', '%@aol.com', '%@msn.com')
[(u'Wendy Williams, wendy@aol.com',)]

И снова SQLAlchemy определила предложение FROM для нашего оператора. На самом деле он определит пункт FROM на основе всех остальных элементов: пункта columns, пункта where, а также некоторых других элементов, которые мы еще не рассматривали, включая ORDER BY, GROUP BY и HAVING.

Краткосрочный способ использования and_() заключается в соединении нескольких пунктов Select.where(). Вышеприведенное можно также записать как:

>>> s = (
...     select((users.c.fullname + ", " + addresses.c.email_address).label("title"))
...     .where(users.c.id == addresses.c.user_id)
...     .where(users.c.name.between("m", "z"))
...     .where(
...         or_(
...             addresses.c.email_address.like("%@aol.com"),
...             addresses.c.email_address.like("%@msn.com"),
...         )
...     )
... )
>>> conn.execute(s).fetchall()
SELECT users.fullname || ? || addresses.email_address AS title FROM users, addresses WHERE users.id = addresses.user_id AND users.name BETWEEN ? AND ? AND (addresses.email_address LIKE ? OR addresses.email_address LIKE ?) [...] (', ', 'm', 'z', '%@aol.com', '%@msn.com')
[(u'Wendy Williams, wendy@aol.com',)]

Способ, которым мы можем построить конструкцию select() через последовательные вызовы методов, называется method chaining.

Использование текстового SQL

Наш последний пример действительно стал сложным для ввода. Переход от текстового выражения SQL к конструкции Python, которая группирует компоненты вместе в программном стиле, может быть трудным. Именно поэтому SQLAlchemy позволяет вам просто использовать строки, для тех случаев, когда SQL уже известен и нет сильной необходимости в том, чтобы оператор поддерживал динамические функции. Конструкция text() используется для составления текстового утверждения, которое передается в базу данных практически без изменений. Ниже мы создадим объект text() и выполним его:

>>> from sqlalchemy.sql import text
>>> s = text(
...     "SELECT users.fullname || ', ' || addresses.email_address AS title "
...     "FROM users, addresses "
...     "WHERE users.id = addresses.user_id "
...     "AND users.name BETWEEN :x AND :y "
...     "AND (addresses.email_address LIKE :e1 "
...     "OR addresses.email_address LIKE :e2)"
... )
>>> conn.execute(s, {"x": "m", "y": "z", "e1": "%@aol.com", "e2": "%@msn.com"}).fetchall()
SELECT users.fullname || ', ' || addresses.email_address AS title FROM users, addresses WHERE users.id = addresses.user_id AND users.name BETWEEN ? AND ? AND (addresses.email_address LIKE ? OR addresses.email_address LIKE ?) [...] ('m', 'z', '%@aol.com', '%@msn.com')
[(u'Wendy Williams, wendy@aol.com',)]

Выше мы видим, что связанные параметры указываются в text() с использованием формата именованного двоеточия; этот формат является последовательным независимо от бэкенда базы данных. Чтобы передать значения для параметров, мы передали их в метод Connection.execute() в качестве дополнительных аргументов.

Указание поведения граничных параметров

Конструкция text() поддерживает предварительно установленные связанные значения с помощью метода TextClause.bindparams():

stmt = text("SELECT * FROM users WHERE users.name BETWEEN :x AND :y")
stmt = stmt.bindparams(x="m", y="z")

Параметры также могут быть явно типизированы:

stmt = stmt.bindparams(bindparam("x", type_=String), bindparam("y", type_=String))
result = conn.execute(stmt, {"x": "m", "y": "z"})

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

См.также

TextClause.bindparams() - полное описание метода

Указание поведения колонок результатов

Мы также можем указать информацию о столбцах результата с помощью метода TextClause.columns(); этот метод можно использовать для указания возвращаемых типов, основанных на имени:

stmt = stmt.columns(id=Integer, name=String)

или ему могут быть переданы полные выражения столбцов позиционно, как типизированные, так и нетипизированные. В этом случае целесообразно явно перечислить столбцы в нашем текстовом SQL, поскольку соотнесение наших выражений столбцов с SQL будет осуществляться позиционно:

stmt = text("SELECT id, name FROM users")
stmt = stmt.columns(users.c.id, users.c.name)

Когда мы вызываем метод TextClause.columns(), мы получаем обратно объект TextAsFrom, который поддерживает полный набор TextAsFrom.c и других «выбираемых» операций:

j = stmt.join(addresses, stmt.c.id == addresses.c.user_id)

new_stmt = select(stmt.c.id, addresses.c.id).select_from(j).where(stmt.c.name == "x")

Позиционная форма TextClause.columns() особенно полезна при соотнесении текстового SQL с существующими моделями Core или ORM, поскольку мы можем использовать выражения столбцов напрямую, не беспокоясь о конфликтах имен или других проблемах с именами результирующих столбцов в текстовом SQL:

>>> stmt = text(
...     "SELECT users.id, addresses.id, users.id, "
...     "users.name, addresses.email_address AS email "
...     "FROM users JOIN addresses ON users.id=addresses.user_id "
...     "WHERE users.id = 1"
... ).columns(
...     users.c.id,
...     addresses.c.id,
...     addresses.c.user_id,
...     users.c.name,
...     addresses.c.email_address,
... )
>>> result = conn.execute(stmt)
SELECT users.id, addresses.id, users.id, users.name, addresses.email_address AS email FROM users JOIN addresses ON users.id=addresses.user_id WHERE users.id = 1 [...] ()

Выше, в результате есть три столбца с именем «id», но поскольку мы связали их с выражениями столбцов позиционно, имена не являются проблемой, когда столбцы результата извлекаются с использованием фактического объекта столбца в качестве ключа. Получение столбца email_address будет выглядеть так:

>>> row = result.fetchone()
>>> row._mapping[addresses.c.email_address]
'jack@yahoo.com'

С другой стороны, если бы мы использовали строковый ключ столбца, обычные правила сопоставления на основе имен все еще применимы, и мы получили бы ошибку неоднозначного столбца для значения id:

>>> row._mapping["id"]
Traceback (most recent call last):
...
InvalidRequestError: Ambiguous column name 'id' in result set column descriptions

Важно отметить, что хотя доступ к столбцам из набора результатов с помощью объектов Column может показаться необычным, на самом деле это единственная система, используемая ORM, которая происходит прозрачно под фасадом объекта Query; таким образом, метод TextClause.columns() обычно очень применим к текстовым утверждениям для использования в контексте ORM. Пример в Использование текстового SQL иллюстрирует простое использование.

Добавлено в версии 1.1: Метод TextClause.columns() теперь принимает выражения столбцов, которые будут позиционно сопоставлены с набором результатов обычного текстового SQL, устраняя необходимость совпадения или даже уникальности имен столбцов в операторе SQL при сопоставлении метаданных таблицы или моделей ORM с текстовым SQL.

См.также

TextClause.columns() - полное описание метода

Использование текстового SQL - интеграция запросов на уровне ORM с text()

Использование фрагментов text() внутри больших операторов

text() также может использоваться для создания фрагментов SQL, которые могут свободно находиться внутри объекта select(), который принимает объекты text() в качестве аргумента для большинства своих функций построителя. Ниже мы объединим использование text() внутри объекта select(). Конструкция select() обеспечивает «геометрию» высказывания, а конструкция text() обеспечивает текстовое содержание в этой форме. Мы можем построить высказывание без необходимости обращаться к каким-либо заранее установленным метаданным Table:

>>> s = (
...     select(text("users.fullname || ', ' || addresses.email_address AS title"))
...     .where(
...         and_(
...             text("users.id = addresses.user_id"),
...             text("users.name BETWEEN 'm' AND 'z'"),
...             text(
...                 "(addresses.email_address LIKE :x "
...                 "OR addresses.email_address LIKE :y)"
...             ),
...         )
...     )
...     .select_from(text("users, addresses"))
... )
>>> conn.execute(s, {"x": "%@aol.com", "y": "%@msn.com"}).fetchall()
SELECT users.fullname || ', ' || addresses.email_address AS title FROM users, addresses WHERE users.id = addresses.user_id AND users.name BETWEEN 'm' AND 'z' AND (addresses.email_address LIKE ? OR addresses.email_address LIKE ?) [...] ('%@aol.com', '%@msn.com')
[(u'Wendy Williams, wendy@aol.com',)]

Хотя text() можно использовать в списке столбцов объекта select(), он имеет некоторые ограничения при составлении сгенерированного select, поскольку не будет находиться в коллекции SelectBase.selected_columns и будет опущен в коллекции подзапросов .c. В следующем разделе будет представлена конструкция literal_column(), которая является лучшим выбором для выражения отдельных имен столбцов в виде фрагментов SQL.

Использование более конкретного текста с помощью table(), literal_column() и column()

Мы можем переместить уровень структуры и в другую сторону, используя column(), literal_column() и table() для некоторых ключевых элементов нашего утверждения. Используя эти конструкции, мы можем получить несколько больше возможностей выражения, чем если бы мы использовали text() напрямую, поскольку они предоставляют ядру больше информации о том, как должны использоваться хранящиеся в них строки, но все же без необходимости входить в полные метаданные, основанные на Table. Ниже мы также указываем тип данных String для двух ключевых объектов literal_column(), чтобы стал доступен специфический для строк оператор конкатенации. Мы также используем literal_column() для того, чтобы использовать выражения с квалификацией таблицы, например users.fullname, которые будут отображаться как есть; использование column() подразумевает индивидуальное имя столбца, которое может быть заключено в кавычки:

>>> from sqlalchemy import select, and_, text, String
>>> from sqlalchemy.sql import table, literal_column
>>> s = (
...     select(
...         literal_column("users.fullname", String)
...         + ", "
...         + literal_column("addresses.email_address").label("title")
...     )
...     .where(
...         and_(
...             literal_column("users.id") == literal_column("addresses.user_id"),
...             text("users.name BETWEEN 'm' AND 'z'"),
...             text(
...                 "(addresses.email_address LIKE :x OR "
...                 "addresses.email_address LIKE :y)"
...             ),
...         )
...     )
...     .select_from(table("users"))
...     .select_from(table("addresses"))
... )

>>> conn.execute(s, {"x": "%@aol.com", "y": "%@msn.com"}).fetchall()
SELECT users.fullname || ? || addresses.email_address AS anon_1 FROM users, addresses WHERE users.id = addresses.user_id AND users.name BETWEEN 'm' AND 'z' AND (addresses.email_address LIKE ? OR addresses.email_address LIKE ?) [...] (', ', '%@aol.com', '%@msn.com')
[(u'Wendy Williams, wendy@aol.com',)]

Упорядочивание или группировка по метке

Одно из мест, где мы иногда хотим использовать строку в качестве ярлыка, это когда в нашем операторе есть некоторый элемент столбца с меткой, на который мы хотим сослаться в таком месте, как предложение «ORDER BY» или «GROUP BY»; другие кандидаты включают поля в предложении «OVER» или «DISTINCT». Если у нас есть такая метка в конструкции select(), мы можем обратиться к ней напрямую, передав строку прямо в select.order_by() или select.group_by(), среди прочих. Это приведет к ссылке на именованную метку, а также предотвратит двойное отображение выражения. Имена меток, которые разрешаются в столбцы, отображаются полностью:

>>> from sqlalchemy import func
>>> stmt = (
...     select(addresses.c.user_id, func.count(addresses.c.id).label("num_addresses"))
...     .group_by("user_id")
...     .order_by("user_id", "num_addresses")
... )

sql>>> conn.execute(stmt).fetchall()
[(1, 2), (2, 2)]

Мы можем использовать модификаторы типа asc() или desc(), передавая имя строки:

>>> from sqlalchemy import func, desc
>>> stmt = (
...     select(addresses.c.user_id, func.count(addresses.c.id).label("num_addresses"))
...     .group_by("user_id")
...     .order_by("user_id", desc("num_addresses"))
... )

sql>>> conn.execute(stmt).fetchall()
[(1, 2), (2, 2)]

Обратите внимание, что функция строки здесь в значительной степени приспособлена для тех случаев, когда мы уже использовали метод ColumnElement.label() для создания метки с конкретным именем. В других случаях мы всегда хотим ссылаться непосредственно на объект ColumnElement, чтобы система выражения могла сделать наиболее эффективный выбор для рендеринга. Ниже показано, как использование ColumnElement устраняет двусмысленность, когда мы хотим упорядочить по имени столбца, которое встречается несколько раз:

>>> u1a, u1b = users.alias(), users.alias()
>>> stmt = (
...     select(u1a, u1b).where(u1a.c.name > u1b.c.name).order_by(u1a.c.name)
... )  # using "name" here would be ambiguous

sql>>> conn.execute(stmt).fetchall()
[(2, u'wendy', u'Wendy Williams', 1, u'jack', u'Jack Jones')]

Использование псевдонимов и подзапросов

Псевдоним в SQL соответствует «переименованной» версии таблицы или оператора SELECT, что происходит всякий раз, когда вы говорите «SELECT … FROM sometable AS someothername». Символ AS создает новое имя для таблицы. Псевдонимы - это ключевая конструкция, поскольку они позволяют ссылаться на любую таблицу или подзапрос по уникальному имени. В случае с таблицей это позволяет называть одну и ту же таблицу в предложении FROM несколько раз. В случае оператора SELECT это обеспечивает родительское имя для столбцов, представленных в операторе, позволяя ссылаться на них относительно этого имени.

В SQLAlchemy любой Table или другой FromClause, основанный на выборе, может быть превращен в псевдоним с помощью метода FromClause.alias(), который создает конструкцию Alias. Alias - это объект FromClause, который ссылается на отображение объектов Column через свою коллекцию FromClause.c и может использоваться в предложении FROM любого последующего оператора SELECT, путем ссылки на его элементы столбцов в столбцах или предложении WHERE оператора, или путем явного размещения в предложении FROM, либо напрямую, либо в рамках объединения.

В качестве примера предположим, что мы знаем, что у нашего пользователя jack есть два определенных адреса электронной почты. Как мы можем найти Джека по комбинации этих двух адресов? Для этого мы используем соединение с таблицей addresses, по одному разу для каждого адреса. Мы создадим две конструкции Alias против addresses, а затем используем их обе в конструкции select():

>>> a1 = addresses.alias()
>>> a2 = addresses.alias()
>>> s = select(users).where(
...     and_(
...         users.c.id == a1.c.user_id,
...         users.c.id == a2.c.user_id,
...         a1.c.email_address == "jack@msn.com",
...         a2.c.email_address == "jack@yahoo.com",
...     )
... )
>>> conn.execute(s).fetchall()
SELECT users.id, users.name, users.fullname FROM users, addresses AS addresses_1, addresses AS addresses_2 WHERE users.id = addresses_1.user_id AND users.id = addresses_2.user_id AND addresses_1.email_address = ? AND addresses_2.email_address = ? [...] ('jack@msn.com', 'jack@yahoo.com')
[(1, u'jack', u'Jack Jones')]

Обратите внимание, что конструкция Alias породила имена addresses_1 и addresses_2 в конечном результате SQL. Генерация этих имен определяется положением конструкции в операторе. Если бы мы создали запрос, используя только второй псевдоним a2, имя получилось бы addresses_1. Генерация имен также является детерминированной, то есть одна и та же конструкция оператора SQLAlchemy будет выдавать идентичную строку SQL каждый раз, когда она создается для определенного диалекта.

Поскольку снаружи мы обращаемся к псевдониму с помощью самой конструкции Alias, нам не нужно заботиться о генерируемом имени. Однако для целей отладки его можно указать, передав строковое имя методу FromClause.alias():

>>> a1 = addresses.alias("a1")

SELECT-ориентированные конструкции, которые расширяются из SelectBase, могут быть превращены в псевдоподзапросы с помощью метода SelectBase.subquery(), который создает конструкцию Subquery; для удобства использования существует также метод SelectBase.alias(), который является синонимом SelectBase.subquery(). Как и Alias, Subquery также является объектом FromClause, который может быть частью любого вложенного SELECT, используя те же приемы, что и для Alias.

Мы можем самостоятельно присоединить таблицу users обратно к созданной нами select(), сделав Subquery из всего оператора:

>>> address_subq = s.subquery()
>>> s = select(users.c.name).where(users.c.id == address_subq.c.id)
>>> conn.execute(s).fetchall()
SELECT users.name FROM users, (SELECT users.id AS id, users.name AS name, users.fullname AS fullname FROM users, addresses AS addresses_1, addresses AS addresses_2 WHERE users.id = addresses_1.user_id AND users.id = addresses_2.user_id AND addresses_1.email_address = ? AND addresses_2.email_address = ?) AS anon_1 WHERE users.id = anon_1.id [...] ('jack@msn.com', 'jack@yahoo.com')
[(u'jack',)]

Изменено в версии 1.4: Добавлен объект Subquery и создано большее разделение между «псевдонимом» предложения FROM и именованным подзапросом SELECT. См. A SELECT statement is no longer implicitly considered to be a FROM clause.

Использование объединений

Мы уже на полпути к тому, чтобы иметь возможность построить любое выражение SELECT. Следующим краеугольным камнем SELECT является выражение JOIN. Мы уже делали объединения в наших примерах, просто помещая две таблицы либо в предложение columns, либо в предложение where конструкции select(). Но если мы хотим сделать настоящую конструкцию «JOIN» или «OUTERJOIN», мы используем методы FromClause.join() и FromClause.outerjoin(), доступ к которым чаще всего осуществляется из левой таблицы в соединении:

>>> print(users.join(addresses))
users JOIN addresses ON users.id = addresses.user_id

Бдительный читатель увидит еще больше сюрпризов; SQLAlchemy придумала, как соединить эти две таблицы! Условие ON соединения, как оно называется, было автоматически сгенерировано на основе объекта ForeignKey, который мы поместили в таблицу addresses в начале этого руководства. Уже сейчас конструкция join() выглядит гораздо лучшим способом объединения таблиц.

Конечно, вы можете присоединиться к любому выражению, которое вы хотите, например, если мы хотим присоединиться ко всем пользователям, которые используют то же имя в адресе электронной почты в качестве имени пользователя:

>>> print(users.join(addresses, addresses.c.email_address.like(users.c.name + "%")))
users JOIN addresses ON addresses.email_address LIKE users.name || :name_1

Когда мы создаем конструкцию select(), SQLAlchemy просматривает таблицы, которые мы упоминали, и затем помещает их в предложение FROM оператора. Однако, когда мы используем JOIN, мы знаем, какой пункт FROM нам нужен, поэтому здесь мы используем метод Select.select_from():

>>> s = select(users.c.fullname).select_from(
...     users.join(addresses, addresses.c.email_address.like(users.c.name + "%"))
... )
sql>>> conn.execute(s).fetchall()
[(u'Jack Jones',), (u'Jack Jones',), (u'Wendy Williams',)]

Метод FromClause.outerjoin() создает конструкции LEFT OUTER JOIN и используется так же, как FromClause.join():

>>> s = select(users.c.fullname).select_from(users.outerjoin(addresses))
>>> print(s)
SELECT users.fullname
    FROM users
    LEFT OUTER JOIN addresses ON users.id = addresses.user_id

Это вывод outerjoin(), если, конечно, вы не застряли в программе, использующей Oracle до версии 9, и вы настроили свой движок (который будет использовать OracleDialect) на использование SQL, специфичного для Oracle:

>>> from sqlalchemy.dialects.oracle import dialect as OracleDialect
>>> print(s.compile(dialect=OracleDialect(use_ansi=False)))
SELECT users.fullname
FROM users, addresses
WHERE users.id = addresses.user_id(+)

Если вы не знаете, что означает этот SQL, не волнуйтесь! Тайное племя DBA Oracle не хочет, чтобы их черная магия была обнаружена ;).

См.также

join()

outerjoin()

Join

Общие табличные выражения (CTE)

Общие табличные выражения в настоящее время поддерживаются всеми основными базами данных, включая современные MySQL, MariaDB, SQLite, PostgreSQL, Oracle и MS SQL Server. SQLAlchemy поддерживает эту конструкцию через объект CTE, который обычно приобретается с помощью метода Select.cte() в конструкции Select:

>>> users_cte = select(users.c.id, users.c.name).where(users.c.name == "wendy").cte()
>>> stmt = (
...     select(addresses)
...     .where(addresses.c.user_id == users_cte.c.id)
...     .order_by(addresses.c.id)
... )
>>> conn.execute(stmt).fetchall()
WITH anon_1 AS (SELECT users.id AS id, users.name AS name FROM users WHERE users.name = ?) SELECT addresses.id, addresses.user_id, addresses.email_address FROM addresses, anon_1 WHERE addresses.user_id = anon_1.id ORDER BY addresses.id [...] ('wendy',)
[(3, 2, 'www@www.org'), (4, 2, 'wendy@aol.com')]

Конструкция CTE - это отличный способ предоставить источник строк, который семантически похож на использование подзапроса, но имеет гораздо более простой формат, когда источник строк аккуратно спрятан в верхней части запроса, где на него можно ссылаться в любом месте основного оператора, как на обычную таблицу.

Когда мы создаем объект CTE, мы используем его как любую другую таблицу в операторе. Однако вместо того, чтобы быть добавленным в предложение FROM в качестве подзапроса, он выходит на первое место, что имеет дополнительное преимущество - не вызывает неожиданных картезианских произведений.

Рекурсивный формат CTE доступен при использовании параметра Select.cte.recursive. Рекурсивный CTE обычно требует, чтобы мы ссылались на себя как на псевдоним. Общая форма такой операции включает в себя объединение исходного CTE с самим собой. Учитывая, что наши примеры таблиц не очень подходят для создания действительно полезного запроса с такой функцией, эта форма выглядит следующим образом:

>>> users_cte = select(users.c.id, users.c.name).cte(recursive=True)
>>> users_recursive = users_cte.alias()
>>> users_cte = users_cte.union(
...     select(users.c.id, users.c.name).where(users.c.id > users_recursive.c.id)
... )
>>> stmt = (
...     select(addresses)
...     .where(addresses.c.user_id == users_cte.c.id)
...     .order_by(addresses.c.id)
... )
>>> conn.execute(stmt).fetchall()
WITH RECURSIVE anon_1(id, name) AS (SELECT users.id AS id, users.name AS name FROM users UNION SELECT users.id AS id, users.name AS name FROM users, anon_1 AS anon_2 WHERE users.id > anon_2.id) SELECT addresses.id, addresses.user_id, addresses.email_address FROM addresses, anon_1 WHERE addresses.user_id = anon_1.id ORDER BY addresses.id [...] ()
[(1, 1, 'jack@yahoo.com'), (2, 1, 'jack@msn.com'), (3, 2, 'www@www.org'), (4, 2, 'wendy@aol.com')]

Все остальное

Концепции создания выражений SQL были введены. Остались только варианты одних и тех же тем. Поэтому сейчас мы составим каталог остальных важных вещей, которые нам нужно будет знать.

Связывание объектов параметров

Во всех этих примерах SQLAlchemy занимается созданием параметров связывания везде, где встречаются буквальные выражения. Вы также можете задавать собственные параметры связывания с собственными именами и использовать одно и то же выражение многократно. Конструкция bindparam() используется для создания связанного параметра с заданным именем. Хотя SQLAlchemy всегда ссылается на связанные параметры по имени на стороне API, диалект базы данных преобразует их в соответствующий именованный или позиционный стиль во время выполнения, как здесь, где он преобразует в позиционный для SQLite:

>>> from sqlalchemy.sql import bindparam
>>> s = users.select().where(users.c.name == bindparam("username"))
sql>>> conn.execute(s, {"username": "wendy"}).fetchall()
[(2, u'wendy', u'Wendy Williams')]

Другим важным аспектом bindparam() является то, что ему может быть присвоен тип. Тип параметра привязки определяет его поведение в выражениях, а также то, как обрабатываются привязанные к нему данные перед отправкой в базу данных:

>>> s = users.select().where(
...     users.c.name.like(bindparam("username", type_=String) + text("'%'"))
... )
sql>>> conn.execute(s, {"username": "wendy"}).fetchall()
[(2, u'wendy', u'Wendy Williams')]

Одноименные конструкции bindparam() также могут быть использованы несколько раз, когда в параметрах выполнения требуется только одно именованное значение:

>>> s = (
...     select(users, addresses)
...     .where(
...         or_(
...             users.c.name.like(bindparam("name", type_=String) + text("'%'")),
...             addresses.c.email_address.like(
...                 bindparam("name", type_=String) + text("'@%'")
...             ),
...         )
...     )
...     .select_from(users.outerjoin(addresses))
...     .order_by(addresses.c.id)
... )
sql>>> conn.execute(s, {"name": "jack"}).fetchall()
[(1, u'jack', u'Jack Jones', 1, 1, u'jack@yahoo.com'), (1, u'jack', u'Jack Jones', 2, 1, u'jack@msn.com')]

См.также

bindparam()

Функции

Функции SQL создаются с помощью ключевого слова func, которое генерирует функции, используя доступ к атрибутам:

>>> from sqlalchemy.sql import func
>>> print(func.now())
now()

>>> print(func.concat("x", "y"))
concat(:concat_1, :concat_2)

Под «генерирует» мы подразумеваем, что любая функция SQL создается на основе выбранного вами слова:

>>> print(func.xyz_my_goofy_function())
xyz_my_goofy_function()

Некоторые имена функций известны SQLAlchemy, что позволяет применять специальные правила поведения. Некоторые, например, являются «ANSI» функциями, что означает, что после них не добавляются скобки, например CURRENT_TIMESTAMP:

>>> print(func.current_timestamp())
CURRENT_TIMESTAMP

Функция, как и любое другое выражение столбца, имеет тип, который указывает на тип выражения, а также на то, как SQLAlchemy будет интерпретировать столбцы результатов, которые возвращаются из этого выражения. Тип по умолчанию, используемый для произвольного имени функции, полученного из func, - это просто тип данных «null». Однако для того, чтобы выражение столбца, генерируемое функцией, имело специфическое для типа поведение оператора, а также поведение набора результатов, такое как дата и числовые коэрцитивы, может потребоваться явное указание типа:

stmt = select(func.date(some_table.c.date_string, type_=Date))

Функции чаще всего используются в предложении columns оператора select, и им можно присвоить метку, а также тип. Маркировка функции рекомендуется для того, чтобы результат можно было найти в строке результата на основе имени строки, а присвоение ей типа необходимо, когда требуется обработка набора результатов, например, для преобразования Юникода или даты. Ниже мы используем функцию результата scalar(), чтобы просто прочитать первый столбец первой строки и затем закрыть результат; метка, даже если она присутствует, в данном случае не важна:

>>> conn.execute(
...     select(func.max(addresses.c.email_address, type_=String).label("maxemail"))
... ).scalar()
SELECT max(addresses.email_address) AS maxemail FROM addresses [...] ()
u'www@www.org'

Такие базы данных, как PostgreSQL и Oracle, поддерживающие функции, которые возвращают целые наборы результатов, могут быть собраны в выбираемые единицы, которые можно использовать в операторах. Например, функцию базы данных calculate(), которая принимает параметры x и y и возвращает три столбца, которые мы хотели бы назвать q, z и r, мы можем построить, используя «лексические» объекты столбцов, а также параметры связывания:

>>> from sqlalchemy.sql import column
>>> calculate = select(column("q"), column("z"), column("r")).select_from(
...     func.calculate(bindparam("x"), bindparam("y"))
... )
>>> calc = calculate.alias()
>>> print(select(users).where(users.c.id > calc.c.z))
SELECT users.id, users.name, users.fullname
FROM users, (SELECT q, z, r
FROM calculate(:x, :y)) AS anon_1
WHERE users.id > anon_1.z

Если мы хотим использовать наш оператор calculate дважды с разными параметрами привязки, функция unique_params() создаст для нас копии и пометит параметры привязки как «уникальные», так что конфликтующие имена будут изолированы. Обратите внимание, что мы также создаем два отдельных псевдонима нашего selectable:

>>> calc1 = calculate.alias("c1").unique_params(x=17, y=45)
>>> calc2 = calculate.alias("c2").unique_params(x=5, y=12)
>>> s = select(users).where(users.c.id.between(calc1.c.z, calc2.c.z))
>>> print(s)
SELECT users.id, users.name, users.fullname
FROM users,
    (SELECT q, z, r FROM calculate(:x_1, :y_1)) AS c1,
    (SELECT q, z, r FROM calculate(:x_2, :y_2)) AS c2
WHERE users.id BETWEEN c1.z AND c2.z

>>> s.compile().params  
{u'x_2': 5, u'y_2': 12, u'y_1': 45, u'x_1': 17}

См.также

func

Функции окна

Любая FunctionElement, включая функции, генерируемые func, может быть превращена в «оконную функцию», то есть в предложение OVER, с помощью метода FunctionElement.over():

>>> s = select(users.c.id, func.row_number().over(order_by=users.c.name))
>>> print(s)
SELECT users.id, row_number() OVER (ORDER BY users.name) AS anon_1
FROM users

FunctionElement.over() также поддерживает задание диапазона с помощью параметров over.rows или over.range:

>>> s = select(users.c.id, func.row_number().over(order_by=users.c.name, rows=(-2, None)))
>>> print(s)
SELECT users.id, row_number() OVER
(ORDER BY users.name ROWS BETWEEN :param_1 PRECEDING AND UNBOUNDED FOLLOWING) AS anon_1
FROM users

over.rows и over.range принимают по два кортежа, которые содержат комбинацию отрицательных и положительных целых чисел для диапазонов, ноль для обозначения «CURRENT ROW» и None для обозначения «UNBOUNDED». Более подробно см. примеры в over().

Добавлено в версии 1.1: поддержка спецификации «строки» и «диапазона» для оконных функций

См.также

over()

FunctionElement.over()

Приведение данных и принуждение типов

В SQL часто требуется явно указать тип данных элемента или преобразовать один тип данных в другой в SQL-операторе. Функция CAST SQL выполняет эту задачу. В SQLAlchemy функция cast() представляет собой ключевое слово SQL CAST. В качестве аргументов она принимает выражение столбца и объект типа данных:

>>> from sqlalchemy import cast
>>> s = select(cast(users.c.id, String))
>>> conn.execute(s).fetchall()
SELECT CAST(users.id AS VARCHAR) AS id FROM users [...] ()
[('1',), ('2',)]

Функция cast() используется не только при преобразовании между типами данных, но и в случаях, когда базе данных необходимо знать, что определенное значение должно рассматриваться как определенный тип данных в выражении.

Функция cast() также сообщает самой SQLAlchemy, что выражение должно рассматриваться как определенный тип. Тип данных выражения непосредственно влияет на поведение операторов Python над этим объектом, например, как оператор + может указывать на сложение целых чисел или конкатенацию строк, а также влияет на то, как литеральное значение Python преобразуется или обрабатывается перед передачей в базу данных, и как должны преобразовываться или обрабатываться значения результатов этого выражения.

Иногда возникает необходимость, чтобы SQLAlchemy знал тип данных выражения по всем вышеупомянутым причинам, но не отображал само выражение CAST на стороне SQL, где оно может помешать SQL-операции, которая уже работает без него. Для этого довольно распространенного случая использования существует еще одна функция type_coerce(), которая тесно связана с cast(), в том смысле, что она устанавливает выражение Python как имеющее определенный тип базы данных SQL, но не отображает ключевое слово CAST или тип данных на стороне базы данных. type_coerce() особенно важно при работе с типом данных JSON, который обычно имеет сложную связь со строково-ориентированными типами данных на разных платформах и может даже не быть явным типом данных, как, например, в SQLite и MariaDB. Ниже мы используем type_coerce() для передачи структуры Python в виде строки JSON в одну из функций MySQL JSON:

>>> import json
>>> from sqlalchemy import JSON
>>> from sqlalchemy import type_coerce
>>> from sqlalchemy.dialects import mysql
>>> s = select(type_coerce({"some_key": {"foo": "bar"}}, JSON)["some_key"])
>>> print(s.compile(dialect=mysql.dialect()))
SELECT JSON_EXTRACT(%s, %s) AS anon_1

Выше SQL-функция MySQL JSON_EXTRACT была вызвана, поскольку мы использовали type_coerce(), чтобы указать, что наш словарь Python должен рассматриваться как JSON. В результате оператор Python __getitem__, ['some_key'] в данном случае, стал доступен и позволил отобразить выражение пути JSON_EXTRACT (не показано, однако в данном случае оно в конечном итоге будет '$."some_key"').

Профсоюзы и другие операции с комплектами

Объединения бывают двух видов, UNION и UNION ALL, которые доступны через функции уровня модуля union() и union_all():

>>> from sqlalchemy.sql import union
>>> u = union(
...     addresses.select().where(addresses.c.email_address == "foo@bar.com"),
...     addresses.select().where(addresses.c.email_address.like("%@yahoo.com")),
... ).order_by(addresses.c.email_address)

sql>>> conn.execute(u).fetchall()
[(1, 1, u'jack@yahoo.com')]

Также доступны intersect(), intersect_all(), except_() и except_all(), хотя и не поддерживаются во всех базах данных:

>>> from sqlalchemy.sql import except_
>>> u = except_(
...     addresses.select().where(addresses.c.email_address.like("%@%.com")),
...     addresses.select().where(addresses.c.email_address.like("%@msn.com")),
... )

sql>>> conn.execute(u).fetchall()
[(1, 1, u'jack@yahoo.com'), (4, 2, u'wendy@aol.com')]

Частая проблема с так называемыми «составными» selectables возникает из-за того, что они заключаются в круглые скобки. SQLite, в частности, не любит утверждения, начинающиеся со скобок. Поэтому при вложении «соединения» внутрь «соединения» часто необходимо применить .subquery().select() к первому элементу крайнего соединения, если этот элемент также является соединением. Например, чтобы вложить «union» и «select» внутри «except_», SQLite захочет, чтобы «union» был указан как подзапрос:

>>> u = except_(
...     union(
...         addresses.select().where(addresses.c.email_address.like("%@yahoo.com")),
...         addresses.select().where(addresses.c.email_address.like("%@msn.com")),
...     )
...     .subquery()
...     .select(),  # apply subquery here
...     addresses.select().where(addresses.c.email_address.like("%@msn.com")),
... )
sql>>> conn.execute(u).fetchall()
[(1, 1, u'jack@yahoo.com')]

См.также

union()

union_all()

intersect()

intersect_all()

except_()

except_all()

Заказ союзов

UNION и другие конструкции набора имеют особый случай, когда речь идет об упорядочивании результатов. Поскольку UNION состоит из нескольких операторов SELECT, для упорядочивания всего результата обычно требуется, чтобы предложение ORDER BY ссылалось на имена столбцов, но не на конкретные таблицы. Как и в предыдущих примерах, мы использовали .order_by(addresses.c.email_address), но SQLAlchemy отобразила ORDER BY без использования имени таблицы. Обобщенным способом применения ORDER BY к объединению является также обращение к коллекции CompoundSelect.selected_columns, чтобы получить доступ к выражениям столбцов, которые являются синонимами столбцов, выбранных из первого SELECT; компилятор SQLAlchemy гарантирует, что они будут отображены без имен таблиц:

>>> u = union(
...     addresses.select().where(addresses.c.email_address == "foo@bar.com"),
...     addresses.select().where(addresses.c.email_address.like("%@yahoo.com")),
... )
>>> u = u.order_by(u.selected_columns.email_address)
>>> print(u)
SELECT addresses.id, addresses.user_id, addresses.email_address
FROM addresses
WHERE addresses.email_address = :email_address_1
UNION SELECT addresses.id, addresses.user_id, addresses.email_address
FROM addresses
WHERE addresses.email_address LIKE :email_address_2 ORDER BY email_address

Scalar Selects

Скалярный select - это SELECT, который возвращает ровно одну строку и один столбец. Затем его можно использовать в качестве выражения столбца. Скалярный select часто представляет собой correlated subquery, который полагается на вложенный оператор SELECT, чтобы получить хотя бы один из его пунктов FROM.

Конструкцию select() можно модифицировать для работы в качестве выражения столбца, вызвав метод SelectBase.scalar_subquery() или SelectBase.label():

>>> subq = (
...     select(func.count(addresses.c.id))
...     .where(users.c.id == addresses.c.user_id)
...     .scalar_subquery()
... )

Приведенная выше конструкция теперь представляет собой объект ScalarSelect, который является адаптером вокруг исходного объекта Select; он участвует в семействе конструкций выражений ColumnElement. Мы можем разместить эту конструкцию так же, как и любой другой столбец внутри другого select():

>>> conn.execute(select(users.c.name, subq)).fetchall()
SELECT users.name, (SELECT count(addresses.id) AS count_1 FROM addresses WHERE users.id = addresses.user_id) AS anon_1 FROM users [...] ()
[(u'jack', 2), (u'wendy', 2)]

Чтобы применить неанонимное имя столбца к нашему скалярному select, мы создаем его с помощью SelectBase.label():

>>> subq = (
...     select(func.count(addresses.c.id))
...     .where(users.c.id == addresses.c.user_id)
...     .label("address_count")
... )
>>> conn.execute(select(users.c.name, subq)).fetchall()
SELECT users.name, (SELECT count(addresses.id) AS count_1 FROM addresses WHERE users.id = addresses.user_id) AS address_count FROM users [...] ()
[(u'jack', 2), (u'wendy', 2)]

См.также

Select.scalar_subquery()

Select.label()

Коррелированные подзапросы

В примерах на Scalar Selects, предложение FROM каждого встроенного select не содержало таблицу users в своем предложении FROM. Это объясняется тем, что SQLAlchemy автоматически correlates встроенные объекты FROM к объектам вложенного запроса, если они присутствуют, и если внутренний оператор SELECT будет иметь хотя бы одно собственное предложение FROM. Например:

>>> stmt = (
...     select(addresses.c.user_id)
...     .where(addresses.c.user_id == users.c.id)
...     .where(addresses.c.email_address == "jack@yahoo.com")
... )
>>> enclosing_stmt = select(users.c.name).where(users.c.id == stmt.scalar_subquery())
>>> conn.execute(enclosing_stmt).fetchall()
SELECT users.name FROM users WHERE users.id = (SELECT addresses.user_id FROM addresses WHERE addresses.user_id = users.id AND addresses.email_address = ?) [...] ('jack@yahoo.com',)
[(u'jack',)]

Автокорреляция обычно делает то, что ожидается, однако ею можно управлять. Например, если мы хотим, чтобы оператор коррелировал только с таблицей addresses, но не с таблицей users, даже если они обе присутствуют во вложенном SELECT, мы используем метод Select.correlate(), чтобы указать те предложения FROM, которые могут быть коррелированы:

>>> stmt = (
...     select(users.c.id)
...     .where(users.c.id == addresses.c.user_id)
...     .where(users.c.name == "jack")
...     .correlate(addresses)
... )
>>> enclosing_stmt = (
...     select(users.c.name, addresses.c.email_address)
...     .select_from(users.join(addresses))
...     .where(users.c.id == stmt.scalar_subquery())
... )
>>> conn.execute(enclosing_stmt).fetchall()
SELECT users.name, addresses.email_address FROM users JOIN addresses ON users.id = addresses.user_id WHERE users.id = (SELECT users.id FROM users WHERE users.id = addresses.user_id AND users.name = ?) [...] ('jack',)
[(u'jack', u'jack@yahoo.com'), (u'jack', u'jack@msn.com')]

Чтобы полностью запретить корреляцию утверждения, мы можем передать None в качестве аргумента:

>>> stmt = select(users.c.id).where(users.c.name == "wendy").correlate(None)
>>> enclosing_stmt = select(users.c.name).where(users.c.id == stmt.scalar_subquery())
>>> conn.execute(enclosing_stmt).fetchall()
SELECT users.name FROM users WHERE users.id = (SELECT users.id FROM users WHERE users.name = ?) [...] ('wendy',)
[(u'wendy',)]

Мы также можем управлять корреляцией через исключение, используя метод Select.correlate_except(). Например, мы можем написать наш SELECT для таблицы users, указав ему коррелировать все предложения FROM, кроме users:

>>> stmt = (
...     select(users.c.id)
...     .where(users.c.id == addresses.c.user_id)
...     .where(users.c.name == "jack")
...     .correlate_except(users)
... )
>>> enclosing_stmt = (
...     select(users.c.name, addresses.c.email_address)
...     .select_from(users.join(addresses))
...     .where(users.c.id == stmt.scalar_subquery())
... )
>>> conn.execute(enclosing_stmt).fetchall()
SELECT users.name, addresses.email_address FROM users JOIN addresses ON users.id = addresses.user_id WHERE users.id = (SELECT users.id FROM users WHERE users.id = addresses.user_id AND users.name = ?) [...] ('jack',)
[(u'jack', u'jack@yahoo.com'), (u'jack', u'jack@msn.com')]

ЛАТЕРАЛЬНАЯ корреляция

ЛАТЕРАЛЬНАЯ корреляция - это особая подкатегория SQL-корреляции, которая позволяет выбираемой единице ссылаться на другую выбираемую единицу в одном предложении FROM. Это чрезвычайно специальный случай использования, который, хотя и является частью стандарта SQL, поддерживается только в последних версиях PostgreSQL.

Обычно, если оператор SELECT ссылается на table1 JOIN (some SELECT) AS subquery в своем предложении FROM, подзапрос в правой части не может ссылаться на выражение «table1» из левой части; корреляция может ссылаться только на таблицу, которая является частью другого SELECT, полностью охватывающего этот SELECT. Ключевое слово LATERAL позволяет нам перевернуть это поведение, позволяя выражению, такому как:

SELECT people.people_id, people.age, people.name
FROM people JOIN LATERAL (SELECT books.book_id AS book_id
FROM books WHERE books.owner_id = people.people_id)
AS book_subq ON true

Там, где выше, правая часть JOIN содержит подзапрос, который обращается не только к таблице «books», но и к таблице «people», соотносясь с левой частью JOIN. SQLAlchemy Core поддерживает оператор, подобный приведенному выше, используя метод Select.lateral() следующим образом:

>>> from sqlalchemy import table, column, select, true
>>> people = table("people", column("people_id"), column("age"), column("name"))
>>> books = table("books", column("book_id"), column("owner_id"))
>>> subq = (
...     select(books.c.book_id)
...     .where(books.c.owner_id == people.c.people_id)
...     .lateral("book_subq")
... )
>>> print(select(people).select_from(people.join(subq, true())))
SELECT people.people_id, people.age, people.name
FROM people JOIN LATERAL (SELECT books.book_id AS book_id
FROM books WHERE books.owner_id = people.people_id)
AS book_subq ON true

Выше мы видим, что метод Select.lateral() действует так же, как метод Select.alias(), включая то, что мы можем указать необязательное имя. Однако конструкция Lateral вместо Alias предусматривает ключевое слово LATERAL, а также специальные инструкции, разрешающие корреляцию изнутри предложения FROM заключающего оператора.

Метод Select.lateral() нормально взаимодействует с методами Select.correlate() и Select.correlate_except(), за исключением того, что правила корреляции также применяются к любым другим таблицам, присутствующим в заключающем оператор предложении FROM. По умолчанию корреляция «автоматическая» для этих таблиц, явная, если таблица указана в Select.correlate(), и явная для всех таблиц, кроме тех, которые указаны в Select.correlate_except().

Добавлено в версии 1.1: Поддержка ключевого слова LATERAL и латеральной корреляции.

См.также

Lateral

Select.lateral()

Упорядочивание, группировка, ограничение, смещение…инг…

Упорядочивание осуществляется путем передачи выражений столбцов в метод SelectBase.order_by():

>>> stmt = select(users.c.name).order_by(users.c.name)
>>> conn.execute(stmt).fetchall()
SELECT users.name FROM users ORDER BY users.name [...] ()
[(u'jack',), (u'wendy',)]

Восходящим или нисходящим движением можно управлять с помощью модификаторов ColumnElement.asc() и ColumnElement.desc():

>>> stmt = select(users.c.name).order_by(users.c.name.desc())
>>> conn.execute(stmt).fetchall()
SELECT users.name FROM users ORDER BY users.name DESC [...] ()
[(u'wendy',), (u'jack',)]

Группировка относится к предложению GROUP BY и обычно используется в сочетании с агрегатными функциями для создания групп строк, подлежащих агрегированию. Это обеспечивается с помощью метода SelectBase.group_by():

>>> stmt = (
...     select(users.c.name, func.count(addresses.c.id))
...     .select_from(users.join(addresses))
...     .group_by(users.c.name)
... )
>>> conn.execute(stmt).fetchall()
SELECT users.name, count(addresses.id) AS count_1 FROM users JOIN addresses ON users.id = addresses.user_id GROUP BY users.name [...] ()
[(u'jack', 2), (u'wendy', 2)]

См. также Упорядочивание или группировка по метке для важной техники упорядочивания или группировки по строковому имени столбца.

HAVING можно использовать для фильтрации результатов по суммарному значению после применения GROUP BY. Он доступен здесь через метод Select.having():

>>> stmt = (
...     select(users.c.name, func.count(addresses.c.id))
...     .select_from(users.join(addresses))
...     .group_by(users.c.name)
...     .having(func.length(users.c.name) > 4)
... )
>>> conn.execute(stmt).fetchall()
SELECT users.name, count(addresses.id) AS count_1 FROM users JOIN addresses ON users.id = addresses.user_id GROUP BY users.name HAVING length(users.name) > ? [...] (4,)
[(u'wendy', 2)]

Общепринятой системой борьбы с дубликатами в составных операторах SELECT является модификатор DISTINCT. Простое предложение DISTINCT можно добавить с помощью метода Select.distinct():

>>> stmt = (
...     select(users.c.name)
...     .where(addresses.c.email_address.contains(users.c.name))
...     .distinct()
... )
>>> conn.execute(stmt).fetchall()
SELECT DISTINCT users.name FROM users, addresses WHERE (addresses.email_address LIKE '%' || users.name || '%') [...] ()
[(u'jack',), (u'wendy',)]

Большинство бэкендов баз данных поддерживают систему ограничения количества возвращаемых строк, и большинство из них также имеют возможность начинать возвращать строки после заданного «смещения». В то время как такие распространенные бэкенды, как PostgreSQL, MySQL и SQLite, поддерживают ключевые слова LIMIT и OFFSET, другим бэкендам для достижения того же эффекта приходится обращаться к более эзотерическим функциям, таким как «оконные функции» и идентификаторы строк. Методы Select.limit() и Select.offset() обеспечивают легкую абстракцию в методологии текущего бэкенда:

>>> stmt = (
...     select(users.c.name, addresses.c.email_address)
...     .select_from(users.join(addresses))
...     .limit(1)
...     .offset(1)
... )
>>> conn.execute(stmt).fetchall()
SELECT users.name, addresses.email_address FROM users JOIN addresses ON users.id = addresses.user_id LIMIT ? OFFSET ? [...] (1, 1)
[(u'jack', u'jack@msn.com')]

Вставки, обновления и удаления

Мы уже видели метод TableClause.insert(), продемонстрированный ранее в этом учебнике. Там, где метод TableClause.insert() производит INSERT, метод TableClause.update() производит UPDATE. Обе эти конструкции имеют метод ValuesBase.values(), который определяет пункт VALUES или SET оператора.

Метод ValuesBase.values() позволяет использовать в качестве значения любое выражение столбца:

>>> stmt = users.update().values(fullname="Fullname: " + users.c.name)
>>> conn.execute(stmt)
UPDATE users SET fullname=(? || users.name) [...] ('Fullname: ',) COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

При использовании TableClause.insert() или TableClause.update() в контексте «execute many» мы также можем захотеть указать именованные связанные параметры, на которые мы можем ссылаться в списке аргументов. Эти две конструкции будут автоматически генерировать связанные заполнители для любых имен столбцов, переданных в словарях, отправленных в Connection.execute() во время выполнения. Однако, если мы хотим использовать явно указанные именованные параметры с составленными выражениями, нам необходимо использовать конструкцию bindparam(). При использовании bindparam() с TableClause.insert() или TableClause.update() имена столбцов таблицы резервируются для «автоматической» генерации имен привязки. Мы можем комбинировать использование неявно доступных имен привязки и явно именованных параметров, как в примере ниже:

>>> stmt = users.insert().values(name=bindparam("_name") + " .. name")
>>> conn.execute(
...     stmt,
...     [
...         {"id": 4, "_name": "name1"},
...         {"id": 5, "_name": "name2"},
...         {"id": 6, "_name": "name3"},
...     ],
... )
INSERT INTO users (id, name) VALUES (?, (? || ?)) [...] ((4, 'name1', ' .. name'), (5, 'name2', ' .. name'), (6, 'name3', ' .. name')) COMMIT <sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Оператор UPDATE создается с помощью конструкции TableClause.update(). Это работает так же, как INSERT, за исключением того, что есть дополнительное предложение WHERE, которое может быть указано:

>>> stmt = users.update().where(users.c.name == "jack").values(name="ed")

>>> conn.execute(stmt)
UPDATE users SET name=? WHERE users.name = ? [...] ('ed', 'jack') COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

При использовании TableClause.update() в контексте «executemany» мы можем захотеть также использовать явно названные связанные параметры в предложении WHERE. Для этого опять же используется конструкция bindparam():

>>> stmt = (
...     users.update()
...     .where(users.c.name == bindparam("oldname"))
...     .values(name=bindparam("newname"))
... )
>>> conn.execute(
...     stmt,
...     [
...         {"oldname": "jack", "newname": "ed"},
...         {"oldname": "wendy", "newname": "mary"},
...         {"oldname": "jim", "newname": "jake"},
...     ],
... )
UPDATE users SET name=? WHERE users.name = ? [...] (('ed', 'jack'), ('mary', 'wendy'), ('jake', 'jim')) COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Коррелирующие обновления

Коррелированное обновление позволяет обновить таблицу, используя выборку из другой или той же таблицы; оператор SELECT передается в виде скалярного подзапроса с помощью Select.scalar_subquery():

>>> stmt = (
...     select(addresses.c.email_address).where(addresses.c.user_id == users.c.id).limit(1)
... )
>>> conn.execute(users.update().values(fullname=stmt.scalar_subquery()))
UPDATE users SET fullname=(SELECT addresses.email_address FROM addresses WHERE addresses.user_id = users.id LIMIT ? OFFSET ?) [...] (1, 0) COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Обновление нескольких таблиц

Бэкенды PostgreSQL, Microsoft SQL Server и MySQL поддерживают операторы UPDATE, которые ссылаются на несколько таблиц. Для PG и MSSQL это синтаксис «UPDATE FROM», который обновляет одну таблицу за раз, но может ссылаться на дополнительные таблицы в дополнительном предложении «FROM», на которые затем можно ссылаться непосредственно в предложении WHERE. В MySQL несколько таблиц могут быть встроены в один оператор UPDATE, разделенные запятой. Конструкция SQLAlchemy update() поддерживает оба этих режима неявно, указывая несколько таблиц в предложении WHERE:

stmt = (
    users.update()
    .values(name="ed wood")
    .where(users.c.id == addresses.c.id)
    .where(addresses.c.email_address.startswith("ed%"))
)
conn.execute(stmt)

Результирующий SQL из вышеприведенного оператора будет выглядеть так:

UPDATE users SET name=:name FROM addresses
WHERE users.id = addresses.id AND
addresses.email_address LIKE :email_address_1 || '%'

При использовании MySQL столбцы из каждой таблицы могут быть назначены в предложении SET напрямую, используя форму словаря, переданную в Update.values():

stmt = (
    users.update()
    .values({users.c.name: "ed wood", addresses.c.email_address: "ed.wood@foo.com"})
    .where(users.c.id == addresses.c.id)
    .where(addresses.c.email_address.startswith("ed%"))
)

На таблицы явно ссылаются в предложении SET:

UPDATE users, addresses SET addresses.email_address=%s,
        users.name=%s WHERE users.id = addresses.id
        AND addresses.email_address LIKE concat(%s, '%')

Если конструкция используется в неподдерживающей базе данных, компилятор выдаст ошибку NotImplementedError. Для удобства, когда оператор выводится в виде строки без указания диалекта, вызывается компилятор «string SQL», который обеспечивает нерабочее SQL-представление конструкции.

Обновления с упорядочиванием параметров

Поведение конструкции update() по умолчанию при отображении утверждений SET заключается в том, что они отображаются с использованием упорядочивания столбцов, заданного в исходном объекте Table. Это важное поведение, поскольку оно означает, что рендеринг определенного оператора UPDATE с определенными столбцами будет каждый раз одинаковым, что влияет на системы кэширования запросов, которые полагаются на форму оператора, как на стороне клиента, так и на стороне сервера. Поскольку сами параметры передаются в метод Update.values() как ключи словаря Python, другого фиксированного упорядочивания не существует.

Однако в некоторых случаях порядок параметров, отображаемых в предложении SET оператора UPDATE, может потребовать явного указания. Основным примером этого является использование MySQL и обеспечение обновления значений столбцов на основе значений других столбцов. Конечный результат следующего оператора:

UPDATE some_table SET x = y + 10, y = 20

Будет иметь другой результат, чем:

UPDATE some_table SET y = 20, x = y + 10

Это связано с тем, что в MySQL отдельные предложения SET полностью оцениваются на основе каждого значения, а не на основе каждой строки, и по мере оценки каждого предложения SET значения, встроенные в строку, изменяются.

Для этого конкретного случая можно использовать метод update.ordered_values(). При использовании этого метода мы предоставляем последовательность из двух кортежей в качестве аргумента метода:

stmt = some_table.update().ordered_values(
    (some_table.c.y, 20), (some_table.c.x, some_table.c.y + 10)
)

Серия из двух кортежей - это, по сути, та же структура, что и словарь Python, за исключением того, что она явно предполагает определенное упорядочивание. Используя приведенную выше форму, мы можем быть уверены, что сначала будет выведено условие SET столбца «y», а затем условие SET столбца «x».

Изменено в версии 1.4: Добавлен метод Update.ordered_values(), который заменяет флаг update.preserve_parameter_order, который будет удален в SQLAlchemy 2.0.

См.также

mysql_insert_on_duplicate_key_update - справочная информация о клаузе MySQL ON DUPLICATE KEY UPDATE и о том, как поддерживать упорядочивание параметров.

Удаляет

И наконец, удаление. Это достаточно легко выполняется с помощью конструкции TableClause.delete():

>>> conn.execute(addresses.delete())
DELETE FROM addresses [...] () COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...> >>> conn.execute(users.delete().where(users.c.name > "m"))
DELETE FROM users WHERE users.name > ? [...] ('m',) COMMIT
<sqlalchemy.engine.cursor.LegacyCursorResult object at 0x...>

Удаление нескольких таблиц

Добавлено в версии 1.2.

Бэкенды PostgreSQL, Microsoft SQL Server и MySQL поддерживают операторы DELETE, которые ссылаются на несколько таблиц в критериях WHERE. Для PG и MySQL это синтаксис «DELETE USING», а для SQL Server это «DELETE FROM», который ссылается на более чем одну таблицу. Конструкция SQLAlchemy delete() поддерживает оба этих режима неявно, указывая несколько таблиц в предложении WHERE:

stmt = (
    users.delete()
    .where(users.c.id == addresses.c.id)
    .where(addresses.c.email_address.startswith("ed%"))
)
conn.execute(stmt)

На бэкенде PostgreSQL результирующий SQL из вышеприведенного оператора будет выглядеть так:

DELETE FROM users USING addresses
WHERE users.id = addresses.id
AND (addresses.email_address LIKE %(email_address_1)s || '%%')

Если конструкция используется в неподдерживающей базе данных, компилятор выдаст ошибку NotImplementedError. Для удобства, когда оператор выводится в виде строки без указания диалекта, вызывается компилятор «string SQL», который обеспечивает нерабочее SQL-представление конструкции.

Совпадение количества строк

Оба значения TableClause.update() и TableClause.delete() связаны с количеством совпавших строк. Это число, указывающее количество строк, которые были сопоставлены с предложением WHERE. Обратите внимание, что под «совпавшими» подразумеваются строки, в которых UPDATE фактически не происходило. Значение доступно как CursorResult.rowcount:

>>> result = conn.execute(users.delete())
DELETE FROM users [...] () COMMIT
>>> result.rowcount 1

Дополнительная информация

Справочник по языку выражений: SQL Statements and Expressions API

Ссылка на метаданные базы данных: Описание баз данных с помощью метаданных

Ссылка на двигатель: Конфигурация двигателя

Ссылка на соединение: Работа с двигателями и соединениями

Ссылки на типы: Объекты типов данных SQL

Вернуться на верх