Function RecordOutput

recorded_output.go:53–70

RecordOutput records output JSON from a job. The "output" can be any JSON-encodable value and will be stored in the database on the job row after the current execution attempt completes. Output may be useful for debugging, or for storing the result of a job temporarily without needing to create a de

(ctx context.Context, output any)

// The output is marshalled to JSON as part of this function and it will return
// an error if the output is not JSON-encodable.
func RecordOutput(ctx context.Context, output any) error {
	metadataUpdates, hasMetadataUpdates := jobexecutor.MetadataUpdatesFromWorkContext(ctx)
	if !hasMetadataUpdates {
		return errors.New("RecordOutput must be called within a Worker")
	}

	outputBytes, err := json.Marshal(output)
	if err != nil {
		return err
	}

	if err := checkOutputSize(outputBytes); err != nil {
		return err
	}

	metadataUpdates[rivertype.MetadataKeyOutput] = json.RawMessage(outputBytes)
	return nil
}

// Postgres JSONB is limited to 255MB, but it would be a bad idea to get
// anywhere close to that limit for output.