banksDb Backend api

BanksDB API

インドの銀行または支店を検索するAPI。

---

技術スタック

1. Django
2. Django RESTフレームワーク
3. postgresdb
4. Redis（キャッシュ用）

特徴

1. 全文検索
2. ポストグレスインデックス（より速いクエリの場合、誰もインデックスを嫌うことはありません）
3. キャッシュ（あなたはその理由を知っています）
4. Postgresトリガー
5. ページネーション（あなたのクライアント（フロントエンド）はこれにあなたを愛しています）

---

このプロジェクトでは、PostgreSQLが提供するネイティブフルテキストの偽物を使用します。フルテキスト検索には2つのタイプがあります

1. __Search（Djangoによる）を使用して、単一の列で検索します。
2. 検索ランキングを使用して、検索ベクトルと検索クエリを使用します。

2番目のフルテキスト検索では、各結果に対してPostgresが提供するランクに基づいて結果をランク付けします。ランクが大きいほど結果が得られます。

検索クエリを最適化するために、検索列でGINインデックスを使用しました。これにより、クエリが2倍高速に動作しました。 GINインデックスを作成するのは簡単です。

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

Postgresによると、GINインデックスは、Postgres（GISTおよびBTREE）で利用可能な他のインデックスよりも2〜3倍高速ですが、より多くのスペースを使用します。
また、DBにトリガーを追加しました。これは、挿入または更新クエリで検索vetorを自動的に生成します

---

アプリを使用します

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/branches/autocomplete/？q = <search_tern>＆offset = <page_number>＆limit = <page_size>
   Autocomplete Endpoint、Branches Tableのブランチ列を検索し、結果を返します。

2. /api/branches/search/？q = <search_term>＆city = <city_name>＆offset = <page_number>＆limit = <page_size>
   指定された検索用語で与えられた都市のBracnesテーブルのすべてのDB列を検索します。

3. /API/BANKS/：ID
   Banks TableからID：IDを返します。

---

展開

freebieのもの??

1. Heroku（無料、展開されたDjangoプロジェクト）
2. 巧妙なクラウド（無料のポストグレス追加）
3. Redis Labs Redis Cloud（無料Redisインスタンス）

これらはすべてAWSフリーティアに含まれていますが、カードの詳細を共有したくありませんか？ （私はカードを持っていませんか？）。

---

既知の問題

1. 部分的な単語検索POSTGREフルテキスト検索はop❤️‍ですが、部分的な単語ではうまく機能しません。たとえば、EASの結果はありませんが、東の結果が得られます。
   ソリューションフルテキスト検索またはパスにElasticSearchのような前進を使用するか、一部の単語のためにPostgres FTSを活用するためにいくつかのカスタムプラグインを書きます。

---

改善

1. APIドキュメント（おそらくSwagger）を追加します。時間の制約により、これを将来の作業と考えています。

---

単語を閉じる

私はこのプロジェクトを作成し、それを作成しながら新しいものをリアンドすることを本当に楽しんでいました。

PS Today（2021年5月21日）は私のビットデーですか？