Skip to main content

ORM for Firestore with cascade

Project description

Google Firestore ORM

This is yet another attempt to create an ORM for Google Firestore Database. This one is relatively simple one with not too many option to customize. In fact the entire source code is in one file firestore-ci.py. The main feature of this ORM is to auto-link a one-to-many relationship between two collections / objects.

How to use?

  1. Install firestore-ci pip install firestore-ci
  2. Save the service-account json key in your project folder & give it a name. For e.g. google-cloud.json
  3. Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the json file. For e.g. in Linux export GOOGLE_APPLICATION_CREDENTIALS="google-cloud.json"
  4. Import FirestoreDocument from firestore_ci
  5. Make your object model using FirestoreDocument For e.g. class User(FirestoreDocument)
  6. Override the __init__() method to add your fields
  7. Outside the model, call the init() method of Firestore document. For e.g. User.init()
  8. Here is a sample models.py file
from firestore_ci import FirestoreDocument

class User(FirestoreDocument):
    def __init__(self):
        super().__init__()
        self.name = str()
        self.email = str()

User.init()

Project details


Download files

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

Files for firestore-ci, version 1.1.0b1
Filename, size File type Python version Upload date Hashes
Filename, size firestore_ci-1.1.0b1-py3-none-any.whl (5.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size firestore-ci-1.1.0b1.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page