Queries

See the config-artifact guide for how to add, register, and deploy queries. This page covers how to name them.

Query file & display names

These conventions apply to both saved queries and user queries.

Query file names are always lower_snake_case. Query display names avoid special characters. Write them in a friendly way, with spaces.

System-invoked queries

Queries that are invoked by the system (rather than shown to users) use lower_snake_case for their display name as well, and are prefixed with two underscores (__).

Examples

User-facing query:

file:    find_all_changes.xml
display: Find all changes

System query:

file:    __has_pdf_dataset.xml
display: __has_pdf_dataset