Implementation of entities concept on top of Google cloud firestore
Project description
Firestore Entities (BETA)(Docs)
Implementation of models concept on top of Google cloud firestore. Firestore entities try to make interaction with firestore as simple as possible for the developer.
Installation
pip install firestore-entities
Examples
"""
This code creates a model with some possible scenarios when working with firestore.Entity
Assume a case where a user can have
- Single login
- Be in multiple projects
- Have an account in each project
"""
from firestore import Entity, SERVER_TIMESTAMP
from firestore import db
class User(Entity):
user_name = db.TextProperty( required=True)
email = db.TextProperty(required=True)
full_name = db.TextProperty(required=True)
password = db.TextProperty(required=False)
date_registered = db.DateTimeProperty(default=SERVER_TIMESTAMP)
__sub_collection__ = "user_data"
class Project(Entity):
name = db.TextProperty(required=True)
logo = db.BlobProperty()
def create_account(self, user, roles = None ):
if roles is None:
roles = ["admin"]
account = Account(user=user, roles=roles)
account.put()
return account
class Account(Entity):
__sub_collection__ = Project
user = db.ReferenceProperty(User)
roles = db.ListProperty(db.TextProperty())
date_added = db.DateTimeProperty(auto_add_now=True)
last_updated = db.DateTimeProperty(auto_now=True)
# Then we can
user = User(user_name="john", email="john@doe.fam", password="123456")
user.full_name = "John Doe"
user.put()
# Get an existing user
john = User.get(user.id)
# Query users
user2 = User.query().equal("email", "jane@doe.fam")[0]
users = User.query()
for _user in users:
print(_user.email)
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
Built Distribution
Close
Hashes for firestore_entities-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1827d542de5cbe7c18bb854fc1f1b919de18ba7fc9ce610e1fd6282f2a5f597 |
|
MD5 | 45820b9a5fc5db69251dc805dff18c04 |
|
BLAKE2b-256 | ddcea4fecad3519ac75e7318230e57543a932861b3158457609e50f317463675 |