exampleutil

Documentation

Index

• func ExportProcessors()
• func RunExample(p sdk.Processor, e Example)
• type Example

Functions

func ExportProcessors

func ExportProcessors()

ExportProcessors exports the processors to the specs directory.

func RunExample

func RunExample(p sdk.Processor, e Example)

RunExample runs the given example with the given processor and logs the result. It is intended to be used in example functions. Additionally, it stores the processor specification and example in a global map so it can be used to generate documentation.

Types

type Example

type Example struct {
	// Order is an optional field that is used to order examples in the
	// documentation. If omitted, the example will be ordered by description.
	Order       int                 `json:"-"`
	Summary     string              `json:"summary"`
	Description string              `json:"description"`
	Config      config.Config       `json:"config"`
	Have        opencdc.Record      `json:"have"`
	Want        sdk.ProcessedRecord `json:"want"`
}