banksDb Backend api

BankSDB API

API는 인도 은행이나 지점을 검색합니다.

---

기술 스택

1. 장고
2. Django Rest 프레임 워크
3. postgresdb
4. Redis (캐싱 용)

특징

1. 전문 검색
2. Postgres Indexes (빠른 쿼리의 경우 아무도 인덱스를 싫어하지 않음)
3. 캐싱 (이유를 알고 있습니다)
4. Postgres 트리거
5. Pagination (고객 (Frontend)은 이것을 위해 당신을 사랑할 것입니다)

---

이 프로젝트는 PostgreSQL에서 제공하는 기본 전체 텍스트 faetures를 사용합니다. 전체 텍스트 검색에는 두 가지 유형이 있습니다

1. 단일 열에서 검색하기 위해 __search (django) 사용.
2. 검색 순위, 검색 벡터 및 검색 쿼리 사용

두 번째 전체 텍스트 검색은 각 결과에 대해 Postgres가 제공 한 순위를 기준으로 결과를 순위에 올립니다. 순위가 커지면 결과가 높아집니다.

검색 쿼리 최적화를 위해 검색 열에서 GIN 인덱스를 사용했습니다. 이로 인해 쿼리가 2 배 빠르게 실행되었습니다. 진 인덱스를 만드는 것은 간단합니다.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

Postgres에 따라 Docs Gin 인덱스는 Postgr (Gist 및 Btree)에서 사용 가능한 다른 인덱스보다 2-3 배 빠르지 만 더 많은 공간을 사용합니다.
또한 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 인스턴스를 설정하고 settings.py에서 자격 증명을 추가합니다.

---

엔드 포인트

1. /api/branch/autocomplete/? q = <search_onn> & offset = <page_number> & limit = <page_size>
   자동 완성 엔드 포인트, 분기 테이블의 분기 열을 검색하고 결과를 반환합니다.

2. /api/branch/search/? q = <search_term> & city = <city_name> & offset = <page_number> & limit = <page_size>
   주어진 도시의 Bracnes 테이블의 모든 DB 열을 주어진 검색 용어로 검색합니다.

3. /API/BANKS/: ID
   은행 테이블에서 ID : ID로 은행을 반환합니다.

---

전개

공짜 물건?

1. Heroku (무료, 배치 된 Django 프로젝트 거기)
2. Clever Cloud (무료 Postgres 추가)
3. Redis Labs Redis Cloud (무료 Redis 인스턴스)

이 모든 것들이 AWS Free Tier에 포함되어 있지만 카드 세부 정보를 공유하고 싶지 않습니까? (카드가 없습니까?).

---

알려진 문제

1. 부분 단어 검색 Postgres 전체 텍스트 검색은 OP ❤️‍이지만 부분 단어와 잘 어울리지 않습니다. EG는 EA에 대한 결과를 제공하지 않지만 East에 대한 결과를 제공합니다.
   솔루션은 전체 텍스트 검색 또는 경로를 위해 Elasticsearch와 같은 발전을 사용하거나 일부 사용자 정의 플러그인을 작성하여 Postgres FT를 부분적으로 사용하십시오.

---

개량

1. 시간 제약으로 인해 API 문서 (아마도 swagger)를 추가하십시오. 나는 이것을 향후 작업으로 고려하고 있습니다.

---

닫는 단어

나는이 프로젝트를 만들 면서이 프로젝트와 Learend Lot의 새로운 것들을 만드는 것을 정말 즐겼습니다.

추신 오늘 (2021 년 5 월 21 일)은 나의 bithday입니까?