KeyColumnOperators
Specifies how to handle logical and comparison operators applied to Id and Key columns when constructing JQL filters. This property helps manage cases where invalid Id or Key values in JQL filters might otherwise lead to errors or unexpected results, particularly when paired with the UseJqlSearchEndpoint connection property on Jira Cloud.
Data Type
string
Default Value
"Server-Side"
Remarks
This property determines whether certain logical and comparison operators are processed on the server or handled client-side for Id and Key columns.
When set to Server-Side (default):
- All supported operators are sent as-is to the Jira API.
- On legacy endpoints when UseJqlSearchEndpoint is set to False, or on Jira Data Center, this may cause API errors if invalid filter values are provided.
- On Jira Cloud with UseJqlSearchEndpoint set to True, the Jira API endpoint instead of throwing an error returns 0 results for filters involving invalid keys or IDs. For example, a JQL filter such as id > 123 (when 123 is not a valid issue ID) will return 0 results rather than an error. This behavior may lead to inconsistent outcomes if you expect a valid result set.
When set to Client-Side, the following operators are handled client-side rather than being included in the JQL sent to the Jira API:
- Logical operator: OR
- Comparison operators: IN, NOT IN, >, >=, <, <=, !=
This avoids inconsistencies caused by strict server-side filtering, such as entire queries failing if a single invalid key is included in an IN clause. Additionally, when using the IN operator on Id or Key, the query will be split into multiple individual requests, one per value.
For example:
SELECT * FROM Issues WHERE Id IN (111, 112, 113)
This results in three separate API calls, one for each Id, ensuring valid results are returned even if some values are invalid. However, this client-side handling may result in longer query times due to executing multiple requests when using IN or retrieving and filtering large datasets locally due to the lack of server-side filtering.