banksDb Backend api

API BANKSDB

API pour rechercher des banques ou des succursales indiennes.

---

Pile technologique

1. Django
2. Framework Django Rest
3. Postgresdb
4. Redis (pour la mise en cache)

Caractéristiques

1. Recherche en texte intégral
2. Index Postgres (pour des requêtes plus rapides, personne ne déteste les index)
3. Mise en cache (vous savez pourquoi)
4. Postgres déclenche
5. Pagination (votre client (frontend) vous aimerait pour ça)

---

Le projet utilise des faetures en texte intégral natif fourni par PostgreSQL. Il existe deux types de recherche de texte intégral

1. Utilisation de __Search (par django) pour la recherche sur une seule colonne.
2. Utilisation du classement de recherche, du vecteur de recherche et de la requête de recherche.

La deuxième recherche en texte intégral classe les résultats sur la base du rang fourni par Postgres pour chaque résultat. Le rang est élevé, le résultat sera élevé.

Pour optimiser les requêtes de recherche, j'ai utilisé des index de gin sur la colonne de recherche. Cela a fait fonctionner mes requêtes 2x plus rapidement. Il est simple de créer un index du gin.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

Selon Postgres, les index DOCS Gin sont 2 à 3x plus rapidement que les autres index disponibles dans Postgres (Gist et Btree) mais utilisent plus d'espace.
J'ai également ajouté un déclencheur à DB qui générera automatiquement un vetor de recherche sur toute requête d'insertion ou de mise à jour

---

En utilisant l'application

1. Définir les variables d'environnement dans un fichier .env dans Root du projet

 SECRET_KEY
DB_NAME
DB_HOST
DB_USER
DB_PASSWORD
REDIS_HOST
REDIS_PASSWORD
DEBUG

2. Ajoutez des données à votre base de données, obtenez des données à partir d'ici

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

Vous pouvez obtenir le fichier SQL à partir du repo ci-dessus

3. Migrer db (doigts croisés ??)

 python mange.py makemigrations
python manage.py migrate

4. Exécuter le serveur

 python manage.py runserver

5. Exécuter le test (facultatif)

 python manage.py test

Configurer une instance Postgres locale pour les tests et ajouter les informations d'identification dans Settings.py

---

Points de terminaison

1. / api / branches / AutoChyPle't /? Q = <echarch_tern> & offset = <page_number> & limite = <page_size>
   Point de terminaison de la saisie semi-automatique, recherche la colonne de branche de la table des branches et renvoie le résultat.

2. / api / branches / search /? q = <echarch_term> & city = <ity_name> & offset = <page_number> & limite = <page_size>
   Recherche toutes les colonnes DB dans la table Bracnes dans la ville donnée avec le terme de recherche donné.

3. / API / Banks /: ID
   Renvoie la banque avec ID: ID de la table des banques.

---

Déploiement

Freebie Stuff ?? ‍♀️? ‍♀️

1. Heroku (projet Django gratuit et déployé)
2. Cloud intelligent (Postgres gratuit ajouter)
3. Redis Labs Redis Cloud (instance redis gratuite)

Toutes ces choses sont incluses dans AWS Free Tier mais je ne veux pas partager les détails de ma carte? (Je n'ai pas de carte?).

---

Problèmes connus

1. Recherche de mots partielle Postgres La recherche de texte intégral est op ❤️‍ mais elle ne fonctionne pas bien avec des mots partiels. EG ne donnera aucun résultat pour EAS mais donnera des résultats pour l'Est.
   Solution Utilisez quelque chose à avancer comme Elasticsearch pour une recherche de texte intégral ou un chemin ou écrire un plugin personnalisé pour tirer parti de Postgres FTS pour des mots partiels.

---

Améliorations

1. Ajoutez des documents API (peut-être Swagger), en raison de contraintes de temps que je considère comme un travail futur.

---

Mots de clôture

J'ai vraiment apprécié la création de ce projet et apprend beaucoup de nouvelles choses tout en la créant.

PS Aujourd'hui (21 mai 2021) est mon bithday?