Skip to content

Commit a85432d

Browse files
authored
Update README.md
1 parent 8c6c642 commit a85432d

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,39 @@ print(jb.read(MY_BOX_ID, record_ids[0]))
5959
jb.delete(MY_BOX_ID, record_ids)
6060
```
6161

62+
## Query Params
63+
As supported (and documented) by https://github.com/vasanthv/jsonbox
64+
65+
You can query by constructing a query string and passing it to the `query` parameter:
66+
```
67+
name:arya%20stark,age:>13
68+
```
69+
The above sample will look for the name `arya stark` and age greater than 13.
70+
71+
You can filter on `Number`, `String` & `Boolean` values only.
72+
73+
#### Filters for Numeric values.
74+
75+
| | Sample |
76+
|----------------------------------------------------------------------|------------------------------|
77+
| To filter values greater than or less than a specific value | `q=age:>10` or `q=age:<10` |
78+
| To filter values greater (or less) than or equal to a specific value | `q=age:>=10` or `q=age:<=10` |
79+
| To filter values that match a specific value. | `q=age:=10` |
80+
81+
#### Filters for String values.
82+
83+
| | Sample |
84+
|--------------------------------------------------------------------|---------------------|
85+
| Filter values that start with a specific string | `q=name:arya*` |
86+
| Filter values that end with a specific string | `q=name:*stark` |
87+
| Filter values where a specific string appears anywhere in a string | `q=name:*ya*` |
88+
| Filter values that match a specific string | `q=name:arya%20stark` |
89+
90+
You can combine multiple fields by separating them with commas as shown below:
91+
```
92+
name:arya%20stark,age:>13,isalive:true
93+
```
94+
6295

6396
## License
6497
MIT

0 commit comments

Comments
 (0)