Welcome to sqlalchemy-querybuilder’s documentation
sqlalchemy-querybuilder is a package that implements a sqlalchemy query builder for rules generated with (but not limited to) jQuery QueryBuilder.
- Open Source: Apache 2.0 license.
- Website: https://sr.ht/~ocurero/sqlalchemy-querybuilder/.
- Documentation: https://sqlalchemy-querybuilder.readthedocs.io/.
- Repository (mercurial): https://hg.sr.ht/~ocurero/sqlalchemy-querybuilder.
Quick start
Parsing rules using sqlalchemy-querybuilder is very simple:
from sqlalchemy_querybuilder import Filter
from myapp import models, query
rules = {
"condition": "OR",
"rules": [{
"field": "mytable.myfield",
"operator": "equal",
"value": "foo"
},
],
}
myfilter = Filter(models, query)
print(myfilter.querybuilder(rules))
That would produce the following SQL query:
SELECT * FROM mytable WHERE mytable.myfield = 'foo'
The following attributes from the rules are ignored and therefore can be omitted:
id
type
input
Warning
There's no rule syntax validation. Rules should be compatible with jquery QueryBuilder.