docs(batch-exports): Document REQUIRED field error handling for BigQuery BYOT#18188
Open
inkeep[bot] wants to merge 1 commit into
Open
docs(batch-exports): Document REQUIRED field error handling for BigQuery BYOT#18188inkeep[bot] wants to merge 1 commit into
inkeep[bot] wants to merge 1 commit into
Conversation
Add notes in Events and Persons model sections warning that custom tables with REQUIRED fields will cause non-retryable errors when NULL values are encountered. Add FAQ entry with resolution steps. Ref: PostHog/posthog#68534
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 13 warnings, 1 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 57:255 | warning | Use bold (text) for UI elements, not quotes. | PostHogDocs.UIBoldNotQuotes |
| 81:178 | warning | Use bold (text) for UI elements, not quotes. | PostHogDocs.UIBoldNotQuotes |
| 124:3 | warning | Use 'UUID' instead of 'uuid'. | Vale.Terms |
| 130:69 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 132:3 | warning | 'ip' is a possible misspelling. | PostHogBase.Spelling |
| 164:44 | warning | 'nullable' is a possible misspelling. | PostHogBase.Spelling |
| 172:57 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 174:57 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 201:44 | warning | 'nullable' is a possible misspelling. | PostHogBase.Spelling |
| 262:4 | warning | 'FAQ' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 285:292 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 287:289 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 295:65 | warning | 'nullable' is a possible misspelling. | PostHogBase.Spelling |
| 301:45 | warning | 'nullable' is a possible misspelling. | PostHogBase.Spelling |
Contributor
Bundle reportTotal JS (gzip)6.29 MiB (no change) Eager graph (static-import closure per entrypoint)
Largest modules in the
|
| Module | Size |
|---|---|
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
707.7 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
585.5 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js |
458.1 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.cjs.js |
364.8 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./src/hooks/useCustomers.tsx + 54 modules |
353.9 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./src/components/ProductComparisonTable/index.tsx + 116 modules |
267.6 KiB |
./node_modules/.pnpm/@codesandbox+sandpack-react@2.20.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@codesandbox/sandpack-react/dist/index.mjs |
266.6 KiB |
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules |
247.4 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
239.9 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes.
Contributor
|
Hey @tomasfarias! This docs PR was generated for you by an agent. You're responsible for reviewing and merging it into production.
|
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
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.
Changes
Documents the new error handling behavior introduced in PostHog/posthog#68534 for BigQuery batch exports when customers bring their own tables (BYOT) with REQUIRED fields.
Updates made
Events model section — Added a note warning that PostHog creates all columns as nullable, and that using REQUIRED fields in a custom table will cause the batch export to fail with a non-retryable error.
Persons model section — Added the same note for consistency.
FAQ section — Added a new entry "What happens if I create my own table with REQUIRED fields?" explaining:
Context
When customers create their own BigQuery tables with REQUIRED (NOT NULL) fields, and PostHog data contains NULL values for those fields, the batch export now raises a non-retryable error prompting users to update their schema. This prevents infinite retries and provides a clear error message.
This PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.