textquery

package

v0.12.0 Latest Latest Go to latest Published: Dec 27, 2022 License: Apache-2.0 Imports: 8 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/arhat-dev/go-pkg

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 ¶ added in v0.10.0

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

MarshalJsonOrYamlQueryResult from RunQuery

func Query ¶ added in v0.5.8

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 ¶ added in v0.5.8

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

YQ runs jq over yaml data

Types ¶

type DocIterFunc ¶ added in v0.10.0

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 ¶ added in v0.10.0

func NewJSONIterFunc(r io.Reader) DocIterFunc

func NewYAMLIterFunc ¶ added in v0.10.0

func NewYAMLIterFunc(r io.Reader) DocIterFunc

type QueryResultHandleFunc ¶ added in v0.10.0

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 ¶ added in v0.10.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL