Pydantic models for Firestore
Project description
Pyrodantic
Pydantic models for Google Firestore.
Inspired by fireclass.
Installation
pip install pyrodantic
Usage
from google.cloud.firestore import Client
from pyrodantic import Document, FirestoreID
firestore_client = Client()
class TestDocument(Document):
document_id: FirestoreID = None
test_string: str
test_int: int
test_default: str = 'default'
class Firestore:
collection = 'test-collection'
doc = TestDocument(firestore_client, test_string='foo', test_int=1)
# doc == TestDocument(document_id=None, test_string='foo', test_int=1, test_default='default')
doc.create()
# doc == TestDocument(document_id='4f7be295accc473aa87844ec6f98443c', test_string='foo', test_int=1, test_default='default')
doc = TestDocument.get('4f7be295accc473aa87844ec6f98443c', firestore_client=firestore_client)
# doc == TestDocument(document_id='4f7be295accc473aa87844ec6f98443c', test_string='foo', test_int=1, test_default='default')
docs = list(TestDocument.where('test_string', '==', 'foo', firestore_client).stream())
# docs[0] == TestDocument(document_id='4f7be295accc473aa87844ec6f98443c', test_string='foo', test_int=1, test_default='default')
docs[0].delete()
doc = TestDocument.get('4f7be295accc473aa87844ec6f98443c', firestore_client=firestore_client)
# doc == None
TODO
- Support transactions
- Support sub-collections
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyrodantic-0.0.3.tar.gz
(3.2 kB
view hashes)
Built Distribution
Close
Hashes for pyrodantic-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c3907374e7314ec785cb6c5b48744ac71110073d567ab88e8f8d32f8ed649c1 |
|
MD5 | 51686b5dc0d894467c77f34871822150 |
|
BLAKE2b-256 | 18b23cbee462fd7abae67756d351cbc202544925e621f826ece5615f50569ca7 |