Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thedevsaddam/gojsonq
A simple Go package to Query over JSON/YAML/XML/CSV Data
https://github.com/thedevsaddam/gojsonq
go-json go-json-query go-query gojsonq gojsonquery golang-json golang-json-query golang-query json json-query jsonq query
Last synced: 7 days ago
JSON representation
A simple Go package to Query over JSON/YAML/XML/CSV Data
- Host: GitHub
- URL: https://github.com/thedevsaddam/gojsonq
- Owner: thedevsaddam
- License: mit
- Created: 2018-05-19T16:15:18.000Z (over 6 years ago)
- Default Branch: v2
- Last Pushed: 2022-11-28T11:29:44.000Z (almost 2 years ago)
- Last Synced: 2024-07-31T20:52:46.148Z (3 months ago)
- Topics: go-json, go-json-query, go-query, gojsonq, gojsonquery, golang-json, golang-json-query, golang-query, json, json-query, jsonq, query
- Language: Go
- Homepage: https://github.com/thedevsaddam/gojsonq/wiki
- Size: 267 KB
- Stars: 2,168
- Watchers: 31
- Forks: 140
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-go - gojsonq - A simple Go package to Query over JSON Data. (Query Language / HTTP Clients)
- zero-alloc-awesome-go - gojsonq - A simple Go package to Query over JSON Data. (Query Language / HTTP Clients)
- go-awesome - gojsonq - JSON/YAML/XML/CSV and other data queries (Open source library / JSON)
- awesome-go - gojsonq - A simple Go package to Query over JSON Data. Stars:`2.2K`. (Query Language / HTTP Clients)
- awesome-go - gojsonq - A simple Go package to Query over JSON Data - ★ 450 (Query Language)
- awesome-go-extra - gojsonq - 05-19T16:15:18Z|2022-08-15T03:25:59Z| (Query Language / HTTP Clients)
- awesome-go-zh - gojsonq
README
[](https://travis-ci.org/thedevsaddam/gojsonq)
[](https://github.com/thedevsaddam/gojsonq/releases)
[](https://goreportcard.com/report/github.com/thedevsaddam/gojsonq)
[](https://coveralls.io/github/thedevsaddam/gojsonq)
[](https://pkg.go.dev/github.com/thedevsaddam/gojsonq/v2)
[](LICENSE.md)
A simple Go package to Query over JSON Data. It provides [simple](https://github.com/thedevsaddam/gojsonq/wiki/Queries#jsonstringjson), [elegant](https://github.com/thedevsaddam/gojsonq/wiki/Queries#selectproperties) and [fast](https://github.com/thedevsaddam/gojsonq/wiki/Benchmark) [ODM](https://github.com/thedevsaddam/gojsonq/wiki/Queries#frompath) like API to access, query JSON document
### Installation
Install the package using
```go
$ go get github.com/thedevsaddam/gojsonq/v2
```
### Usage
To use the package import it in your `*.go` code
```go
import "github.com/thedevsaddam/gojsonq/v2"
```
Let's see a quick example:
[See in playground](https://play.golang.org/p/UiqyllP2vkn)
```go
package main
import gojsonq "github.com/thedevsaddam/gojsonq/v2"
func main() {
const json = `{"name":{"first":"Tom","last":"Hanks"},"age":61}`
name := gojsonq.New().FromString(json).Find("name.first")
println(name.(string)) // Tom
}
```
Another example:
[See in playground](https://play.golang.org/p/QLVxpi6nVbi)
```go
package main
import (
"fmt"
gojsonq "github.com/thedevsaddam/gojsonq/v2"
)
func main() {
const json = `{"city":"dhaka","type":"weekly","temperatures":[30,39.9,35.4,33.5,31.6,33.2,30.7]}`
avg := gojsonq.New().FromString(json).From("temperatures").Avg()
fmt.Printf("Average temperature: %.2f", avg) // 33.471428571428575
}
```
You can query your document using the various query methods such as **[Find](https://github.com/thedevsaddam/gojsonq/wiki/Queries#findpath)**, **[First](https://github.com/thedevsaddam/gojsonq/wiki/Queries#first)**, **[Nth](https://github.com/thedevsaddam/gojsonq/wiki/Queries#nthindex)**, **[Pluck](https://github.com/thedevsaddam/gojsonq/wiki/Queries#pluckproperty)**, **[Where](https://github.com/thedevsaddam/gojsonq/wiki/Queries#wherekey-op-val)**, **[OrWhere](https://github.com/thedevsaddam/gojsonq/wiki/Queries#orwherekey-op-val)**, **[WhereIn](https://github.com/thedevsaddam/gojsonq/wiki/Queries#whereinkey-val)**, **[WhereStartsWith](https://github.com/thedevsaddam/gojsonq/wiki/Queries#wherestartswithkey-val)**, **[WhereEndsWith](https://github.com/thedevsaddam/gojsonq/wiki/Queries#whereendswithkey-val)**, **[WhereContains](https://github.com/thedevsaddam/gojsonq/wiki/Queries#wherecontainskey-val)**, **[Sort](https://github.com/thedevsaddam/gojsonq/wiki/Queries#sortorder)**, **[GroupBy](https://github.com/thedevsaddam/gojsonq/wiki/Queries#groupbyproperty)**, **[SortBy](https://github.com/thedevsaddam/gojsonq/wiki/Queries#sortbyproperty-order)** and so on. Also you can aggregate data after query using **[Avg](https://github.com/thedevsaddam/gojsonq/wiki/Queries#avgproperty)**, **[Count](https://github.com/thedevsaddam/gojsonq/wiki/Queries#count)**, **[Max](https://github.com/thedevsaddam/gojsonq/wiki/Queries#maxproperty)**, **[Min](https://github.com/thedevsaddam/gojsonq/wiki/Queries#minproperty)**, **[Sum](https://github.com/thedevsaddam/gojsonq/wiki/Queries#sumproperty)** etc.
## Find more query API in [Wiki page](https://github.com/thedevsaddam/gojsonq/wiki/Queries)
## Bugs and Issues
If you encounter any bugs or issues, feel free to [open an issue at
github](https://github.com/thedevsaddam/gojsonq/issues).
Also, you can shoot me an email to
for hugs or bugs.
## Credit
Special thanks to [Nahid Bin Azhar](https://github.com/nahid) for the inspiration and guidance for the package. Thanks to [Ahmed Shamim Hasan Shaon](https://github.com/me-shaon) for his support from the very beginning.
## Contributors
* [Lenin Hasda](https://github.com/leninhasda)
* [Sadlil Rhythom](https://github.com/sadlil)
* [See contributors list here](https://github.com/thedevsaddam/gojsonq/graphs/contributors)
## Contribution
If you are interested to make the package better please send pull requests or create an issue so that others can fix.
[Read the contribution guide here](CONTRIBUTING.md)
## License
The **gojsonq** is an open-source software licensed under the [MIT License](LICENSE.md).