banksDb Backend api

API de Banksdb

API para buscar bancos o sucursales indias.

---

Pila de tecnología

1. Django
2. Marco de descanso django
3. Postgresdb
4. Redis (para almacenar en caché)

Características

1. Búsqueda de texto completo
2. Índices Postgres (para consultas más rápidas, nadie odia los índices)
3. Almacenamiento en caché (ya sabes por qué)
4. Postgres disparadores
5. Pagination (su cliente (frontend) te amaría por esto)

---

El proyecto utiliza las fiestas nativas de texto completo proporcionados por PostgreSQL. Hay dos tipos de búsqueda de texto completo

1. Usando __search (por Django) para buscar en una sola columna.
2. Uso de clasificación de búsqueda, vector de búsqueda y consulta de búsqueda.

La segunda búsqueda de texto completo clasifica los resultados sobre la base del rango proporcionado por Postgres para cada resultado. Mayor el rango más alto El resultado será en el resultado.

Para optimizar consultas de búsqueda, he utilizado índices de ginebra en la columna de búsqueda. Esto hizo que mis consultas corrieran 2 veces más rápido. Es simple crear un índice de ginebra.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

Según los índices de ginebra de los documentos de Postgres son 2-3x más rápidos que otros índices disponibles en Postgres (GIST y BTree), pero usa más espacio.
También agregué un disparador a DB que generará automáticamente un vetor de búsqueda en cualquier consulta de inserción o actualización

---

Usando la aplicación

1. Establecer variables de entorno en un archivo .env en el proyecto root

 SECRET_KEY
DB_NAME
DB_HOST
DB_USER
DB_PASSWORD
REDIS_HOST
REDIS_PASSWORD
DEBUG

2. Agregue datos a su base de datos, obtenga datos desde aquí

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

Puede obtener el archivo SQL del repositorio anterior

3. Migra db (dedos cruzados?)

 python mange.py makemigrations
python manage.py migrate

4. Ejecutar el servidor

 python manage.py runserver

5. Ejecutar la prueba (opcional)

 python manage.py test

Configurar una instancia local de Postgres para probar y agregar las credenciales en settings.py

---

Puntos finales

1. /API/RAMES/AUTOCOMPLETE/? Q = <SARCH_ERN> & OFFSET = <Pag_Number> & Limit = <page_size>
   El punto final autocompletado, busca la columna de ramas de la tabla de ramas y devuelve el resultado.

2. /api/ramas/search/? q = <sing_term> & city = <city_name> & offset = <page_number> & limit = <page_size>
   Busca todas las columnas de DB en la tabla Bracnes en la ciudad dada con el término de búsqueda dado.

3. /API/Banks/: ID
   Banco de devoluciones con ID: ID de la tabla Banks.

---

Despliegue

¿Cosas de Freebie?

1. Heroku (proyecto Django gratuito, desplegado allí)
2. Cloud inteligente (Postgres Postgres gratis)
3. Redis Labs Redis Cloud (instancia gratuita de Redis)

Todas estas cosas están incluidas en el nivel gratuito de AWS, pero ¿no quiero compartir los detalles de mi tarjeta? (¿No tengo una tarjeta?).

---

Problemas conocidos

1. Búsqueda de palabras parcial La búsqueda de texto completo es OP ❤️‍ Pero no funciona bien con palabras parciales. Por ejemplo, no dará ningún resultado para EAS, pero dará resultados para East.
   Solución Use algo avanzado como ElasticSearch para la búsqueda o ruta de texto completo o escriba algunos complementos personalizados para aprovechar los fts de Postgres para palabras parciales.

---

Mejoras

1. Agregue API Docs (tal vez Swagger), debido a limitaciones de tiempo, estoy considerando esto como un trabajo futuro.

---

Palabras de cierre

Realmente disfruté creando este proyecto y Learend Lot de cosas nuevas mientras lo creaba.

PD hoy (21 de mayo de 2021) ¿Es mi bithday?