Pythonを使用したGoogle Firebase Cloud Firestoreの実践的な活用方法

【目次】
  1. Google Firebaseの主要機能と特徴
  2. 環境構築と初期設定
  3. Cloud Firestoreプロジェクトの作成手順
  4. Firebase Admin SDKの導入方法
  5. 実践的なクエリ例と活用方法

Google Firebaseの主要機能と特徴

高性能なクラウドストレージサービスとして，包括的なインフラストラクチャを提供．

データベース機能：PythonとJavaScriptの双方で最適化された互換性を実現し，シームレスな開発環境を提供．

認証システム（ID，パスワード），セキュリティ管理，課金システムなど，アプリケーション開発に必要な統合機能を完備．

* iOS，Android，Webプラットフォームに完全対応．利用開始にはGoogleアカウントの登録が必要．

環境構築と初期設定

Python 3.12 のインストール（Windows 上） [クリックして展開]

以下のいずれかの方法で Python 3.12 をインストールする。Python がインストール済みの場合、この手順は不要である。

方法1：winget によるインストール

管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Python.Python.3.12 -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1 Include_test=0 Include_launcher=1 InstallLauncherAllUsers=1"

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。

方法2：インストーラーによるインストール

  1. Python 公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンから Windows 用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」に必ずチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

AIエディタ Windsurf のインストール（Windows 上） [クリックして展開]

Pythonプログラムの編集・実行には、AIエディタの利用を推奨する。ここでは、Windsurfのインストールを説明する。Windsurf がインストール済みの場合、この手順は不要である。

管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Codeium.Windsurf -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --custom "/SP- /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /DIR=""C:\Program Files\Windsurf"" /MERGETASKS=!runcode,addtopath,associatewithfiles,!desktopicon"
powershell -Command "$env:Path=[System.Environment]::GetEnvironmentVariable('Path','Machine')+';'+[System.Environment]::GetEnvironmentVariable('Path','User'); windsurf --install-extension MS-CEINTL.vscode-language-pack-ja --force; windsurf --install-extension ms-python.python --force; windsurf --install-extension Codeium.windsurfPyright --force"

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。

【関連する外部ページ】

Windsurf の公式ページ: https://windsurf.com/

Git のインストール（Windows 上） [クリックして展開]

管理者権限のコマンドプロンプトで以下を実行する．管理者権限は，winget の --scope machine オプションでシステム全体にインストールするために必要となる．

REM Git をシステム領域にインストール
winget install --scope machine --id Git.Git -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/VERYSILENT /NORESTART /NOCANCEL /SP- /CLOSEAPPLICATIONS /RESTARTAPPLICATIONS /COMPONENTS=""icons,ext\reg\shellhere,assoc,assoc_sh"" /o:PathOption=Cmd /o:CRLFOption=CRLFCommitAsIs /o:BashTerminalOption=MinTTY /o:DefaultBranchOption=main /o:EditorOption=VIM /o:SSHOption=OpenSSH /o:UseCredentialManager=Enabled /o:PerformanceTweaksFSCache=Enabled /o:EnableSymlinks=Disabled /o:EnableFSMonitor=Disabled"

Firebase Admin SDKの設定と秘密鍵の取得手順

公式ドキュメントに基づいて，以下の手順で設定を実施する．

  1. Firebaseの公式ポータルサイトにアクセスする．

    https://firebase.google.com/?hl=ja

  2. メインページから「使ってみる (GET STARTED)」を選択する．
  3. Googleアカウントによる認証を実行する．

    有効なセッションが存在する場合は，自動的に次のステップに移行する．

  4. Firebaseコンソールへのアクセス権限を確認する．
  5. コンソール画面から対象となるプロジェクトを選択する．

    * 新規プロジェクトを作成する場合は，「プロジェクトを追加」から設定を開始する．

  6. Project Overviewメニューから設定ボタンをクリックする．
  7. メニューから「プロジェクトを設定」を選択する．
  8. 左側のサイドメニューから「サービスアカウント」を選択する．
  9. 開発に使用する言語として「Python」を選択する．

    選択後，Firebase Admin SDKの設定に必要なコードスニペットが自動的に表示される．

    * この画面では「Firebase サービスアカウントを使用したPythonアプリケーションの認証機能」の詳細が確認できる．

  10. 「新しい秘密鍵の生成」ボタンを選択する．
  11. 表示される確認ダイアログで「キーを生成」を実行する．
  12. 生成された認証用JSONファイルのダウンロードを確認する．

    ダウンロードされた認証用JSONファイルのファイル名を記録する（後続の設定プロセスで使用）．

Firebase Admin SDKのPython環境への導入

セットアップガイドおよび クイックスタートの手順に従って実装を進める．

  1. Windows環境でコマンドプロンプトを管理者権限で起動する．
  2. Firebase Admin SDKのインストールを実行する．

    以下のコマンドを実行する． 

    pip install -U firebase-admin
  3. Pythonプログラムで動作確認を実施する．
    効率的な開発環境として，Jupyter Qt Console，Spyder，PyCharm，PyScripterなどの統合開発環境の利用を推奨する．

    以下のサンプルコードを実行する．

    エディタで「H:/my-project-abcde-firebase-adminsdk-q53ez-5d420dbcf2.json」を，ダウンロードした認証用JSONファイルの実際のパスに置き換える．

    このプログラムは，データベース内の「products」コレクションに格納されているドキュメントを取得して表示する． 実行結果の例も併せて提示する． 

    import firebase_admin
from firebase_admin import credentials
from firebase_admin import firestore

cred = credentials.Certificate('H:/my-project-abcde-firebase-adminsdk-q53ez-5d420dbcf2.json')
app = firebase_admin.initialize_app(cred)

db = firestore.client()
ref = db.collection(u'products')
docs = ref.stream()

for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))

    以下のようなコレクション構造を前提としている．

    実行結果：

* Webインターフェースを使用したデータベース管理手順
  1. Firebaseポータルサイトにアクセスする．

    https://firebase.google.com/?hl=ja

    * 必要に応じてGoogleアカウントでの認証が要求される．

  2. 「使ってみる (GET STARTED)」を選択する．
  3. Firebaseコンソールの表示を確認する．
  4. 管理対象のプロジェクトを選択する．

    * 新規プロジェクトが必要な場合は「プロジェクトを追加」から作成することができる．

  5. 左側のサイドメニューから「Database」を選択する．
  6. データベース管理画面でコレクションとドキュメントの作成・編集作業が可能となる．

実践的なクエリ例

前述のコード例に続いて，以下のクエリ処理を実行する． 「u'name', u'==', u'apple'」は文字列の完全一致検索を実行する処理である． 

a = ref.where(u'name', u'==', u'apple')
docs = a.stream()
for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))

実行結果：

日時データの比較クエリ例

「u'time', u'>', datetime(2019,4,13,3,10,0)」の条件式でPythonのdatetimeオブジェクトを使用した日時比較クエリを実行する． 

import datetime
a = ref.where(u'time', u'>', datetime(2019,4,13,3,10,0))
docs = a.stream()
for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))