Firebase: Verwenden Sie Cloud Firestore und Cloud Storage von Python

Einführung

• Ich werde einen Hinweis zur Verwendung von Firebases Cloud Firestore und Cloud Storage von Python hinterlassen. --Bitte bereiten Sie eine CSV-Datei vor und verwenden Sie sie beim Hochladen oder Herunterladen von Python.

Inhaltsverzeichnis

• Vorbereitung
• SDK hinzufügen
• Vorbereitung der Authentifizierungsdatei
• [Cloud Firestore verwenden](Verwenden Sie # cloud-firestore)
• Bibliotheksimport
• Initialisierung von Anmeldeinformationen --Daten bekommen --Daten hinzufügen --Daten löschen
• [Cloud-Speicher verwenden](# Cloud-Speicher verwenden)
• Bibliotheksimport
• Initialisierung von Anmeldeinformationen --Daten bekommen --Daten hinzufügen --Daten löschen --Zusammenfassung

Vorbereitung

• Bereiten Sie zunächst das SDK und die Authentifizierungsdatei vor.

SDK hinzufügen

• Führen Sie den folgenden Befehl aus, um das SDK hinzuzufügen.

python

pip install firebase-admin # firebase firestore
pip install --upgrade google-cloud-storage # cloud storage

Vorbereitung der Authentifizierungsdatei

--Authentifizierungsdatei für den programmgesteuerten Zugriff auf Firebase.

• Holen Sie sich die JSON-Datei, indem Sie die folgenden Schritte ausführen.

Von https://firebase.google.com/docs/admin/setup?hl=ja

1. Öffnen Sie in der Firebase-Konsole Einstellungen> Dienstkonten.

1. Klicken Sie auf Neuen privaten Schlüssel generieren und dann zur Bestätigung auf Schlüssel generieren.
2. Speichern Sie die JSON-Datei mit dem Schlüssel sicher.

Verwenden Sie den Cloud Firestore

• Ich werde zusammenfassen, wie man Firestore aus Python verwendet.

Bibliotheksimport

• Importieren Sie zunächst die zu verwendenden Bibliotheken.

import

import firebase_admin
from firebase_admin import credentials
from firebase_admin import firestore

Initialisierung der Anmeldeinformationen

• Ermöglichen Sie dem Programm den Zugriff auf Firebase mithilfe der zuvor erstellten JSON-Authentifizierungsdatei. --Initialisieren Sie mit dem folgenden Code.

initialize

cred = credentials.Certificate('<pass_to_json_file>')
default_app = firebase_admin.initialize_app(cred)

• ** Ersetzen Sie <pass_to_json_file> durch den Pfad (Zeichenfolge) zur json-Datei. ** **.

• ** Stellen Sie sicher, dass Sie initialisieren, bevor Sie auf die Firebase-Daten zugreifen. ** **.

• Wenn Sie nicht initialisieren, tritt ein Fehler auf und Sie können die Daten nicht erfassen.

• Es kann ein wenig bequem sein, "cred" und "default_app" als globale Variablen zu reservieren und eine Initialisierungsfunktion wie unten gezeigt vorzubereiten.

initialize2

cred = None
default_app = None

def initializeFirebaseAPP():
	global cred
	global default_app
	cred = credentials.Certificate("< pass_to_json_file >")
	default_app = firebase_admin.initialize_app(cred)

Ich habe es nicht verwendet, aber Sie können Umgebungsvariablen verwenden, um den Pfad zur JSON-Datei zu übergeben.

1. Übergeben Sie Umgebungsvariablen (in einem Terminal oder Terminal).
2. Die Initialisierung erfolgt in diesem Fall ohne Angabe eines Arguments.

export

export GOOGLE_APPLICATION_CREDENTIALS="<pass_to_json_file>"

initialize

default_app = firebase_admin.initialize_app()

Holen Sie sich Daten von Firestore

• ** Dies ist ein Beispiel für die Angabe eines einzelnen Dokuments ** und das Abrufen des Inhalts. --Verwenden Sie "get".
• Zu diesem Zeitpunkt wird eine Ausnahme ausgelöst, wenn das Dokument, auf das "doc_ref" zeigt, nicht vorhanden ist. --Diese Ausnahme ist "google.cloud.exceptions.NotFound". Lassen Sie uns sie bei Bedarf mit "try" behandeln. --Für doc_ref können Sie mit der```-Methode überprüfen, ob das Dokument vorhanden ist.

getFirestoreData

def getFirestoreData(collectionName, documentName):
	db = firestore.client()
	doc_ref = db.collection(collectionName).document(documentName)

	doc = doc_ref.get()
	print(u'Document data: {}'.format(doc.to_dict()))

--Verwenden Sie "Stream" für "Sammlung", um alle ** Dokumente ** direkt unter der Sammlung abzurufen.

getFirestoreData2

def getFirestoreData2(collectionName):
	db = firestore.client()
	docs = db.collection(collectionName).stream()

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

Daten aus dem Firestore abrufen (rekursive Verwendung)

• Um auf die Sammlung im Dokument zuzugreifen, verwenden Sie die Erfassungsmethode für das Dokument. ――Sie können es intuitiv tun.

getFirestoreData3

def getFirestoreData3(col_name, doc_name, col_name2):
	db = firestore.client()
	doc_ref = db.collection(col_name).document(doc_name)
	col_ref2 = doc_ref.collection(col_name2)

• Derzeit ist es nicht möglich, eine Liste der Dokumentensammlungen in Python abzurufen.

• Wenn Sie eine Liste von Untersammlungen erhalten möchten, verwenden Sie zusammen eine andere Sprache.

• Wenn Sie beispielsweise in Ruby schreiben, ist dies wie folgt.

getCollectionList.rb

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new project_id: "<project_id>", keyfile: "<path_to_json>"
doc_ref = firestore.doc "<col_name>/<doc_name>"

doc_ref.cols do |col|
	puts col.collection_id
end

Fügen Sie dem Firestore Daten hinzu

• Dies ist ein Beispiel für die Registrierung von Wörterbuchtypdaten durch Angabe des Sammlungsnamens und des Dokumentnamens.

uploadData2Firestore

def uploadData2Firestore(collectionName, documentName, data):
	db = firestore.client()
	doc_ref = db.collection(collectionName).document(documentName)
	doc_ref.set(data)

Firestore-Daten aktualisieren

• So aktualisieren Sie ein Feld in einem vorhandenen Dokument.

update_data

def update_data(collectionName, documentName, key, value):
    db = firestore.client()
    doc_ref = db.collection(collectionName).document(documentName)

    doc_ref.update({key: value})

Daten aus dem Firestore löschen

• Dies ist ein Beispiel für das Löschen von Daten durch Angabe des Sammlungsnamens und des Dokumentnamens.

deleteFirestoreDocument

def deleteFirestoreDocument(collectionName, documentName):
	db = firestore.client()
	db.collection(collectionName).document(documentName).delete()

Verwenden Sie Cloud-Speicher

Bibliotheksimport

• Importieren Sie zunächst die zu verwendenden Bibliotheken.

import

import firebase_admin
from firebase_admin import credentials
from google.cloud import storage

Initialisierung der Anmeldeinformationen

• Ermöglichen Sie dem Programm den Zugriff auf Firebase mithilfe der zuvor erstellten JSON-Authentifizierungsdatei. --Initialisieren Sie mit dem folgenden Code.

initialize

storage_client = storage.Client.from_service_account_json('<pass_to_json_file>')

• ** Ersetzen Sie "<pass_to_json_file>" durch den Pfad zur json-Datei. ** **.
• ** Die hier initialisierten Variablen werden später verwendet. ** **.

Ich habe es nicht verwendet, aber Sie können Umgebungsvariablen verwenden, um den Pfad zur JSON-Datei zu übergeben.

1. Übergeben Sie Umgebungsvariablen (in einem Terminal oder Terminal).
2. Die Initialisierung erfolgt in diesem Fall ohne Angabe eines Arguments.

export

export GOOGLE_APPLICATION_CREDENTIALS="<pass_to_json_file>"

initialize

storage_client = storage.Client()

Holen Sie sich Daten aus dem Cloud-Speicher

• Dies ist ein Beispiel für das Herunterladen von Daten in eine Datei durch Angabe der URL des Blobs.

download_blob

def download_blob(src_blob_url, dst_file):
	bucket_name = '<bucket_name>'
	bucket = storage_client.get_bucket(bucket_name)

	blob = bucket.blob(src_blob_url)
	storage_client.download_blob_to_file(blob, dst_file)

	print('Blob {} downloaded to {}.'.format(src_blob_url, dst_file))

Hinzufügen von Daten zum Cloud-Speicher

• Dies ist ein Beispiel für die Registrierung durch Angabe des Dateinamens und der Daten.

upload_blob

def upload_blob(file_name, data_sorce):
	bucket_name = '<bucket_name>'
	bucket = storage_client.get_bucket(bucket_name)
	blob = bucket.blob(file_name)
	blob.upload_from_filename(filename=data_sorce)

	if file_name in bucket.list_blobs():
		print("cloud storage: upload success")
	else:
		print("cloud storage: upload failed")

Daten aus dem Cloud-Speicher löschen

• Dies ist ein Beispiel für das Löschen von Daten durch Angabe der URL des Blobs.

delete_blob

def delete_blob(blob_url):
	bucket_name = '<bucket_name>'
	bucket = storage_client.get_bucket(bucket_name)
	blob = bucket.blob(blob_url)

	blob.delete()

Zusammenfassung

――Ich hatte nicht viele Informationen darüber, wie man die Verwendung von Umgebungsvariablen vermeiden kann, deshalb habe ich sie zusammengefasst. ――Es mag sicherer sein, Umgebungsvariablen im tatsächlichen Betrieb zu verwenden, aber ...

――Das Folgende ist eine Seite, die ich oft besucht habe.

• Cloud Firestore ausprobieren
• Daten zum Cloud Firestore hinzufügen
• Daten mit Cloud Firestore abrufen
• Cloud Firestore: Python-API-Referenz ――Wir würden uns freuen, wenn Sie uns bei Fehlern kontaktieren könnten.