Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/store
MPopulationBudget.ConsumeDocument

Go packages

riducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder

TypeScript packages

@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
Allstoreriducorefieldqueryschemastoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 146HealthStoreAuthPruneResult.TotalDeleteRestrictedError.ErrorDeleteRestrictedError.IsPopulationBudget.ConsumeDocumentValue.BooleanValueValue.DocumentValueValue.Kind

method

PopulationBudget.ConsumeDocument

func (budget *PopulationBudget) ConsumeDocument(document Document) error

ConsumeDocument reserves enough budget for document and every populated document already nested beneath it. The reservation happens before an adapter deep-clones the document into its parent response.

Source store/population.go:28

@param document
The document value.
@returns
The declared result.

Related types

  • PopulationBudget

    A shared recursive population materialization budget.

  • Document

    A stored document with status and version metadata.