Справочник SQLAlchemy

Класс Session

работа с объектами добавить объект добавить несколько объектов пометить на удаление вставить или обновить найти по ключу найти или ошибка выполнить запрос список значений одно значение ровно одно значение значение или пусто ровно один объект объект или пусто первый объект зафиксировать изменения отменить изменения отправить в базу перечитать из базы сбросить кэш объекта сбросить кэш всех убрать из сессии убрать все объекты закрыть сессию начать транзакцию вложенная транзакция текущая транзакция текущая вложенная проверяет изменения выбрать движок взять соединение сбросить соединение временно без автозаписи новые объекты изменённые объекты объекты на удаление кэш объектов сессия работает автозапись включена режим автофиксации сбрасывать после фиксации привязанный движок пользовательские данные

Класс sessionmaker

фабрика сессий открыть с транзакцией настроить фабрику создать сессию

Класс scoped_session

сессия потока забыть сессию настроить фабрику получить старый запрос

Класс SessionTransaction

идущая транзакция зафиксировать изменения отменить изменения закрыть транзакцию

Функции

собрать выборку собрать вставку собрать обновление собрать удаление проверить наличие набор констант объединить выборки объединить с дублями вычесть выборку вычесть с дублями общие строки общие с дублями псевдоним сущности полиморфная выборка

Класс Select

запрос выборки задать условие фильтр по условию фильтр по полям присоединить таблицу соединить две таблицы левое соединение задать сортировку сгруппировать строки фильтр групп ограничить число пропустить строки взять первые строки срез строк убрать дубли настроить загрузку параметры выполнения заблокировать строки именованный подзапрос сделать подзапросом боковой подзапрос дать псевдоним учесть внешний запрос кроме внешнего запроса объединить выборки объединить с дублями добавить колонки оставить только колонки указать источник подсказка оптимизатору текст перед запросом текст после запроса запрос из текста проверка существования убрать лишние колонки стиль имён колонок

Класс Insert

запрос вставки задать значения вернуть вставленное вписать значения сразу вставить из выборки текст перед вставкой параметры выполнения

Класс Update

запрос обновления задать новые значения задать условие вернуть обновлённое значения по порядку параметры выполнения

Класс Delete

запрос удаления задать условие вернуть удалённое параметры выполнения

Класс Query

старый запрос все объекты первый объект ровно один объект один или пусто одно значение число объектов найти по ключу фильтр по условию фильтр по полям задать сортировку ограничить число пропустить строки присоединить таблицу левое соединение сгруппировать строки фильтр групп убрать дубли выбрать колонки заблокировать строки настроить загрузку удалить строки обновить строки объединить выборки обернуть подзапросом сделать подзапросом именованный подзапрос жадная загрузка обновить загруженные читать порциями

Функции

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

Класс ColumnElement

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

Функции

сессия объекта отвязать от базы оставить отсоединённым закрыть все сессии поле модели создать базу моделей вычисляемое поле проверить поле после загрузки сделать декларативным примесь модели поле из выражения составное поле второе имя отложенная колонка поле из запроса декоратор поля

Класс DeclarativeBase

база моделей имя таблицы параметры таблицы параметры маппера готовая таблица

Класс MappedAsDataclass

модель как датакласс

Класс Mapped

тип поля

Класс registry

реестр моделей собрать мапперы привязать вручную создать базовый класс дополнить типы список мапперов метаданные реестра типы аннотаций

Класс Mapper

карта класса дособрать связи найти свойство обойти свойства колонки маппера колонки коротко все атрибуты связи маппера первичный ключ колонка типа значение типа класс модели своя таблица таблица записи

Функции

связать модели обратная связь внешняя сторона дальняя сторона прокси связи загрузка отдельным запросом загрузка соединением загрузка подзапросом загрузка при доступе не загружать ошибка при доступе загрузить сразу использовать соединение загрузка по умолчанию отложить колонку загрузить отложенное загрузить группу только эти колонки типы отдельным запросом подставить выражение фильтр загрузки

Класс hybrid_method

метод в запросе

Значения

стратегия при доступе стратегия соединением стратегия подзапросом стратегия отдельным запросом стратегия с ошибкой стратегия без загрузки стратегия сразу стратегия только запись стратегия как запрос

Класс hybrid_property

свойство в запросе значение в объекте записать значение удалить значение выражение в запросе выражение обновления сравнение в запросе

Типы

короткая строка длинный текст целое число логическое значение дата и время только дата объект JSON общий идентификатор дробное число точное дробное только время двоичные данные набор вариантов большое целое малое целое юникод строка юникод текст промежуток времени массив значений объект Python десятичное число переменная строка фиксированная строка логическое в SQL целое в SQL метка времени большой двоичный большой текстовый низкая точность двойная точность повышенная точность точное число SQL идентификатор Postgres двоичный JSON сетевой адрес диапазон адресов словарь пар строк перечисление Postgres

Класс TypeDecorator

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

Класс TypeEngine

основа всех типов тип для диалекта общий вид типа сравнить с базой в текст SQL копия типа тип в Python

Класс Result

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

Класс ScalarResult

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

Класс Row

строка результата превратить в словарь доступ как словарь имена полей доступ как кортеж

Класс ForeignKeyConstraint

составной внешний ключ

Класс PrimaryKeyConstraint

составной первичный ключ

Класс UniqueConstraint

уникальность полей

Класс CheckConstraint

проверка значения

Класс Constraint

базовое ограничение

Класс Identity

автосчётчик колонки

Класс Computed

вычисляемая колонка

Класс FetchedValue

значение с сервера

Класс CreateTable

команда создания таблицы

Класс DropTable

команда удаления таблицы

Класс Table

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

Класс Column

описание колонки копия колонки ссылается на колонку добавить внешний ключ ключ атрибута имя в базе тип значения родительская таблица допускает пустое входит в ключ значение по умолчанию значение на сервере значение при обновлении строить индекс значения уникальны комментарий колонки расти автоматически

Класс MetaData

каталог таблиц создать все таблицы удалить все таблицы прочитать из базы очистить каталог убрать таблицу таблицы по имени порядок создания схема по умолчанию шаблон имён

Класс ForeignKey

ссылка на колонку проверяет ссылку находит цель целевая колонка колонка владелец действие при удалении действие при обновлении имя ограничения

Класс Index

описание индекса создать индекс удалить индекс

Класс Sequence

генератор номеров взять следующий номер создать генератор удалить генератор имя генератора стартовый номер шаг увеличения схема генератора

Функции

создать движок движок из настроек разобрать адрес пул по адресу

Класс MappingResult

строки как словари

Класс QueuePool

очередь соединений

Класс NullPool

новое каждый раз

Класс StaticPool

всегда одно соединение

Класс SingletonThreadPool

соединение на поток

Класс Engine

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

Класс Connection

активное соединение выполнить запрос запрос напрямую драйверу одно значение список значений зафиксировать изменения отменить изменения начать транзакцию вложенная транзакция закрыть соединение пометить негодным забрать соединение параметры выполнения уровень изоляции идёт транзакция соединение закрыто соединение негодное движок соединения диалект соединения пользовательские данные

Класс URL

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

Класс Pool

хранилище соединений взять соединение закрыть соединения пересоздать пул состояние пула

Функции

создать асинхронный движок сессия текущей задачи

Класс AsyncAttrs

ожидание атрибутов

Класс AsyncSession

асинхронная сессия выполнить запрос список значений одно значение найти по ключу найти или ошибка добавить объект добавить несколько объектов пометить на удаление вставить или обновить отправить в базу перечитать из базы зафиксировать изменения отменить изменения закрыть сессию начать транзакцию вложенная транзакция поток строк поток значений выполнить синхронно текущая транзакция сбросить кэш объекта сбросить кэш всех убрать из сессии убрать все объекты обычная сессия привязанный движок пользовательские данные кэш объектов

Класс async_sessionmaker

фабрика сессий открыть с транзакцией настроить фабрику

Класс AsyncEngine

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

Класс AsyncConnection

асинхронное соединение выполнить запрос поток строк поток значений одно значение список значений зафиксировать изменения отменить изменения начать транзакцию закрыть соединение выполнить синхронно запрос напрямую драйверу

Функции

декоратор подписки подписать обработчик снять обработчик обработчик уже есть

События

перед вставкой после вставки перед обновлением после обновления перед удалением после удаления перед записью после записи после выполнения SQL перед фиксацией после фиксации после отката после тихого отката после старта транзакции после присоединения после массового обновления после массового удаления перед отправкой запроса после отправки запроса перехват ошибки движок подключился соединение выдали соединение вернули создали соединение первое подключение объект прочитан объект обновлён данные сброшены объект создаётся создание не удалось при добавлении объекта до настройки моделей после настройки моделей

Функции

исследовать объект получить состояние ключ идентичности

Класс InstanceState

служебное состояние чья сессия ключ идентичности вне сессии ждёт записи лежит в базе будет удалён оторван от сессии не менялся нужно перечитать удаляли раньше сам экземпляр класс экземпляра его маппер словарь атрибутов непрочитанные поля изменённые поля

Класс Inspector

чтение схемы список таблиц колонки одной таблицы ключ таблицы связи таблицы индексы одной таблицы уникальные правила проверочные правила список представлений текст представления список схем таблица существует счётчик существует индекс существует схема существует список счётчиков комментарий таблицы порядок по связям загрузить таблицу колонки сразу всех список матпредставлений какой движок какой диалект основная схема

Исключения

любая ошибка библиотеки ошибка драйвера базы нарушение целостности сбой при работе ошибка в запросе плохие данные сбой интерфейса сбой внутри базы операция недоступна неправильный вызов неправильный аргумент не собрался запрос связь оборвалась время вышло круговая зависимость не удалось записать конфликт версий объект уже удалён объект без сессии это не модель класс не модель ничего не нашли нашли несколько строк колонки не существует целевой таблицы нет связи не нашли неясно какая связь недопустимое имя такой SQL нельзя сбой выражения уже закрыли ресурс сначала нужен откат