JIRA Development Cookbook - Third Edition

Writing a JQL function

As we have seen, a JQL function allows us to define custom expressions or searchers. JIRA has a set of built-in JQL functions, the details of which can be found at https://confluence.atlassian.com/jira/advanced-searching-functions-338363497.html#AdvancedSearchingFunctions-function. In this recipe, we will look at writing a new JQL function.

JQL functions provide a way for values within a JQL query to be calculated at runtime. It takes optional arguments and produces results based on these arguments at runtime.

In our example, let us consider creating a function projects(), which can take a list of project keys and return all issues in the supplied projects. For example:

project in projects("TEST", "DEMO")

It will be equivalent ...