В этом уроке мы научимся подключаться к базе данных PostgreSQL с помощью SQLAlchemy. Мы создадим соединение, настроим параметры подключения и убедимся, что наше приложение успешно взаимодействует с базой данных.

Навигация по статье

Основные компоненты подключения

Для успешного подключения к базе данных PostgreSQL нам потребуются следующие компоненты:

Engine: основной объект для управления соединением с базой данных.
Connection string: строка подключения, содержащая всю необходимую информацию для подключения к базе данных (пользователь, пароль, хост, порт, имя базы данных).
Session: объект для управления транзакциями и взаимодействием с базой данных.

Подготовка к работе

Перед началом работы убедитесь, что у вас установлен SQLAlchemy и psycopg2 (адаптер PostgreSQL для Python). Если они еще не установлены, выполните следующую команду:

pip install sqlalchemy psycopg2-binary

Создание проекта

Создайте новый каталог для проекта и перейдите в него:

mkdir sqlalchemy_connect
cd sqlalchemy_connect

Создайте файл main.py и откройте его в любом текстовом редакторе.

Настройка подключения

Шаг 1: Импорт необходимых модулей

В файле main.py импортируйте необходимые модули:

from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker

Шаг 2: Создание строки подключения

Строка подключения содержит информацию о базе данных, к которой мы будем подключаться. Формат строки подключения для PostgreSQL следующий:

postgresql+psycopg2://<username>:<password>@<host>:<port>/<database>

Замените <username>, <password>, <host>, <port>, <database> на реальные значения вашей базы данных.

Пример строки подключения:

DATABASE_URL = 'postgresql+psycopg2://postgres:yourpassword@localhost:5432/mydatabase'

Шаг 3: Создание объекта Engine

Engine — это основной интерфейс для подключения к базе данных. Создайте объект Engine, используя строку подключения:

engine = create_engine(DATABASE_URL)

Шаг 4: Создание сессии

Session управляет транзакциями и взаимодействием с базой данных. Создайте объект Session:

Session = sessionmaker(bind=engine)
session = Session()

Шаг 5: Проверка подключения

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

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String

# Создание базового класса для моделей
Base = declarative_base()

# Определение модели User
class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True, autoincrement=True)
    name = Column(String, nullable=False)
    age = Column(Integer, nullable=False)

# Создание всех таблиц в базе данных
Base.metadata.create_all(engine)

# Добавление нового пользователя в базу данных
new_user = User(name='John Doe', age=30)
session.add(new_user)
session.commit()

# Закрытие сессии
session.close()

Шаг 6: Выполнение кода

Запустите main.py, чтобы проверить, что все работает:

python main.py

Объяснение кода

Импорт модулей: мы импортируем необходимые модули из SQLAlchemy.
Строка подключения: мы создаем строку подключения, содержащую данные для подключения к PostgreSQL.
Engine: создаем объект Engine, который будет управлять соединением с базой данных.
Session: создаем объект Session для управления транзакциями и взаимодействием с базой данных.
Base и модели: создаем базовый класс для моделей и определяем модель User.
Создание таблиц: создаем таблицу users в базе данных, если она еще не существует.
Добавление данных: добавляем нового пользователя в таблицу и сохраняем изменения в базе данных.
Закрытие сессии: закрываем сессию, когда она больше не нужна.

Заключение

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

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