Utiliser Firestore

Conçue pour le scaling automatique et les hautes performances, Firestore est une base de données de documents NoSQL qui simplifie le développement d'applications. En tant que successeur de Datastore, Firestore est la base de données recommandée pour toutes les nouvelles applications. Firestore propose plusieurs interfaces, y compris une API compatible avec Datastore pour prendre en charge l'ancien code basé sur Datastore.

Ce document décrit comment utiliser les bibliothèques clientes Cloud pour stocker et récupérer des données dans une base de données en mode Datastore. Vous pouvez utiliser l'exemple d'application de ce guide pour toute version compatible de Python, en spécifiant la version de l'environnement d'exécution et le système d'exploitation dans votre fichier app.yaml.

Prérequis et configuration

  • Configurez votre environnement et votre projet pour comprendre la structure des applications dans App Engine. Notez et enregistrez votre ID de projet. Il vous servira à exécuter l'exemple d'application décrit dans ce document.

Cloner le dépôt

Téléchargez (clonez) l'exemple suivant :

  git clone https://github.com/GoogleCloudPlatform/python-docs-samples
  cd python-docs-samples/appengine/flexible/datastore

Modifier la configuration du projet et définir les dépendances

Incluez la bibliothèque google-cloud-datastore dans le fichier requirements.txt. Il s'agit de la bibliothèque cliente pour le mode Datastore.

Flask==3.1.3; python_version >= '3.9'
google-cloud-datastore==2.20.2
gunicorn==23.0.0

Code d'application

L'exemple d'application enregistre, récupère et affiche les adresses IP des visiteurs. Vous noterez qu'une entrée de journal est une classe à deux champs à laquelle le type visit est attribué et qui est enregistrée en mode Datastore à l'aide de la commande put. Ensuite, les dix visites les plus récentes sont extraites par ordre décroissant à l'aide de la commande query().

@app.route("/")
def index():
    ds = datastore.Client()

    user_ip = request.remote_addr

    # Keep only the first two octets of the IP address.
    if is_ipv6(user_ip):
        user_ip = ":".join(user_ip.split(":")[:2])
    else:
        user_ip = ".".join(user_ip.split(".")[:2])

    entity = datastore.Entity(key=ds.key("visit"))
    entity.update(
        {
            "user_ip": user_ip,
            "timestamp": datetime.datetime.now(tz=datetime.timezone.utc),
        }
    )

    ds.put(entity)
    query = ds.query(kind="visit", order=("-timestamp",))

    results = []
    for x in query.fetch(limit=10):
        try:
            results.append("Time: {timestamp} Addr: {user_ip}".format(**x))
        except KeyError:
            print("Error with result format, skipping entry.")

    output = "Last 10 visits:\n{}".format("\n".join(results))

    return output, 200, {"Content-Type": "text/plain; charset=utf-8"}

Utiliser des fichiers index.yaml

L'exemple d'application effectue des requêtes. Les requêtes en mode Datastore plus élaborées nécessitent un ou plusieurs index, que vous devez spécifier dans un fichier index.yaml que vous importez avec votre application. Ce fichier peut être créé manuellement ou généré automatiquement lors du test en local de votre application.

Test local

Si vous devez développer et tester votre application en local, vous pouvez utiliser l'émulateur en mode Datastore.

Plus d'informations

Pour obtenir des informations complètes sur le mode Datastore, y compris sur les optimisations et les concepts, consultez la documentation sur Firestore en mode Datastore.