Kaquel 0.3.1¶

Kaquel, pronounced /kækyɛl/, is a toolset for parsing and rendering query languages for ElasticSearch.

You can also find the project on the following locations:

kaquel/kaquel repository on Gitlab;
kaquel project on PyPI.

The project’s code and documentation contents are licensed under CeCILL-C as distributed by the CEA, CNRS and Inria on cecill.info.

This documentation is organized using Diátaxis’ structure.

How-to guides¶

These sections provide guides, i.e. recipes, targeted towards various actors. They guide you through the steps involved in addressing key problems and use-cases.

General guides
- Installing Kaquel
  - pip (generic)
- Reporting a bug or vulnerability
  - Writing a bug or vulnerability report
  - Sending your bug or vulnerability report
Developer guides
- Parsing queries
- Rendering queries
  - Rendering queries as KQL

Discussion topics¶

These sections discuss key topics and concepts at a fairly high level, and provide useful background information and explanation.

Format descriptions

References¶

These sections provide technical reference for APIs and other aspects of Kaquel’s machinery. They go into detail, and therefore, assume you have a basic understanding of key concepts.

Code reference
- kaquel – main namespace for the project