Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new filters type in the query of the state component #3218

Merged
merged 2 commits into from
Dec 6, 2023
Merged

Add new filters type in the query of the state component #3218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d6cbf3
Add NEQ,GT,GTE,LT and LTE Operation in the query for MongoDB, Redis, …
luigirende Nov 28, 2023
1567e22
Merge branch 'main' into state-update-filters-query
berndverst Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
100 changes: 100 additions & 0 deletions common/component/postgresql/postgresql_query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,46 @@ func (q *Query) VisitEQ(f *query.EQ) (string, error) {
return q.whereFieldEqual(f.Key, f.Val), nil
}

func (q *Query) VisitNEQ(f *query.NEQ) (string, error) {
return q.whereFieldNotEqual(f.Key, f.Val), nil
}

func (q *Query) VisitGT(f *query.GT) (string, error) {
switch v := f.Val.(type) {
case string:
return "", fmt.Errorf("unsupported type of value %s; string type not permitted", v)
default:
return q.whereFieldGreaterThan(f.Key, v), nil
}
}

func (q *Query) VisitGTE(f *query.GTE) (string, error) {
switch v := f.Val.(type) {
case string:
return "", fmt.Errorf("unsupported type of value %s; string type not permitted", v)
default:
return q.whereFieldGreaterThanEqual(f.Key, v), nil
}
}

func (q *Query) VisitLT(f *query.LT) (string, error) {
switch v := f.Val.(type) {
case string:
return "", fmt.Errorf("unsupported type of value %s; string type not permitted", v)
default:
return q.whereFieldLessThan(f.Key, v), nil
}
}

func (q *Query) VisitLTE(f *query.LTE) (string, error) {
switch v := f.Val.(type) {
case string:
return "", fmt.Errorf("unsupported type of value %s; string type not permitted", v)
default:
return q.whereFieldLessThanEqual(f.Key, v), nil
}
}

func (q *Query) VisitIN(f *query.IN) (string, error) {
if len(f.Vals) == 0 {
return "", fmt.Errorf("empty IN operator for key %q", f.Key)
Expand Down Expand Up @@ -70,6 +110,31 @@ func (q *Query) visitFilters(op string, filters []query.Filter) (string, error)
return "", err
}
arr = append(arr, str)
case *query.NEQ:
if str, err = q.VisitNEQ(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.GT:
if str, err = q.VisitGT(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.GTE:
if str, err = q.VisitGTE(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.LT:
if str, err = q.VisitLT(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.LTE:
if str, err = q.VisitLTE(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.IN:
if str, err = q.VisitIN(f); err != nil {
return "", err
Expand Down Expand Up @@ -214,3 +279,38 @@ func (q *Query) whereFieldEqual(key string, value interface{}) string {
query := filterField + "=$" + strconv.Itoa(position)
return query
}

func (q *Query) whereFieldNotEqual(key string, value interface{}) string {
position := q.addParamValueAndReturnPosition(value)
filterField := translateFieldToFilter(key)
query := filterField + "!=$" + strconv.Itoa(position)
return query
}

func (q *Query) whereFieldGreaterThan(key string, value interface{}) string {
position := q.addParamValueAndReturnPosition(value)
filterField := translateFieldToFilter(key)
query := filterField + ">$" + strconv.Itoa(position)
return query
}

func (q *Query) whereFieldGreaterThanEqual(key string, value interface{}) string {
position := q.addParamValueAndReturnPosition(value)
filterField := translateFieldToFilter(key)
query := filterField + ">=$" + strconv.Itoa(position)
return query
}

func (q *Query) whereFieldLessThan(key string, value interface{}) string {
position := q.addParamValueAndReturnPosition(value)
filterField := translateFieldToFilter(key)
query := filterField + "<$" + strconv.Itoa(position)
return query
}

func (q *Query) whereFieldLessThanEqual(key string, value interface{}) string {
position := q.addParamValueAndReturnPosition(value)
filterField := translateFieldToFilter(key)
query := filterField + "<=$" + strconv.Itoa(position)
return query
}
8 changes: 8 additions & 0 deletions common/component/postgresql/postgresql_query_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,18 @@ func TestPostgresqlQueryBuildQuery(t *testing.T) {
input: "../../../tests/state/query/q4.json",
query: "SELECT key, value, xmin as etag FROM state WHERE (value->'person'->>'org'=$1 OR (value->'person'->>'org'=$2 AND (value->>'state'=$3 OR value->>'state'=$4))) ORDER BY value->>'state' DESC, value->'person'->>'name' LIMIT 2",
},
{
input: "../../../tests/state/query/q4-notequal.json",
query: "SELECT key, value, xmin as etag FROM state WHERE (value->'person'->>'org'=$1 OR (value->'person'->>'org'!=$2 AND (value->>'state'=$3 OR value->>'state'=$4))) ORDER BY value->>'state' DESC, value->'person'->>'name' LIMIT 2",
},
{
input: "../../../tests/state/query/q5.json",
query: "SELECT key, value, xmin as etag FROM state WHERE (value->'person'->>'org'=$1 AND (value->'person'->>'name'=$2 OR (value->>'state'=$3 OR value->>'state'=$4))) ORDER BY value->>'state' DESC, value->'person'->>'name' LIMIT 2",
},
{
input: "../../../tests/state/query/q8.json",
query: "SELECT key, value, xmin as etag FROM state WHERE (value->'person'->>'org'>=$1 OR (value->'person'->>'org'<$2 AND (value->>'state'=$3 OR value->>'state'=$4))) ORDER BY value->>'state' DESC, value->'person'->>'name' LIMIT 2",
},
}
for _, test := range tests {
data, err := os.ReadFile(test.input)
Expand Down
37 changes: 36 additions & 1 deletion state/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,31 @@ type FilterEQ struct {
Val interface{}
}

type FilterNEQ struct {
Key string
Val interface{}
}

type FilterGT struct {
Key string
Val interface{}
}

type FilterGTE struct {
Key string
Val interface{}
}

type FilterLT struct {
Key string
Val interface{}
}

type FilterLTE struct {
Key string
Val interface{}
}

type FilterIN struct {
Key string
Vals []interface{}
Expand All @@ -100,6 +125,16 @@ To simplify the process of query translation, we leveraged [visitor design patte
type Visitor interface {
// returns "equal" expression
VisitEQ(*FilterEQ) (string, error)
// returns "not equal" expression
VisitNEQ(*FilterNEQ) (string, error)
// returns "greater than" expression
VisitGT(*FilterGT) (string, error)
// returns "greater than equal" expression
VisitGTE(*FilterGTE) (string, error)
// returns "less than" expression
VisitLT(*FilterLT) (string, error)
// returns "less than equal" expression
VisitLTE(*FilterLTE) (string, error)
// returns "in" expression
VisitIN(*FilterIN) (string, error)
// returns "and" expression
Expand Down Expand Up @@ -152,4 +187,4 @@ func (m *MyComponent) Query(req *state.QueryRequest) (*state.QueryResponse, erro
}
```

Some of the examples of State Query API implementation are [MongoDB](./mongodb/mongodb_query.go) and [CosmosDB](./azure/cosmosdb/cosmosdb_query.go) state store components.
Some of the examples of State Query API implementation are [Redis](./redis/redis_query.go), [MongoDB](./mongodb/mongodb_query.go) and [CosmosDB](./azure/cosmosdb/cosmosdb_query.go) state store components.
109 changes: 109 additions & 0 deletions state/azure/cosmosdb/cosmosdb_query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,76 @@ func (q *Query) VisitEQ(f *query.EQ) (string, error) {
return replaceKeywords("c.value."+f.Key) + " = " + name, nil
}

func (q *Query) VisitNEQ(f *query.NEQ) (string, error) {
// <key> != <val>
val, ok := f.Val.(string)
if !ok {
return "", fmt.Errorf("unsupported type of value %#v; expected string", f.Val)
}
name := q.setNextParameter(val)

return replaceKeywords("c.value."+f.Key) + " != " + name, nil
}

func (q *Query) VisitGT(f *query.GT) (string, error) {
// <key> > <val>
var name string
switch value := f.Val.(type) {
case int:
name = q.setNextParameterInt(value)
case float64:
name = q.setNextParameterFloat(value)
default:
return "", fmt.Errorf("unsupported type of value %#v; expected number", f.Val)
}
return replaceKeywords("c.value."+f.Key) + " > " + name, nil
}

func (q *Query) VisitGTE(f *query.GTE) (string, error) {
// <key> >= <val>
var name string
switch value := f.Val.(type) {
case int:
name = q.setNextParameterInt(value)
case float64:
name = q.setNextParameterFloat(value)
default:
return "", fmt.Errorf("unsupported type of value %#v; expected number", f.Val)
}

return replaceKeywords("c.value."+f.Key) + " >= " + name, nil
}

func (q *Query) VisitLT(f *query.LT) (string, error) {
// <key> < <val>
var name string
switch value := f.Val.(type) {
case int:
name = q.setNextParameterInt(value)
case float64:
name = q.setNextParameterFloat(value)
default:
return "", fmt.Errorf("unsupported type of value %#v; expected number", f.Val)
}

return replaceKeywords("c.value."+f.Key) + " < " + name, nil
}

func (q *Query) VisitLTE(f *query.LTE) (string, error) {
// <key> <= <val>
var name string
switch value := f.Val.(type) {
case int:
name = q.setNextParameterInt(value)
case float64:
name = q.setNextParameterFloat(value)
default:
return "", fmt.Errorf("unsupported type of value %#v; expected number", f.Val)
}

return replaceKeywords("c.value."+f.Key) + " <= " + name, nil
}

func (q *Query) VisitIN(f *query.IN) (string, error) {
// <key> IN ( <val1>, <val2>, ... , <valN> )
if len(f.Vals) == 0 {
Expand Down Expand Up @@ -80,6 +150,31 @@ func (q *Query) visitFilters(op string, filters []query.Filter) (string, error)
return "", err
}
arr = append(arr, str)
case *query.NEQ:
if str, err = q.VisitNEQ(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.GT:
if str, err = q.VisitGT(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.GTE:
if str, err = q.VisitGTE(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.LT:
if str, err = q.VisitLT(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.LTE:
if str, err = q.VisitLTE(f); err != nil {
return "", err
}
arr = append(arr, str)
case *query.IN:
if str, err = q.VisitIN(f); err != nil {
return "", err
Expand Down Expand Up @@ -144,6 +239,20 @@ func (q *Query) setNextParameter(val string) string {
return pname
}

func (q *Query) setNextParameterInt(val int) string {
pname := fmt.Sprintf("@__param__%d__", len(q.query.parameters))
q.query.parameters = append(q.query.parameters, azcosmos.QueryParameter{Name: pname, Value: val})

return pname
}

func (q *Query) setNextParameterFloat(val float64) string {
pname := fmt.Sprintf("@__param__%d__", len(q.query.parameters))
q.query.parameters = append(q.query.parameters, azcosmos.QueryParameter{Name: pname, Value: val})

return pname
}

func (q *Query) execute(ctx context.Context, client *azcosmos.ContainerClient) ([]state.QueryItem, string, error) {
opts := &azcosmos.QueryOptions{}

Expand Down
48 changes: 48 additions & 0 deletions state/azure/cosmosdb/cosmosdb_query_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,54 @@ func TestCosmosDbQuery(t *testing.T) {
},
},
},
{
input: "../../../tests/state/query/q4-notequal.json",
query: InternalQuery{
query: "SELECT * FROM c WHERE c['value']['person']['org'] = @__param__0__ OR (c['value']['person']['org'] != @__param__1__ AND c['value']['state'] IN (@__param__2__, @__param__3__)) ORDER BY c['value']['state'] DESC, c['value']['person']['name'] ASC",
parameters: []azcosmos.QueryParameter{
{
Name: "@__param__0__",
Value: "A",
},
{
Name: "@__param__1__",
Value: "B",
},
{
Name: "@__param__2__",
Value: "CA",
},
{
Name: "@__param__3__",
Value: "WA",
},
},
},
},
{
input: "../../../tests/state/query/q8.json",
query: InternalQuery{
query: "SELECT * FROM c WHERE c['value']['person']['org'] >= @__param__0__ OR (c['value']['person']['org'] < @__param__1__ AND c['value']['state'] IN (@__param__2__, @__param__3__)) ORDER BY c['value']['state'] DESC, c['value']['person']['name'] ASC",
parameters: []azcosmos.QueryParameter{
{
Name: "@__param__0__",
Value: 123.0,
},
{
Name: "@__param__1__",
Value: 10.0,
},
{
Name: "@__param__2__",
Value: "CA",
},
{
Name: "@__param__3__",
Value: "WA",
},
},
},
},
}
for _, test := range tests {
data, err := os.ReadFile(test.input)
Expand Down