textquery

Documentation

Index

• func JQ[B ~byte, T stringhelper.String[B]](query string, data T) (string, error)
• func MarshalJsonOrYamlQueryResult(result []any, marshalFunc func(in any) ([]byte, error)) string
• func Query(query string, extraValues []any, nextDoc DocIterFunc, ...) (err error)
• func RunQuery(query *gojq.Query, object any, extraValues []any, ...) (ret []any, err error)
• func YQ[B ~byte, T stringhelper.String[B]](query string, data T) (string, error)
• type DocIterFunc
  • func NewJSONIterFunc(r io.Reader) DocIterFunc
  • func NewYAMLIterFunc(r io.Reader) DocIterFunc
• type QueryResultHandleFunc
  • func CreateResultToTextHandleFuncForJsonOrYaml(output io.StringWriter, marshalFunc func(in any) ([]byte, error)) QueryResultHandleFunc

Functions

func JQ

func JQ[B ~byte, T stringhelper.String[B]](query string, data T) (string, error)

JQ runs jq over json data

func MarshalJsonOrYamlQueryResult

func MarshalJsonOrYamlQueryResult(
	result []any,
	marshalFunc func(in any) ([]byte, error),
) string

MarshalJsonOrYamlQueryResult from RunQuery

func Query

func Query(
	query string,
	extraValues []any,
	nextDoc DocIterFunc,
	handleResult QueryResultHandleFunc,
	options ...gojq.CompilerOption,
) (err error)

Query is a generic jq query wrapper

func RunQuery

func RunQuery(
	query *gojq.Query,
	object any,
	extraValues []any,
	options ...gojq.CompilerOption,
) (ret []any, err error)

RunQuery runs jq query over an object (map, slice)

if options contains gojq.WithVariables, length of extraValues should match variable count

func YQ

func YQ[B ~byte, T stringhelper.String[B]](query string, data T) (string, error)

YQ runs jq over yaml data

Types

type DocIterFunc

type DocIterFunc = func() (any, bool)

DocIterFunc unmarshals next available doc into golang any object (map, slice) return true when there is doc available, otherwise false

func NewJSONIterFunc

func NewJSONIterFunc(r io.Reader) DocIterFunc

func NewYAMLIterFunc

func NewYAMLIterFunc(r io.Reader) DocIterFunc

type QueryResultHandleFunc

type QueryResultHandleFunc = func(data any, result []any, queryErr error) error

QueryResultHandleFunc handles each query result NOTE: result can be a empty/nil slice when there was no matched content or query returned nothing

func CreateResultToTextHandleFuncForJsonOrYaml

func CreateResultToTextHandleFuncForJsonOrYaml(
	output io.StringWriter,
	marshalFunc func(in any) ([]byte, error),
) QueryResultHandleFunc