Skip to main content

Google Cloud Firestore API client library

Project description

GA pypi versions

The Google Cloud Firestore API is a flexible, scalable database for mobile, web, and server development from Firebase and Google Cloud Platform. Like Firebase Realtime Database, it keeps your data in sync across client apps through realtime listeners and offers offline support for mobile and web so you can build responsive apps that work regardless of network latency or Internet connectivity. Cloud Firestore also offers seamless integration with other Firebase and Google Cloud Platform products, including Cloud Functions.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Google Cloud Firestore API.

  4. Setup Authentication.

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.6

Deprecated Python Versions

Python == 2.7.

The last version of this library compatible with Python 2.7 is google-cloud-firestore==1.9.0.

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-firestore

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-firestore

Example Usage

from google.cloud import firestore

# Add a new document
db = firestore.Client()
doc_ref = db.collection(u'users').document(u'alovelace')
doc_ref.set({
    u'first': u'Ada',
    u'last': u'Lovelace',
    u'born': 1815
})

# Then query for documents
users_ref = db.collection(u'users')

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

Next Steps

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

google-cloud-firestore-2.5.1.tar.gz (330.1 kB view details)

Uploaded Source

Built Distribution

google_cloud_firestore-2.5.1-py2.py3-none-any.whl (244.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file google-cloud-firestore-2.5.1.tar.gz.

File metadata

File hashes

Hashes for google-cloud-firestore-2.5.1.tar.gz
Algorithm Hash digest
SHA256 e505dc73ac31f9cff10b6ce4fb34b9989d267b3c770e63fa03bec08216a9c139
MD5 c832fd4259753d8375f0780b60921cd1
BLAKE2b-256 a76d4a6087a73c94b338c13eab42a68c971cff77059f7906ca8eba4fed7aef62

See more details on using hashes here.

Provenance

File details

Details for the file google_cloud_firestore-2.5.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for google_cloud_firestore-2.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 93d0a91340ae7e7d1a9812852dc3c033360e203add20215d8538496c16750bc2
MD5 2de60d9e7a32dba2463cc78c50bf5c63
BLAKE2b-256 f758492e669f749f21b686c36a5c43e8c8ea703a1c567022b4ee548757d5ff95

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page