ДокументацияБлок 2: данные
Создайте приложение для заметок с помощью Nexy, часть 5: сохраните заметки в SQLite
Часть 5 перемещает заметки из словаря Python в базу данных SQLite с моделью, миграцией и двумя заметками для начала, и страницы считывают их оттуда.
Прежде чем начать: приложение из части 4.
Установите ORM и инструмент миграции.
uv add sqlmodel alembicSQLModel описывает таблицу как класс Python, а Alembic превращает изменения в этих классах в миграции. Nexy тоже не наворачивает: пользуешься ими как есть.
Открыть базу данных
Адрес базы данных находится в .env в корне проекта. nx migrate и приложение прочитали его оттуда:
DATABASE_URL=sqlite:///dev.dbsqlite:///dev.db — это файл, dev.db, следующий за nexyconfig.py: SQLite не нуждается в сервере. Не допускайте использования .env в Git: он хранит секреты реальной базы данных.
Движок — это соединение с базой данных. Он читает DATABASE_URL с тем же файлом, что и по умолчанию, когда переменная не установлена:
import os from dotenv import load_dotenvfrom sqlmodel import create_engine load_dotenv() engine = create_engine(os.getenv("DATABASE_URL", "sqlite:///dev.db"))Описать заметку
from sqlmodel import Field, SQLModel class Note(SQLModel, table=True): id: int | None = Field(default=None, primary_key=True) text: strМодель живет вместе с функцией, которой она принадлежит, рядом с ее контроллером:
from sqlmodel import Field, SQLModel class Note(SQLModel, table=True): id: int | None = Field(default=None, primary_key=True) text: strtable=True превращает класс в таблицу, note. id предоставляется базой данных при сохранении заметки.
Создайте таблицу с миграцией
nx migrate --initnx migrate -m "create notes"nx migrate --upgrade--init записывает папку alembic/ и указывает на вашу модель. -m сравнивает модель с базой данных и записывает миграцию, создающую таблицу; --upgrade запускает его. Измените модель позже, снова запустите последние две команды, и таблица будет следовать.
Прочитать заметки из базы данных
Функции src/notes.py сохраняют свои имена, поэтому страницы меняются мало: теперь они открывают сеанс, запрашивают таблицу и возвращают объекты Note вместо строк.
from sqlmodel import Session, select from src.configs.db import enginefrom src.models.note_model import Note def all_notes() -> list[Note]: with Session(engine) as session: return list(session.exec(select(Note).order_by(Note.id))) def find(note_id: int) -> Note | None: with Session(engine) as session: return session.get(Note, note_id)from sqlmodel import Session, select from src.apps.notes.note_model import Notefrom src.configs.db import engine def all_notes() -> list[Note]: with Session(engine) as session: return list(session.exec(select(Note).order_by(Note.id))) def find(note_id: int) -> Note | None: with Session(engine) as session: return session.get(Note, note_id)Добавьте две заметки для начала
Начальный скрипт заполняет пустую базу данных, поэтому каждая новая копия проекта начинается с чего-то, что можно показать:
from sqlmodel import Session, select from src.configs.db import enginefrom src.models.note_model import Note def seed() -> None: with Session(engine) as session: if session.exec(select(Note)).first() is None: session.add_all([Note(text="Buy milk"), Note(text="Ship Nexy")]) session.commit() if __name__ == "__main__": seed()from sqlmodel import Session, select from src.apps.notes.note_model import Notefrom src.configs.db import engine def seed() -> None: with Session(engine) as session: if session.exec(select(Note)).first() is None: session.add_all([Note(text="Buy milk"), Note(text="Ship Nexy")]) session.commit() if __name__ == "__main__": seed()python -m src.seedПри запуске Nexy импортирует каждый модуль из src/, чтобы найти действия из части 6. if __name__ == "__main__": сохраняет начальное значение для приведенной выше команды: импортированный приложением файл определяет только seed и ничего не затрагивает.
Показать заметки из базы данных
from "@/components/NoteCard.nexy" import NoteCardfrom src.notes import all_notes notes = all_notes()<section class="app-page"> <h1>Notes</h1> {% for note in notes %} <NoteCard id="{{ note.id }}" text="{{ note.text }}" /> {% endfor %}</section>from nexy import notFoundfrom src.notes import find id: prop[int]note = find(id)if note is None: notFound()<section class="app-page"> <h1>{{ note.text }}</h1> <a href="/notes">All notes</a></section>from src.notes import all_notes async def GET(): return [note.model_dump() for note in all_notes()]from "@/components/NoteCard.nexy" import NoteCardfrom src.notes import all_notes notes = all_notes()<section class="app-page"> <h1>Notes</h1> {% for note in notes %} <NoteCard id="{{ note.id }}" text="{{ note.text }}" /> {% endfor %}</section>from nexy import notFoundfrom nexy.decorators import Controllerfrom nexy.hooks import useViewsfrom src.notes import all_notes, find LAYOUT = "src/apps/layout.nexy" def page(view: str, **context: object): return useViews(LAYOUT, context={"children": useViews(view, context=context)}) @Controller("/notes")class NotesController: async def get(self): return page("src/apps/notes/notes_view.nexy") @Controller("/notes/{id}")class NoteController: async def get(self, id: int): note = find(id) if note is None: notFound() return page("src/apps/notes/note_view.nexy", text=note.text) @Controller("/api/notes")class NotesApiController: async def get(self) -> list[dict]: return [note.model_dump() for note in all_notes()]Открыть http://localhost:3000/notes: те же две карты, теперь прочитанные из dev.db. Перезапустите nexy dev, и они все еще там.
Что вы узнали
- SQLModel описывает таблицу как класс; движок в
src/configs/db.pyоткрывает базу данных. nx migrateзаписывает и запускает миграции:--initодин раз, затем-mи--upgradeдля каждого изменения.- Страницы и контроллеры вызывают простые Python функции, которые запрашивают базу данных: Nexy не добавляет никаких слоев.
Следующие шаги
- Часть 6: создайте заметку из формы
- SQLite: прагмы, асинхронный доступ и тесты в базе данных в памяти.