banksDb Backend api

BanksDB API

API для поиска индийских банков или филиалов.

---

Технический стек

1. Джанго
2. Django Rest Framework
3. Postgresdb
4. Redis (для кэширования)

Функции

1. Полный текстовый поиск
2. Индексы Postgres (для более быстрых запросов никто не ненавидит индексы)
3. Кэширование (вы знаете, почему)
4. Постгресс триггеры
5. Страница (ваш клиент (фронт) полюбил бы вас за это)

---

Проект использует собственные полные текстовые фей, предоставленные PostgreSQL. Есть два типа полного текстового поиска

1. Использование __search (от django) для поиска в отдельном столбце.
2. Используя рейтинг поиска, поиск вектора и поиск запроса.

Второй полный текстовый поиск оценивает результаты на основе ранга, предоставленного Postgres для каждого результата. Больше звания выше, результат будет в результате.

Для оптимизации поисковых запросов я использовал индексы GIN через столбец поиска. Это заставило мои запросы работать в 2 раза быстрее. Это просто создать индекс джина.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

В соответствии с Postgres Docs индексы джина в 2-3 раза быстрее, чем другие индексы, доступные в Postgres (GIST и BTREE), но использует больше места.
Также я добавил триггер в DB, ​​который автоматически генерирует вещатель поиска на любом запросе вставки или обновления

---

Использование приложения

1. Установить переменные среды в файле .env в корне проекта

 SECRET_KEY
DB_NAME
DB_HOST
DB_USER
DB_PASSWORD
REDIS_HOST
REDIS_PASSWORD
DEBUG

2. Добавьте данные в свою базу данных, получите данные отсюда

psql psql -h DB_HOST -p DB_PORT -U DB_USER -d DB_NAME -f FILENAME.sql

Вы можете получить файл SQL из вышеуказанного репо

3. Мигрировать DB (скрестные пальцы ??)

 python mange.py makemigrations
python manage.py migrate

4. Запустите сервер

 python manage.py runserver

5. Запустить тест (необязательно)

 python manage.py test

Настройка локального экземпляра Postgres для тестирования и добавить учетные данные в настройках.py

---

Конечные точки

1. /api/branches/autocomplete/? q = <search_tern> & offset = <page_number> & limit = <page_size>
   Автозаполнение конечная точка, поиск по столбцу ветви в таблице ветвей и возвращает результат.

2. /api/branches/search/? q = <search_term> & city = <tity_name> & offset = <page_number> & limit = <page_size>
   Поиск всех столбцов БД в таблице Бракнес в данном городе с данным поисковым термином.

3. /api/banks/: id
   Возвращает банк с удостоверением личности: удостоверение личности из таблицы банков.

---

Развертывание

Freebie Stuff ?? ‍♀? ‍♀

1. Heroku (бесплатный, развернутый проект Django там)
2. Умное облако (бесплатно Postgres Add On)
3. Redis Labs Redis Cloud (бесплатный экземпляр Redis)

Все это включено в AWS Free Tier, но я не хочу делиться информацией о своей карте? (У меня нет карты?).

---

Известные проблемы

1. Частичный поиск слова Postgres Полный текстовый поиск - это OP ❤, но он не очень хорошо работает с частичными словами. Например, не даст результата для EAS, но даст результаты для Востока.
   Решение Используйте что -то, как Elasticsearch для полного текстового поиска или пути, или напишите немного пользовательского плагина для использования Postgres FTS для частичных слов.

---

Улучшения

1. Добавьте документы API (может быть, чванство), из -за временных ограничений я рассматриваю это как будущую работу.

---

Заключительные слова

Мне очень понравилось создавать этот проект и у меня есть новые вещи, создавая его.

PS сегодня (21 мая, 2021 год) - это мой бит -день?