Initial support for JQL #721

doc-sheet · 2023-03-25T15:22:35Z

Hello.

There is some basic support for JQL, could you suggest some impovements?

For now it produces

project IN ("PROJ1","PROJ2") AND issuetype="My issue" AND (labels is EMPTY OR labels NOT IN ("stale","bug")) AND Привет is EMPTY AND repos is not EMPTY AND repos NOT IN ("main","dev")

for a query like this

J = JiraTable()
j = (
    JiraQueryBuilder()
    .where(J.project.isin(["PROJ1", "PROJ2"]))
    .where(J.issuetype == "My issue")
    .where(J.labels.isempty() | J.labels.notin(["stale", "bug"]))
    .where(getattr(J, "Привет").isempty())
    .where(J.repos.notempty() & J.repos.notin(["main", "dev"]))
)
print(j.get_sql())

AzisK · 2023-09-22T07:32:49Z

By JQL do you mean the selection in Jira or does it have more meanings?

AzisK · 2023-09-22T07:49:28Z

Could you add tests?

doc-sheet · 2023-09-24T11:50:12Z

By JQL do you mean the selection in Jira or does it have more meanings?
Yeah, jql as jira query language

I din't aim for full support, just the tools I use myself.
But I can add more if needed. I guess.

AzisK · 2023-09-24T13:14:43Z

I believe there is no need to start with full support. We can start little and then later extend it. Could you also add this possibility in the documentation?

doc-sheet · 2023-09-24T14:22:33Z

Sure! Done.

AzisK · 2023-09-25T09:42:33Z

docs/3_advanced.rst

+
+.. code-block:: python
+
+    from pypika import MySQLQuery, MSSQLQuery, PostgreSQLQuery, OracleQuery, VerticaQuery


JiraTable seems not to be imported and these seem unnecessary

oh
sorry, copypaste issue

doc-sheet · 2023-09-29T22:03:17Z

ugh
There was a dependency conflict in my venv: https://stackoverflow.com/a/71674345

williambdean · 2023-10-16T18:12:13Z

docs/3_advanced.rst

+
+.. code-block:: python
+
+    from pypika import JiraTable, JiraQueryBuilder


Should the example use JiraQuery instead of JiraQueryBuilder?

Think that that would provide consistency with the rest of the API

To be honest I just don't know how to make in consistent.
There are no such thing as tables (so JiraTable is just a dummy placeholder).

Best thing I can do is probably create a bunch of overrides for from_, into and other methods which would return cls._builder(**kwargs)

Is it ok?

>>> table = JiraTable() >>> JiraQuery._builder().where(table.project.isin(["PROJ1", "PROJ2"])) project IN ("PROJ1","PROJ2")

Hm. I guess JiraQuery.from_(table).where(table.project.isin(["PROJ1", "PROJ2"])) looks kind consistent.

Maybe the JiraQuery could have a where class method as well that initializes table.

Personally, I tend to used Fields

Maybe it would read like this

query = ( JiraQuery .where( (Field("project").isin(["PROJ1", "PROJ2"])) & (Field("issuetype") == "my_issue_type") ) )

Done.
Working in both ways:

>>> JiraQuery.where(Field("project").isin(["PROJ1", "PROJ2"]) & (Field("issuetype") == "my_issue_type")) project IN ("PROJ1","PROJ2") AND issuetype="my_issue_type" >>> table = JiraTable() >>> JiraQuery.where(table.project.isin(["PROJ1", "PROJ2"]) | table.project == 2) project IN ("PROJ1","PROJ2") OR project=2

williambdean · 2023-10-17T11:34:30Z

docs/3_advanced.rst

+
+    J = JiraTable()
+    j = (
+        JiraQuery._builder().from_(J)


I'd recommend against using the _ methods

williambdean

Looks good to me! Just one more comment on the example

williambdean · 2023-10-17T18:15:30Z

docs/3_advanced.rst

+        .where(J.labels.isempty() | J.labels.notin(["stale", "bug"]))
+        .where(J.repos.notempty() & J.repos.notin(["main", "dev"]))
+    )
+    print(j.get_sql())


Some of the other examples show the result explicitly

Done.
Also I forgot to import JiraQuery into main class. So I also had to add Table method for consistency

AzisK

I believe it looks good. Let's start to support JQL

coveralls · 2025-09-23T15:48:43Z

coverage: 98.374% (-0.04%) from 98.411%
when pulling fa56f4c on doc-sheet:jql_init
into 89c1ef0 on kayak:master.

# By Ashaya Sharma (1) and others # Via GitHub * upstream/master: Initial support for JQL (kayak#721) Add bitwiseor support and class (kayak#825) Add qualify (kayak#841) Signed-off-by: Akhil Narang <[email protected]> # Conflicts: # pypika/dialects.py

doc-sheet requested a review from a team as a code owner March 25, 2023 15:22

doc-sheet force-pushed the jql_init branch from 136522c to b012853 Compare September 24, 2023 14:22

ds added 3 commits September 24, 2023 17:25

Initial support for JQL

09291e5

add test for jql

0a8a291

add JiraQueryBuilder mention to docs

efcc459

doc-sheet force-pushed the jql_init branch from b012853 to efcc459 Compare September 24, 2023 14:25

AzisK reviewed Sep 25, 2023

View reviewed changes

AzisK assigned doc-sheet Sep 25, 2023

ds added 2 commits September 25, 2023 16:36

fix copypaste in docs

6a123a3

fix code formatting

5bc8d99

williambdean reviewed Oct 16, 2023

View reviewed changes

make jira test and example consistent

9c69e02

williambdean reviewed Oct 17, 2023

View reviewed changes

add JiraQuery.where() method

f828d1d

williambdean approved these changes Oct 17, 2023

View reviewed changes

ds and others added 3 commits October 17, 2023 23:05

add Table, Tables methods

afefb46

show generated jql in example

a2496c7

Merge branch 'master' into jql_init

fa56f4c

AzisK approved these changes Sep 23, 2025

View reviewed changes

AzisK merged commit d9f5b52 into kayak:master Sep 23, 2025
6 checks passed


		.. code-block:: python

		from pypika import MySQLQuery, MSSQLQuery, PostgreSQLQuery, OracleQuery, VerticaQuery


		.. code-block:: python

		from pypika import JiraTable, JiraQueryBuilder

Initial support for JQL #721

Initial support for JQL #721

Uh oh!

Conversation

doc-sheet commented Mar 25, 2023

Uh oh!

AzisK commented Sep 22, 2023

Uh oh!

AzisK commented Sep 22, 2023

Uh oh!

doc-sheet commented Sep 24, 2023

Uh oh!

AzisK commented Sep 24, 2023

Uh oh!

doc-sheet commented Sep 24, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

doc-sheet commented Sep 29, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

williambdean Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

williambdean left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AzisK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coveralls commented Sep 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

williambdean Oct 17, 2023 •

edited

Loading

williambdean left a comment •

edited

Loading