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.3.0.tar.gz (316.3 kB view details)

Uploaded Source

Built Distribution

google_cloud_firestore-2.3.0-py2.py3-none-any.whl (231.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: google-cloud-firestore-2.3.0.tar.gz
  • Upload date:
  • Size: 316.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.0

File hashes

Hashes for google-cloud-firestore-2.3.0.tar.gz
Algorithm Hash digest
SHA256 81cebc4bebad75c3b6392091031c930a39d705f53158dfc3ecf7cd837714cd0f
MD5 a410181a259f9efbce50e6490f7c8d0b
BLAKE2b-256 776e46d9431948cd6fc73f741592e0403cbe21c64a519470265b6913b8b06ad8

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: google_cloud_firestore-2.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 231.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.0

File hashes

Hashes for google_cloud_firestore-2.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1e9f6aa12f114f7dab4f6a35ea3304a1229c5eea98ec34f6fbf9131b80ece4e8
MD5 34e7d0286c8b0ed26d70e9810e3da8b1
BLAKE2b-256 c3dd1642175ee967bec2c7fcb3f397317ab0e7354d2bdf1b04884d179738f888

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