Google Cloud Functions (Python) から Cloud Firestore のデータを読み出す – Cloud SDK を使う方法と Firebase Admin SDK を使う方法 –

Cloud Firestore を Python で作成した Cloud Functions から利用するには活用する SDK 別に以下の2つがあります。

Cloud SDK を使う方法
Firebase Admin SDK を使う方法

両者に特にメリット / デメリットがあるわけではなさそうですが、少し紛らわしい部分もありますので、簡単なサンプルコードを用いて整理していきたいと思います。

[ads]

前提

[ads]

本記事は以下を前提としてすすめていきます。

これらについては、以下の記事も参考にしてください。

[ads]

Cloud Firestore の内容を Read する

[ads]

データ登録済みの Cloud Firestore のデータを Python で作成した Cloud Functions で読み出してみます。

Read する Cloud Firestore データの内容

今回読み出してみる Firestore のデータを GCP Console からみてみます。名前フィールドのみを持つシンプルなデータ構造となっています。

ちなみに Firebase Console からみてみても、同じデータを確認することができます。

ベースとなる関数の準備

次に、ベースとなる最小構成の Python 関数を作成していきます。

# main.py
def readFirestore(request):
   return {"response": "success"}

この関数を以下のコマンドで Functions Framework を用いてローカル環境で実行してみます。

sudo functions_framework --target=readFirestore --debug --port=5000

http://localhost:5000 にアクセスしてみると、以下の結果が表示されます。

{
    "response": "success"
}

Python Client for Google Cloud Firestore のインストール

Cloud SDK を用いる方法を進める前に Python Client for Google Cloud Firestore がインストールされていない場合は以下のコマンドでインストールしてください。

pip install google-cloud-firestore

Cloud SDK を用いて Python Cloud Functions から Cloud Firestore のデータを読み出す

それでは、Cloud SDK を使って、先程作成した readFirestore 関数から Cloud Firestore のデータを読み出していきます。

google.cloud から firestore をインポート
Firestore の ‘test’ コレクションへのリファレンスを設定
stream() を使用してドキュメントへのリファレンスを設定
ドキュメントの内容をドキュメント ID と共に print

def readFirestore(request):
   from google.cloud import firestore
 
   db = firestore.Client()
   test_ref = db.collection(u'test')
   docs = test_ref.stream()
 
   for doc in docs:
       print(f'{doc.id} => {doc.to_dict()}')
 
   return {"response": "success"}

再び http://localhost:5000 にアクセスしてみると、出力結果の表示は同じですが、ターミナルに以下のようなログが出力され Cloud Firestore のデータを読み出すことができました。

7bbSB8YQs7Q3pPlwU2qI => {'name': 'Ken'}
JP27qDXRXyBA7pSxMjeu => {'name': 'Leo'}
LuT4irFA54w95z7pFnTY => {'name': 'Steven'}
UxrQP2dRnrV8DuX1rkw5 => {'name': 'David'}

デプロイに用いる requirements.txt

Cloud SDK については Cloud Functions に標準で用意されているため、 requirements.txt に特に記載することなくデプロイすることが可能です。

[ads]

Firebase Admin SDK を用いて Python Cloud Functions から Cloud Firestore のデータを読み出す

続いて、 Firestore Admin SDK を用いた方法についても整理していきます。

firebase_admin をインポートし、そこから credentials, firestore をインポート
credentials.ApplicationDefault() を用いてアプリケーションのデフォルトの認証を取得
firebase_admin.initialize_app() を用いて SDK を初期化
- ‘projectID’ に対象となるプロジェクト ID を指定
- 本記事では ‘sample-for-blog’ というプロジェクト

以降は Cloud SDK と同様
（ただし、 firestore.client() と c が小文字となっている点に注意)

def readFirestore(request):
  import firebase_admin
  from firebase_admin import credentials
  from firebase_admin import firestore
  # Use the application default credentials
  cred = credentials.ApplicationDefault()
  firebase_admin.initialize_app(cred, {
      'projectId': 'sample-for-blog',
  })
  db = firestore.client()
  test_ref = db.collection(u'test')
  docs = test_ref.stream()
  for doc in docs:
      print(f'{doc.id} => {doc.to_dict()}')
  return {"response": "success"}

再び http://localhost:5000 にアクセスしてみると、ターミナルに以下のようなログが出力され、先程の Cloud SDK のときと同様の Cloud Firestore のデータを読み出すことができました。

7bbSB8YQs7Q3pPlwU2qI => {'name': 'Ken'}
JP27qDXRXyBA7pSxMjeu => {'name': 'Leo'}
LuT4irFA54w95z7pFnTY => {'name': 'Steven'}
UxrQP2dRnrV8DuX1rkw5 => {'name': 'David'}

デプロイに用いる requirements.txt

Firebase Admin SDK については Cloud Functions に標準で用意されていないため、以下の内容で requirements.txt を作成した上でデプロイする必要があります。バージョンは本記事作成時の最新版としています。

# requirements.txt
firebase-admin==5.0.3

requirements.txt を main.py と同じディレクトリに作成後以下のコマンドでデプロイします。

gcloud functions deploy readFirestore --runtime python39 --trigger-http --allow-unauthenticated

[ads]

まとめ

[ads]

2 つの方法で GCP Cloud Functions から Cloud Firestore のデータを読み出してみました。同じ GCP ということで Cloud SDK を用いる方法の方がより少ないステップで実装することができました。

Cloud Functions (Python) から Cloud Finrestore を利用するさいには以下の 2 つの方法がある
- Cloud SDK を用いる方法
- Firebase Admin SDK を用いる方法
Cloud SDK を用いる方法ではデプロイ時に requirements.txt を用意する必要なし
Firebase Admin SDK を用いる方法ではデプロイ時に requirements.txt を用意する必要あり