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

Uploaded Source

Built Distribution

google_cloud_firestore-2.3.3-py2.py3-none-any.whl (232.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for google-cloud-firestore-2.3.3.tar.gz
Algorithm Hash digest
SHA256 ef7572cbc83412dbc9cadd95962e77bfa9962a5cb030706638a4aafa7cad84aa
MD5 48fdd2dd4160d800caa8bbf17bb76584
BLAKE2b-256 c9b6b873a29be5960012249dd5fea6e989baff9f04519245d71ceb83a60bc522

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for google_cloud_firestore-2.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 63a46603949ce3c04d8838c25cad6160e4627b6db10f5855d95804019d5cbfed
MD5 c2527b54632e796a4d08f1a7f2a3126f
BLAKE2b-256 20e541b05e82029ed6bb27e628045aa392110885d0a19e96a3cbd386dcc5b8a9

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