Проект предназначен для реализации полнотекстового поиска в PostgresSQL c использованием FastAPI и SQLAlchemy.

В качестве примера в проекте создаётся таблица posts с постами различных категорий. Полнотекстовый поиск реализован за счёт создания индекса на поле search_vector типа TSVECTOR, значение которого обновляется при добавлении записи в таблицу posts или обновлении текста в поле content у существующей записи с помощью триггера на стороне БД.

1. Установить uv.

2. Клонировать проект:

git clone git@github.com:chrnmaxim/fts_fastapi.git

3. Перейти в корневую директорию проекта.

4. Установить зависимости, включая зависимости для разработки:

uv sync --extra dev

5. Создать .env на основании .env.example:

cp -r src/.env.example src/.env

6. Запустить API и PostgreSQL в Docker контейнерах:

make start_dev

7. Применить миграции:

docker compose exec fts_fastapi alembic upgrade heads

8. Документация API и доступные эндпоинт:

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc

9. Для остановки контейнеров выполнить

make stop_dev

1. Перед запуском тестов необходимо создать .env.test на основе.env.test.example:

cp -r src/.env.test.example src/.env.test

2. Тесты запускаются из независимой базы данных Postgres с помощью команды make test.

3. После выполнения тестов в файле htmlcov/index.html можно увидеть отчет о покрытии кода тестами.