Skip to content

josuebrunel/clausify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

test coverage goreportcard gopkg license

Clausify

Clausify helps you turn you url query strings into SQL Where clause It supports SQL Comparison operators and some logical operators

Installation

go get github.com/josuebrunel/clausify

Quickstart

import (
    "github.com/josuebrunel/clausify"
    "net/url"
    "fmt"
)

u, _ := url.Parse("https://httpbin.org/[email protected]&age__gte=24&company=toto")

c, err := clausify.Clausify(u.Query())
if err != nil {
    // do whatever
}

fmt.Printf("%s\n", c.Conditions) // email like '?' AND age >= ? AND company = '?'
fmt.Printf("%v\n", c.Variables) // ["@toto.com", 24, "toto"]

Supported operators by the operators.DefaultOperator

Query string filters SQL Operators
element=value element = value OR element = 'value'
element__neq=value element != value OR element != 'value'
element__gt=value element > value
element__gte=value element >= value
element__lt=value element < value
element__lte=value element <= value
element__like=value element LIKE 'value'
element__ilike=value element ILIKE 'value'
element__nlike=value element NOT LIKE 'value'
element__in=value1,value2,valueN element IN (value1, value2, valueN)
element__nin=value1,value2,valueN element NOT IN (value1, value2, valueN)
element__between=left,right element BETWEEN left AND right
element__nbetween=left,right element NOT BETWEEN left AND right

GORM Example

c, _ = clausify.Clausify(u.Query())
db.Where(c.Conditions, c.Variables...).Find(&p)

Implement a custom Operator

Use a struct implementing Clausifier interface with Clausify method as below

import (
    "github.com/josuebrunel/clausify"
    "net/url"
    "strings"
    "testing"
    "errors"
)

type MyClausifier struct {
	Separator string
}

func (m MyClausifier) Clausify(k string, vv []string) (clause.Condition, error) {
	op := strings.Split(k, m.Separator)
	if op[1] == "<>" {
		return clause.Condition{
			Expression: clause.Concat(op[0], " <> ?"),
			Variables:  []interface{}{vv[0]},
		}, nil
	}
	return clause.Condition{}, errors.New("Invalid operator")
}

u, _ := url.Parse("https://httpbin.org/?id-<>=1")
q := u.Query()
c, _ := clausify.With(q, MyClausifier{Separator: "-"})
is.True(strings.Contains(c.Conditions, "id <> ?"))
is.Equal(len(c.Variables), 1)