Welcome to jonq’s documentation!

jonq is a Python tool that provides a SQL-like syntax for querying JSON files, built as a wrapper around the powerful jq utility. It simplifies JSON querying for users familiar with SQL, making it easier to extract and manipulate data without needing to master jq’s complex syntax.

Contents:

• Installation
  • Prerequisites
  • Installing jq
  • Installing jonq
  • Development Installation
• Usage
  • Overview
  • Query Syntax Breakdown
  • Field Selection
  • FROM Clause
  • Filtering with Conditions
  • Sorting and Limiting
  • Aggregation Functions
  • Grouping Data
  • Having Clause
  • Output Formats
  • Optional
  • Handling Large Files
  • Tips and Tricks
  • Best Practices
  • Known Limitations
• usage in python
  • Using jonq_fast
  • Calling jonq via subprocess
  • Additional Considerations
• Comparison
• Examples
  • Simple JSON
  • Nested JSON
  • Complex JSON
• API Reference
  • Main Module (jonq.main)
  • Query Parser (jonq.query_parser)
  • JQ Filter (jonq.jq_filter)
  • Executor (jonq.executor)
  • CSV Utils (jonq.csv_utils)
• Contributing
  • Setting Up Development Environment
  • Running Tests
  • Manual Testing
  • Contributing Code
  • Coding Style
  • Adding Documentation
  • Reporting Issues

Indices and tables

• Index

• Module Index

• Search Page