Skip to content

Commit f6662a8

Browse files
cabljacgregfenton
andauthored
docs(firestore-bigquery-export): clarify meaning of "exclude old data" (#2124)
* doc: clarify meaning of "exclude old data" The original description is generically worded. This additional specificity should make it clear to Firestore users what is meant by "old data". * Update description ni extension.yaml * Undo update of README.md * Update README.md * ran `npm run generate-readme` --------- Co-authored-by: Greg Fenton <greg.fenton@gmail.com>
1 parent f729742 commit f6662a8

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

firestore-bigquery-export/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ essential for the script to insert data into an already partitioned table.)
154154

155155
* Use new query syntax for snapshots: If enabled, snapshots will be generated with the new query syntax, which should be more performant, and avoid potential resource limitations.
156156

157-
* Exclude old data payloads: If enabled, table rows will never contain old data (document snapshot before the update), which should be more performant, and avoid potential resource limitations.
157+
* Exclude old data payloads: If enabled, table rows will never contain old data (document snapshot before the Firestore onDocumentUpdate event: `change.before.data()`). The reduction in data should be more performant, and avoid potential resource limitations.
158158

159159
* Use Collection Group query: Do you want to use a [collection group](https://firebase.google.com/docs/firestore/query-data/queries#collection-group-query) query for importing existing documents? You have to enable collectionGroup query if your import path contains subcollections. Warning: A collectionGroup query will target every collection in your Firestore project that matches the 'Existing documents collection'. For example, if you have 10,000 documents with a subcollection named: landmarks, this will query every document in 10,000 landmarks collections.
160160

firestore-bigquery-export/extension.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,8 +384,9 @@ params:
384384
label: Exclude old data payloads
385385
description: >-
386386
If enabled, table rows will never contain old data (document snapshot
387-
before the update), which should be more performant, and avoid potential
388-
resource limitations.
387+
before the Firestore onDocumentUpdate event: `change.before.data()`). The
388+
reduction in data should be more performant, and avoid potential resource
389+
limitations.
389390
type: select
390391
required: false
391392
default: no

0 commit comments

Comments
 (0)