https://github.com/sanity-io/GROQ

Specification for GROQ - The Query Language for JSON
https://github.com/sanity-io/GROQ

json json-data query-language sanity-io

Last synced: about 2 months ago
JSON representation

Specification for GROQ - The Query Language for JSON

• Host: GitHub
• URL: https://github.com/sanity-io/GROQ
• Owner: sanity-io
• License: mit
• Created: 2019-06-26T16:23:22.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-25T22:20:58.000Z (4 months ago)
• Last Synced: 2024-12-01T03:33:04.578Z (2 months ago)
• Topics: json, json-data, query-language, sanity-io
• Language: JavaScript
• Homepage: https://groq.dev
• Size: 412 KB
• Stars: 399
• Watchers: 15
• Forks: 15
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GROQ specification

👉🏻 **Published versions of the spec can be viewed [here](https://spec.groq.dev)**.

This is the specification for GROQ (Graph-Relational Object Queries), a query language and execution engine made at [Sanity.io](https://www.sanity.io), for filtering and projecting JSON documents.

The work started in 2015, and the development of this open standard started in 2019.

Read the [announcement blog post](https://www.sanity.io/blog/we-re-open-sourcing-groq-a-query-language-for-json-documents) to understand more about the specification process and see the [getting started guide](https://www.sanity.io/docs/how-queries-work) to learn more about the language itself.

Go to [GROQ Arcade](https://groq.dev) to try out GROQ with any JSON data today!

## Tools and resources for GROQ

* [Syntax highlighting in VS Code](https://github.com/sanity-io/vscode-sanity).

* [Syntax highlighting in Sublime Text](https://github.com/alevroub/groq-syntax-highlighting).

* [GROQ tagged template literal](https://www.npmjs.com/package/groq), for writing GROQ queries in JavaScript files.

* [groq-cli](https://github.com/sanity-io/groq-cli), a command-line tool for running GROQ on files and URLs.

* [groq-js](https://github.com/sanity-io/groq-js), a JavaScript implementation of GROQ.

* [Go GROQ library](https://github.com/sanity-io/go-groq), a Go implementation of the GROQ parser.

* [groqfmt](https://github.com/sanity-io/groqfmt), a command-line formatter for GROQ, written in Go.

## Development of the specification

The specification is written using [spec-md](https://spec-md.com), a Markdown variant optimized for writing specifications.

The source is located under the `spec/`-directory which is then converted into HTML and presented at .

To ensure that implementations are compatible we write test cases in the [GROQ test suite](https://github.com/sanity-io/groq-test-suite).

The specification follows the versioning scheme of **GROQ-X.revisionY** where X (major) and Y (revision) are numbers:

- The first version is GROQ-1.revision0.

- Later revisions are always backwards compatible with earlier revisions in the same major version.

- Revisions can include everything from minor clarifications to whole new functionality.

- Major versions are used to introduce breaking changes.

## License

The specification is made available under the Open Web Foundation Final Specification Agreement (OWFa 1.0).