Skip to content

how to use the CQL reference manual

Ryan Wisnesky edited this page Apr 15, 2019 · 2 revisions

Home

The CQL reference manual landing page is the GitHub repo's readme, containing basic CQL-related information. The bulk of the manual is divided into four sections:

Syntax

Each CQL kind is displayed in a section, with all the CQL keywords that yield CQL values of that kind written in the section. Clicking a keyword shows its principal typing and a short description, along with the options allowed for it and the built-in examples it occurs in.

Options

When each option is clicked, a short description appears, along with links to all the examples and keywords that use the option.

Examples

The verbatim text of each built-in example, along with HTML renderings of the output tables from execution, are displayed for each clicked on example.

Search

The search window performs simple conjunctive keyword search (looks for each keyword in the corresponding document) over all the files in the manual.