Firebase: utilisez Cloud Firestore et Cloud Storage depuis Python

introduction

• Je vais laisser une note sur la façon d'utiliser Cloud Firestore et Cloud Storage de Firebase depuis Python.
• Veuillez préparer un fichier CSV et l'utiliser lors du téléchargement ou du téléchargement à partir de python.

table des matières

• Préparation --Ajouter un SDK --Préparation du fichier d'authentification
• [Utiliser Cloud Firestore](Utiliser # cloud-firestore)
• Importation de bibliothèques --Initialisation des identifiants
• Obtenir des données --Ajouter des données --Suprimmer les données
• [Utiliser Cloud Storage](utiliser # cloud-storage)
• Importation de bibliothèques --Initialisation des identifiants
• Obtenir des données --Ajouter des données --Suprimmer les données --Résumé

Préparation

• Tout d'abord, préparez le SDK et le fichier d'authentification.

Ajouter un SDK

• Exécutez la commande suivante pour ajouter le SDK.

python

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

Préparation du fichier d'authentification

--Fichier d'authentification utilisé pour accéder à Firebase par programmation.

• Obtenez le fichier json en suivant les étapes ci-dessous.

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

1. Dans la console Firebase, ouvrez Paramètres> Comptes de service.

1. Cliquez sur Générer une nouvelle clé privée, puis sur Générer la clé pour confirmer.
2. Stockez en toute sécurité le fichier JSON contenant la clé.

Utiliser Cloud Firestore

• Je vais résumer comment utiliser Firestore de python.

Import de bibliothèque

• Tout d'abord, importez les bibliothèques à utiliser.

import

import firebase_admin
from firebase_admin import credentials
from firebase_admin import firestore

Initialisation des informations d'identification

• Autorisez le programme à accéder à Firebase à l'aide du fichier d'authentification json préparé précédemment. --Initialisez avec le code suivant.

initialize

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

• ** Remplacez «<pass_to_json_file>» par le chemin (chaîne de caractères) du fichier json. ** **
• ** Assurez-vous de l'initialiser avant d'accéder aux données Firebase. ** **
• Si vous ne l'initialisez pas, une erreur se produira et vous ne pourrez pas acquérir les données.

--Il peut être un peu pratique de réserver cred et default_app en tant que variables globales et de préparer une fonction d'initialisation comme indiqué ci-dessous.

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)

Je ne l'ai pas utilisé, mais vous pouvez utiliser des variables d'environnement pour passer le chemin vers le fichier json.

1. Passez les variables d'environnement (dans un terminal ou un terminal).
2. Dans ce cas, l'initialisation est effectuée sans spécifier d'argument.

export

export GOOGLE_APPLICATION_CREDENTIALS="<pass_to_json_file>"

initialize

default_app = firebase_admin.initialize_app()

Obtenir des données de Firestore

• ** Ceci est un exemple de spécification d'un seul document ** et de récupération du contenu. --Utilisez get. --A ce moment, une exception sera levée si le document pointé par doc_ref n'existe pas. --Cette exception est google.cloud.exceptions.NotFound, donc traitons-la avec try si nécessaire. --Pour doc_ref, vous pouvez vérifier si le document existe en utilisant la méthode ʻexists`.

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()))

--Utilisez stream for collection pour obtenir tous les ** documents ** directement sous la collection.

getFirestoreData2

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

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

Obtenir des données de Firestore (utilisation récursive)

• Pour accéder à la collection dans le document, utilisez la méthode de collecte du document. ――Vous pouvez le faire comme vous de manière intuitive.

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)

• Actuellement, il n'est pas possible d'obtenir une liste des sous-collections de documents en python. --Si vous souhaitez obtenir une liste de sous-collections, utilisez une autre langue ensemble.

ExamplePar exemple, si vous écrivez en rubis, c'est comme suit.

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

Ajouter des données à Firestore

• Ceci est un exemple d'enregistrement de données de type dictionnaire en spécifiant le nom de la collection et le nom du document.

uploadData2Firestore

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

Mettre à jour les données Firestore

• Comment mettre à jour un champ sur un document existant.

update_data

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

    doc_ref.update({key: value})

Supprimer les données de Firestore

• Ceci est un exemple de suppression de données en spécifiant le nom de la collection et le nom du document.

deleteFirestoreDocument

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

Utilisez Cloud Storage

Import de bibliothèque

• Tout d'abord, importez les bibliothèques à utiliser.

import

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

Initialisation des informations d'identification

• Autorisez le programme à accéder à Firebase à l'aide du fichier d'authentification json préparé précédemment. --Initialisez avec le code suivant.

initialize

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

• ** Remplacez «<pass_to_json_file>» par le chemin du fichier json. ** **
• ** Les variables initialisées ici seront utilisées plus tard. ** **

Je ne l'ai pas utilisé, mais vous pouvez utiliser des variables d'environnement pour passer le chemin vers le fichier json.

1. Passez les variables d'environnement (dans un terminal ou un terminal).
2. Dans ce cas, l'initialisation est effectuée sans spécifier d'argument.

export

export GOOGLE_APPLICATION_CREDENTIALS="<pass_to_json_file>"

initialize

storage_client = storage.Client()

Obtenez des données depuis Cloud Storage

• Ceci est un exemple de téléchargement de données dans un fichier en spécifiant l'url de l'objet blob.

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))

Ajouter des données à Cloud Storage

• Ceci est un exemple d'enregistrement en spécifiant le nom du fichier et les données.

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")

Supprimer les données de Cloud Storage

• Ceci est un exemple de suppression de données en spécifiant l'url de l'objet blob.

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()

Résumé

«Je n'avais pas beaucoup d'informations sur la façon d'éviter d'utiliser des variables d'environnement, alors je l'ai résumé. ――Il peut être plus sûr d'utiliser des variables d'environnement en fonctionnement réel, mais ...

―― Ce qui suit est un site que j'ai souvent visité.

• Essayez Cloud Firestore
• Ajouter des données à Cloud Firestore
• Obtenir des données avec Cloud Firestore
• Cloud Firestore: référence de l'API python ――Nous vous serions reconnaissants si vous pouviez nous contacter si vous avez des erreurs.