https://github.com/cadawg/gormqueryfromjson
Gorm Query from JSON allows you to take a JSON query and convert it into SQL via GORM
https://github.com/cadawg/gormqueryfromjson
gorm json jsonquery jsontosql mongodb query sql
Last synced: 10 months ago
JSON representation
Gorm Query from JSON allows you to take a JSON query and convert it into SQL via GORM
- Host: GitHub
- URL: https://github.com/cadawg/gormqueryfromjson
- Owner: CADawg
- License: gpl-3.0
- Created: 2024-08-08T21:36:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-10T17:26:23.000Z (over 1 year ago)
- Last Synced: 2025-04-04T00:51:17.570Z (10 months ago)
- Topics: gorm, json, jsonquery, jsontosql, mongodb, query, sql
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gorm Query from JSON
Want your users to be able to perform advanced searches on your database without all the hassle of handling each individual input - just provide a schema and the library will validate that your users are only doing queries you permit.
# Install
`go get github.com/CADawg/GormQueryFromJson`
# Usage
Set maximum levels of recursion
```go
GormQueryFromJson.MaxDepth = 10
```
Define a schema
```go
var mainSchema = []GormQueryFromJson.AcceptableQueryTypes{
{
ColumnName: "id",
QueryTypes: []query.TypeIdentifier{GormQueryFromJson.TypeNumber},
Limit: 1,
},
{
ColumnName: "actor",
QueryTypes: []query.TypeIdentifier{GormQueryFromJson.TypeString, GormQueryFromJson.TypeStrictString},
Limit: 10,
},
{
ColumnName: "target",
QueryTypes: []query.TypeIdentifier{GormQueryFromJson.TypeString, GormQueryFromJson.TypeStrictString},
Limit: 10,
}
}
```
- Limit sets the maximum times this column can be targeted in a query.
- QueryTypes defines what queries can be run against the column
- Or Is not a type of query for this purpose, only its children count
Define an endpoint like so
```go
http.HandleFunc("POST /testQuery", func(res http.ResponseWriter, req *http.Request) {
var queries []query.JSON
err := json.NewDecoder(req.Body).Decode(&queries)
if err != nil {
http.Error(res, fmt.Sprintf("Error: %v", err), http.StatusBadRequest)
return
}
statement := db.ToSQL(func(tx *gorm.DB) *gorm.DB {
// use gorm to create a sql query and print out the statement
tx = tx.Model(&types.HistoryEntry{}).Limit(100)
// !!! This is our function
tx, _, err = GormQueryFromJson.DoQuery(queries, tx, mainSchema)
return tx.Find(&[]types.HistoryEntry{})
})
if err != nil {
http.Error(res, fmt.Sprintf("Error: %v", err), http.StatusBadRequest)
return
}
_, err = res.Write([]byte(statement))
})
```
You can use it however you like, just make sure that you have not placed any existing where conditions on the query. You can do so after calling DoQuery
# Queries (User Side)
```json
[
{
"type": "or",
"query": [
{
"type": "string",
"query": {
"column": "target",
"contains": "user2"
}
},
{
"type": "string",
"query": {
"column": "target",
"contains": "user1"
}
}
]
},
{
"type": "or",
"query": [
{
"type": "string",
"query": {
"column": "actor",
"contains": "user3"
}
},
{
"type": "string",
"query": {
"column": "target",
"contains": "user4"
}
}
]
},
{
"type": "number",
"query": {
"column": "id",
"greaterThanOrEqual": 5000000
}
}
]
```
-> SQL (Where Clauses generated by above)
```sql
SELECT * FROM `table` WHERE (target LIKE '%user2%' OR target LIKE '%user1%') AND (actor LIKE '%user3%' OR target LIKE '%user4%') AND id >= 5000000
```
If any columns you have not allowed are included or the amount is above the limit, those where clauses will be discarded.