Function MetadataSet

metadata.go:26–38

MetadataSet records a metadata value to be merged into the job's metadata when the current work attempt finishes. This function is only valid from a worker, worker middleware, or work hook like rivertype.HookWorkBegin or rivertype.HookWorkEnd. Metadata updates are stored on the work context and me

(ctx context.Context, key string, value any)

// Keys prefixed with `river:` are reserved for internal use and may not be set
// by user code.
func MetadataSet(ctx context.Context, key string, value any) error {
	if strings.HasPrefix(key, "river:") {
		return errors.New("MetadataSet cannot be used with keys prefixed with `river:`")
	}

	metadataUpdates, ok := jobexecutor.MetadataUpdatesFromWorkContext(ctx)
	if !ok {
		return errMetadataNotSettable
	}

	metadataUpdates[key] = value
	return nil
}