Выполнить SQL-запрос и получить таблицу

Описание

Блок выполняет SQL-запрос по ранее созданному подключению и возвращает результат таблицей (DataFrame) с именами колонок из запроса.

Ограничение

Блок принимает только запросы, возвращающие строки (SELECT).

Требования

Требования для работы блока:

• подключение создано блоком Создать подключение к базе данных;
• тип базы данных — PostgreSQL, MySQL, Oracle, SQLite или MSSQL.

Подключение к MongoDB блоком не поддерживается: для него используется блок Выполнить запрос к MongoDB.

---

Описание параметров

Блок имеет ряд параметров:

1. Использовать подключение — переменная с подключением к базе данных, созданным блоком Создать подключение к базе данных;

   Тип данных: variable (Переменная)

   Пример: db_session

2. Запрос — текст SQL-запроса. Обычно подставляется блоком Редактор SQL;

   Тип данных: str (Строка)

   Пример: SELECT id, name, amount FROM sales

3. Параметры запроса — значения, которые подставляются вместо плейсхолдеров в тексте запроса. Значения передаются драйверу базы данных отдельно от текста запроса, поэтому кавычки и служебные символы внутри них не могут изменить смысл запроса. Если параметров нет, оставляется значение null.

   Тип данных: list (Список) | dict (Словарь)

   Пример: [2]

Примечание

Вид плейсхолдера задаёт сама СУБД:

База данных	Плейсхолдер	Пример запроса	Что передать в параметры
PostgreSQL	%s	SELECT * FROM sales WHERE id = %s	список [2]
MySQL	%s	SELECT * FROM sales WHERE id = %s	список [2]
SQLite	?	SELECT * FROM sales WHERE id = ?	список [2]
MSSQL	?	SELECT * FROM sales WHERE id = ?	список [2]
Oracle	:имя	SELECT * FROM sales WHERE id = :id	словарь {"id": 2}

---

Возвращаемое значение

Таблица (DataFrame) со строками результата и именами колонок из запроса. Если запрос не нашёл ни одной строки, возвращается пустая таблица с колонками из запроса.

Тип данных: DataFrame

Пример: sql_table

Примечание

Oracle возвращает имена колонок в верхнем регистре: запрос SELECT id, name FROM sales даст колонки ID и NAME, и в блоках категории «Табличных данных» их требуется указывать именно так. Чтобы сохранить исходный регистр, имя колонки берётся в двойные кавычки в самом запросе: SELECT id AS "id", name AS "name" FROM sales.

---

Пример использования

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

1. Блоком Создать подключение к базе данных создаётся подключение и сохраняется в переменную db_session;
2. Добавляется блок Выполнить SQL-запрос и получить таблицу, в нём выбирается переменная db_session;
3. В поле Запрос подставляется блок Редактор SQL с текстом SELECT id, LastName, Email FROM Employees WHERE LastName = ?;;
4. В поле Параметры запроса передаётся список с одним элементом — Петров;
5. Результат сохраняется в переменную sql_table;
6. Подключение закрывается блоком Закрыть подключение к базе данных.

Результат

В переменной sql_table — таблица с колонками id, LastName и Email, готовая к обработке блоками категории «Табличных данных»: