velaql

package
v1.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 12, 2025 License: Apache-2.0 Imports: 27 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// PatternQL is the pattern string of velaQL, velaQL's query syntax is `ViewName{key1=value1 ,key2="value2",}.Export`
	PatternQL = `(?P<view>[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?)(?P<parameter>{.*?})?\.?(?P<export>[_a-zA-Z][\._a-zA-Z0-9\[\]]*)?`
	// PatternKV is the pattern string of parameter
	PatternKV = `(?P<key>[^=]+)=(?P<value>[^=]*?)(?:,|$)`
	// KeyWordView represent view keyword
	KeyWordView = "view"
	// KeyWordParameter represent parameter keyword
	KeyWordParameter = "parameter"
	// KeyWordTemplate represents template keyword
	KeyWordTemplate = "template"
	// KeyWordExport represent export keyword
	KeyWordExport = "export"
	// DefaultExportValue is the default Export value
	DefaultExportValue = "status"
)
View Source
const (

	// ViewTaskPhaseSucceeded means view task run succeeded.
	ViewTaskPhaseSucceeded = "succeeded"
)

Variables

View Source
var OutputsTemplate = `
{
    "outputs": [
        {
            "valueFrom": "%s",
            "name": "%s"
        }
    ]
}
`

OutputsTemplate output template

Functions

func ParseParameter

func ParseParameter(parameter string) (map[string]interface{}, error)

ParseParameter parse parameter to map[string]interface{}

func ParseViewIntoConfigMap added in v1.5.0

func ParseViewIntoConfigMap(ctx context.Context, viewStr, name string) (*v1.ConfigMap, error)

ParseViewIntoConfigMap parses a CUE string (representing a view) into a ConfigMap ready to be stored into etcd.

func StoreViewFromFile added in v1.5.0

func StoreViewFromFile(ctx context.Context, c client.Client, path, viewName string) error

StoreViewFromFile reads a view from the specified CUE file, and stores into a ConfigMap in vela-system namespace. So the user can use the view in VelaQL later.

By saying file, it can actually be a file, URL, or stdin (-).

func ValidateView added in v1.5.0

func ValidateView(ctx context.Context, viewStr string) error

ValidateView makes sure the cue provided can use as view.

For now, we only check 1. cue is valid 2. `status` or `view` field exists

Types

type QueryParameterKey

type QueryParameterKey struct {
	Outputs workflowv1alpha1.StepOutputs `json:"outputs"`
}

QueryParameterKey query parameter key

type QueryView

type QueryView struct {
	View      string
	Parameter map[string]interface{}
	Export    string
}

QueryView contains query data

func ParseVelaQL

func ParseVelaQL(ql string) (QueryView, error)

ParseVelaQL parse velaQL to QueryView

func ParseVelaQLFromPath added in v1.4.4

func ParseVelaQLFromPath(ctx context.Context, velaQLViewPath string) (*QueryView, error)

ParseVelaQLFromPath will parse a velaQL file path to QueryView

type ViewHandler

type ViewHandler struct {
	// contains filtered or unexported fields
}

ViewHandler view handler

func NewViewHandler

func NewViewHandler(cli client.Client, cfg *rest.Config) *ViewHandler

NewViewHandler new view handler

func (*ViewHandler) QueryView

func (handler *ViewHandler) QueryView(ctx context.Context, qv QueryView) (cue.Value, error)

QueryView generate view step

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳