Skip to content

docs(firestore): on_snapshot document changes #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 6, 2020
Merged

docs(firestore): on_snapshot document changes #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9f2ad5c
doc(firestore): change on_snapshot document
HemangChothani Mar 16, 2020
ab71c7e
doc(firestore): nit
HemangChothani Mar 16, 2020
3e1610f
doc(firestore): change in example as not working
HemangChothani Mar 16, 2020
ea9fe4f
doc(firestore): change in document snapshot example
HemangChothani Mar 17, 2020
672e354
Merge branch 'master' of https://github.com/googleapis/python-firesto…
HemangChothani May 14, 2020
6daf295
Merge branch 'master' of https://github.com/googleapis/python-firesto…
HemangChothani May 21, 2020
34042a5
Merge branch 'master' of https://github.com/googleapis/python-firesto…
HemangChothani Jun 12, 2020
826f14d
Merge branch 'master' into HEAD
crwilcox Jun 30, 2020
979eb61
Merge branch 'master' into firestore-issue-26
crwilcox Jul 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions google/cloud/firestore_v1/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,8 @@ def on_snapshot(self, callback):
provided callback is run on the snapshot of the documents.

Args:
callback (Callable[[:class:`~google.cloud.firestore.collection.CollectionSnapshot`], NoneType]):
callback (Callable[List[:class:`~google.cloud.firestore_v1.collection.CollectionSnapshot`], \
List[:class:`~google.cloud.firestore_v1.watch.DocumentChange`], datetime.datetime], NoneType):
a callback to run when a change occurs.

Example:
Expand All @@ -468,8 +469,8 @@ def on_snapshot(self, callback):
db = firestore_v1.Client()
collection_ref = db.collection(u'users')

def on_snapshot(collection_snapshot, changes, read_time):
for doc in collection_snapshot.documents:
def on_snapshot(docs, changes, read_time):
for doc in docs:
print(u'{} => {}'.format(doc.id, doc.to_dict()))

# Watch this collection
Expand Down
9 changes: 5 additions & 4 deletions google/cloud/firestore_v1/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,8 @@ def on_snapshot(self, callback):
provided callback is run on the snapshot.

Args:
callback(Callable[[:class:`~google.cloud.firestore.document.DocumentSnapshot`], NoneType]):
callback (Callable[List[:class:`~google.cloud.firestore_v1.document.DocumentSnapshot`], \
List[:class:`~google.cloud.firestore_v1.watch.DocumentChange`], datetime.datetime], NoneType):
a callback to run when a change occurs

Example:
Expand All @@ -512,9 +513,9 @@ def on_snapshot(self, callback):
db = firestore_v1.Client()
collection_ref = db.collection(u'users')

def on_snapshot(document_snapshot, changes, read_time):
doc = document_snapshot
print(u'{} => {}'.format(doc.id, doc.to_dict()))
def on_snapshot(docs, changes, read_time):
for doc in docs:
print(u'{} => {}'.format(doc.id, doc.to_dict()))

doc_ref = db.collection(u'users').document(
u'alovelace' + unique_resource_id())
Expand Down
3 changes: 2 additions & 1 deletion google/cloud/firestore_v1/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,8 @@ def on_snapshot(self, callback):
provided callback is run on the snapshot of the documents.

Args:
callback(Callable[[:class:`~google.cloud.firestore.query.QuerySnapshot`], NoneType]):
callback (Callable[List[:class:`~google.cloud.firestore_v1.query.QuerySnapshot`], \
List[:class:`~google.cloud.firestore_v1.watch.DocumentChange`], datetime.datetime], NoneType):
a callback to run when a change occurs.

Example:
Expand Down