Firestore Collections
Simple Firestore collection definitions and queries using pydantic schemas and Firestore query API.
A quick and easy way to make use of the NoSQL document database solution Firestore available in Google Cloud Platform.
Requirements
- Python 3.6+
Features
- Schema definition and validation: Define collection schemas using
pydanticand built-in type hinting (typing). - Automatic IDs: Automatic ID generation using 12-byte hexadecimal (
bson.ObjectId). - Simple queries: Query collections using a simple interface.
- Auxiliary timestamps: Automatically added timestamps to objects like
created_atandupdated_at.
Example
Define users collection and perform different queries:
from typing import Optional
from pydantic import EmailStr, SecretStr
from firestore_collections import Collection, Schema
class User(Schema):
__collection_name__ = 'users'
email: EmailStr
full_name: str = None
password: Optional[SecretStr]
# Initialize firestore collection
collection = Collection(schema=User)
# Initialize user object
user = User(
email='john@doe.com',
full_name='John')
# Insert
user = collection.insert(user)
# Get object from db
user = collection.get(user.id)
# Update
user.full_name = 'John Doe'
collection.update(user)
# Get by attribute
user = collection.get_by_attribute('email', 'john@doe.com')
# Get all objects
users = collection.get_all()
# Delete object
collection.delete(id=user.id)
License
This project is licensed under the terms of the MIT license.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file firestore-collections-0.0.4.tar.gz.
File metadata
- Download URL: firestore-collections-0.0.4.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a688cf52fc6551673762c80173e764fdae618bb61a379979762132f11fe12be0
|
|
| MD5 |
28697559328474d90ef7439a48afe0d3
|
|
| BLAKE2b-256 |
9ad8ad700df1fcdea329eb443da4e59f0d6054117fb63bf5dcf3d9f4df96d3c5
|
