method

LocalAPI.Update

Update updates a document and applies the requested bounded population plan to the response inside the write transaction.

Arguments

ArgumentTypeDescription
ctxcontext.ContextThe ctx value.
collectionstringThe collection value.
idstringThe id value.
valuesstore.ValuesThe values value.
optionsMutationOptionsThe options value.

Returns

The declared result.

(store.Document, error)

Full signature

func (local *LocalAPI) Update( ctx context.Context, collection, id string, values store.Values, options MutationOptions, ) (store.Document, error)

Source core/local.go:451

Related types

  • LocalAPI

    In-process content operations that share the REST authorization and lifecycle pipeline.

  • Values

    A map of field names to typed values.

  • MutationOptions

    Authorization, optimistic concurrency, response population, create status, and locale controls for one write.

  • Document

    A stored document with status and version metadata.