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

Uploaded Source

Built Distribution

google_cloud_firestore-2.1.1-py2.py3-none-any.whl (209.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: google-cloud-firestore-2.1.1.tar.gz
  • Upload date:
  • Size: 285.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.0

File hashes

Hashes for google-cloud-firestore-2.1.1.tar.gz
Algorithm Hash digest
SHA256 ef7b0a94a1d7ed386c7592724f6db08aa6de99aee8dda3886964bc598aeb8bec
MD5 e233795fd82d1194550a9125c357e54b
BLAKE2b-256 49a0c3fe7aa7b838c7f6b2e020b3b0f7055901332fcb99e302b746f48aba9fef

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: google_cloud_firestore-2.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 209.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.0

File hashes

Hashes for google_cloud_firestore-2.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 80e704c5f33472f0259f436d5a3ddb0a55e64317c6139fc1e72f1c0b2e1a1ccc
MD5 3b83510e01d71e35622c8153a8ee7718
BLAKE2b-256 20dbc1736f4616e783b3950b3c5e5433253aa3456788c550cdc45b9040df4b07

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