method

LocalAPI.MutateJoin

MutateJoin preserves the exact authenticated collection identity while applying inverse relationship deltas.

Arguments

ArgumentTypeDescription
ctxcontext.ContextThe ctx value.
collectionstringThe collection value.
idstringThe id value.
fieldstringThe field value.
additions[]stringThe additions value.
removals[]stringThe removals value.
optionsMutationOptionsThe options value.

Returns

The declared result.

(JoinMutationResult, error)

Full signature

func (local *LocalAPI) MutateJoin( ctx context.Context, collection, id, field string, additions, removals []string, options MutationOptions, ) (JoinMutationResult, error)

Source core/local.go:513

Related types

  • LocalAPI

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

  • MutationOptions

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

  • JoinMutationResult

    Result of one atomic inverse-relationship mutation.