querystring

README

go-querystring-parser

A golang Elasticsearch Querystring parser

Usage

import (
    querystring "github.com/bytedance/go-querystring-parser"
)

Then use:

query := "message: test\\ value AND datetime: [\"2020-01-01T00:00:00\" TO \"2020-12-31T00:00:00\"]"
ast, err := querystring.Parse(query)
if err != nil {
    // error handling
}

// do something with ast

The AST parsed from above querystring:

// print via github.com/davecgh/go-spew.Dump
(*querystring.AndCondition)(0xc00000c200)({
    Left: (*querystring.MatchCondition)(0xc00000c1e0)({
        Field: (string) (len=7) "message",
        Value: (string) (len=10) "test value"
    }),
    Right: (*querystring.TimeRangeCondition)(0xc000076750)({
        Field: (string) (len=8) "datetime",
        Start: (*string)(0xc0000545b0)((len=19) "2020-01-01T00:00:00"),
        End: (*string)(0xc0000545c0)((len=19) "2020-12-31T00:00:00"),
        IncludeStart: (bool) true,
        IncludeEnd: (bool) true
    })
})

For Developers

After edit querystring.y, gen code via run:

go generate

Documentation

Index

• type AndCondition
  • func NewAndCondition(left, right Condition) *AndCondition
• type Condition
  • func Parse(query string) (rq Condition, err error)
• type FieldableCondition
• type MatchCondition
  • func NewMatchCondition(s string) *MatchCondition
  • func (q *MatchCondition) SetField(field string)
• type NotCondition
  • func NewNotCondition(q Condition) *NotCondition
• type NumberRangeCondition
  • func NewNumberRangeCondition(start, end *string, includeStart, includeEnd bool) *NumberRangeCondition
  • func (q *NumberRangeCondition) SetField(field string)
• type OrCondition
  • func NewOrCondition(left, right Condition) *OrCondition
• type RegexpCondition
  • func NewRegexpCondition(s string) *RegexpCondition
  • func (q *RegexpCondition) SetField(field string)
• type TimeRangeCondition
  • func NewTimeRangeCondition(start, end *string, includeStart, includeEnd bool) *TimeRangeCondition
  • func (q *TimeRangeCondition) SetField(field string)
• type WildcardCondition
  • func NewWildcardCondition(s string) *WildcardCondition
  • func (q *WildcardCondition) SetField(field string)

Types

type AndCondition

type AndCondition struct {
	Left  Condition
	Right Condition
}

AndCondition .

func NewAndCondition

func NewAndCondition(left, right Condition) *AndCondition

NewAndCondition .

type Condition

type Condition interface {
}

Condition .

func Parse

func Parse(query string) (rq Condition, err error)

Parse querystring and return Condition

type FieldableCondition

type FieldableCondition interface {
	SetField(field string)
}

FieldableCondition .

type MatchCondition

type MatchCondition struct {
	Field string
	Value string
}

MatchCondition .

func NewMatchCondition

func NewMatchCondition(s string) *MatchCondition

NewMatchCondition .

func (*MatchCondition) SetField

func (q *MatchCondition) SetField(field string)

SetField .

type NotCondition

type NotCondition struct {
	Condition Condition
}

NotCondition .

func NewNotCondition

func NewNotCondition(q Condition) *NotCondition

NewNotCondition .

type NumberRangeCondition

type NumberRangeCondition struct {
	Field        string
	Start        *string
	End          *string
	IncludeStart bool
	IncludeEnd   bool
}

NumberRangeCondition .

func NewNumberRangeCondition

func NewNumberRangeCondition(start, end *string, includeStart, includeEnd bool) *NumberRangeCondition

NewNumberRangeCondition .

func (*NumberRangeCondition) SetField

func (q *NumberRangeCondition) SetField(field string)

SetField .

type OrCondition

type OrCondition struct {
	Left  Condition
	Right Condition
}

OrCondition .

func NewOrCondition

func NewOrCondition(left, right Condition) *OrCondition

NewOrCondition .

type RegexpCondition

type RegexpCondition struct {
	Field string
	Value string
}

RegexpCondition .

func NewRegexpCondition

func NewRegexpCondition(s string) *RegexpCondition

NewRegexpCondition .

func (*RegexpCondition) SetField

func (q *RegexpCondition) SetField(field string)

SetField .

type TimeRangeCondition

type TimeRangeCondition struct {
	Field        string
	Start        *string
	End          *string
	IncludeStart bool
	IncludeEnd   bool
}

TimeRangeCondition .

func NewTimeRangeCondition

func NewTimeRangeCondition(start, end *string, includeStart, includeEnd bool) *TimeRangeCondition

NewTimeRangeCondition .

func (*TimeRangeCondition) SetField

func (q *TimeRangeCondition) SetField(field string)

SetField .

type WildcardCondition

type WildcardCondition struct {
	Field string
	Value string
}

WildcardCondition .

func NewWildcardCondition

func NewWildcardCondition(s string) *WildcardCondition

NewWildcardCondition .

func (*WildcardCondition) SetField

func (q *WildcardCondition) SetField(field string)

SetField .