banksDb Backend api

API BANKSDB

API para pesquisar bancos ou agências indianas.

---

Pilha de tecnologia

1. Django
2. Django Rest Framework
3. PostGresdb
4. Redis (para armazenamento em cache)

Características

1. Pesquisa completa de texto
2. Índices Postgres (para consultas mais rápidas, ninguém odeia índices)
3. Armazenamento em cache (você sabe o porquê)
4. Postgres gatilhos
5. Paginação (seu cliente (front -end) te amaria por isso)

---

O projeto usa Faetures de texto completo nativo fornecidos pelo PostgreSQL. Existem dois tipos de pesquisa completa de texto

1. Usando __search (por Django) para pesquisar em uma única coluna.
2. Usando a classificação de pesquisa, o vetor de pesquisa e a consulta de pesquisa.

A segunda pesquisa de texto completa classifica os resultados com base na classificação fornecida pelo Postgres para cada resultado. Maior a classificação mais alta O resultado estará em resultado.

Para otimizar as consultas de pesquisa, usei índices de gin na coluna de pesquisa. Isso fez minhas consultas funcionarem 2x mais rápido. É simples criar um índice de gin.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

De acordo com os índices de Gin Docs Postgres, são 2-3x mais rápido que outros índices disponíveis no Postgres (GIST e BTREE), mas usa mais espaço.
Também adicionei um gatilho ao dB que gerará automaticamente um vetor de pesquisa em qualquer consulta de inserção ou atualização

---

Usando o aplicativo

1. Defina variáveis ​​de ambiente em um arquivo .env na raiz do projeto

 SECRET_KEY
DB_NAME
DB_HOST
DB_USER
DB_PASSWORD
REDIS_HOST
REDIS_PASSWORD
DEBUG

2. Adicione dados ao seu banco de dados, obtenha dados daqui

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

Você pode obter o arquivo SQL do repositório acima

3. Migrar db (dedos cruzados ??)

 python mange.py makemigrations
python manage.py migrate

4. Execute o servidor

 python manage.py runserver

5. Executar teste (opcional)

 python manage.py test

Configure uma instância local do PostGres para testar e adicione as credenciais em setents.py

---

Pontos de extremidade

1. /API/Branches/AutoComplete/? q = <search_tern> & offset = <Page_number> & limite = <Page_Size>
   Endpoint de preenchimento automático, pesquisa na tabela de ramificações da coluna de filiais e retorna o resultado.

2. /API/Branches/Search/? Q = <search_term> & city = <city_name> & offset = <Page_number> & limite = <Page_Size>
   Pesquisa todas as colunas do banco de dados na tabela Bracnes na cidade especificada com o termo de pesquisa fornecido.

3. /API/BANKS/: ID
   Retorna o banco com ID: ID da tabela Banks.

---

Implantação

FreeBie Stuff ?? ‍♀️? ‍♀️

1. Heroku (projeto de django livre e gratuito lá)
2. Cloud Clever (adição de pós -gros grátis)
3. Redis Labs Redis Cloud (instância de redis grátis)

Todas essas coisas estão incluídas no AWS Free Tier, mas não quero compartilhar os detalhes do meu cartão? (Eu não tenho um cartão?).

---

Questões conhecidas

1. Pesquisa parcial de palavras PostGres A pesquisa de texto completa é op ❤️‍, mas não tem um bom desempenho com palavras parciais. Por exemplo, não dará nenhum resultado para o EAS, mas dará resultados para o leste.
   Solução Use algo Advance como Elasticsearch para pesquisa ou caminho de texto completo ou escreva algum plug -in personalizado para aproveitar o PostGres FTS para palavras parciais.

---

Melhorias

1. Adicione os documentos da API (talvez arrogância), devido a restrições de tempo, estou considerando isso como trabalho futuro.

---

Palavras de encerramento

Eu realmente gostei de criar esse projeto e aprender muitas coisas novas enquanto o criava.

PS Hoje (21 de maio de 2021) é o meu dia?