docs(firestore-incremental-capture): document Cloud Tasks max document size limit#1103
Open
cabljac wants to merge 1 commit into
Open
docs(firestore-incremental-capture): document Cloud Tasks max document size limit#1103cabljac wants to merge 1 commit into
cabljac wants to merge 1 commit into
Conversation
…t size limit Adds a Known limitations section to PREINSTALL.md and README.md explaining that each Firestore write is synced via a Cloud Task that carries both the before and after document state, and that Cloud Tasks enforces a 100KB maximum task size. Documents whose combined state exceeds this limit fail to enqueue with 'Error: Task size too large' and are not captured to BigQuery. Includes guidance on keeping documents small, splitting large documents, offloading large fields to Cloud Storage, and using native PITR or Scheduled Backups for larger documents. Bumps version to 0.0.13 and updates the changelog.
cabljac
force-pushed
the
docs/issue-607-task-size
branch
from
0b36af6 to
85374fd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the confusion reported in #607, where writes to the extension's captured collection fail with
Error: Task size too large.The extension syncs every Firestore write by enqueueing a Cloud Task that carries both the
beforeandafterstate of the changed document. Cloud Tasks enforces a maximum task size of 100KB, so writes to large documents (Firestore allows up to 1 MiB) exceed the limit, fail to enqueue, and are silently not captured to BigQuery. This is a known limitation of the Cloud Tasks transport rather than a bug, so this PR documents it clearly.Changes
PREINSTALL.mdandREADME.mdexplaining:Error: Task size too largeerror happens (both document states plus overhead in a single 100KB task),0.0.13and updateCHANGELOG.md.Docs only - no behavior change.
Closes #607