-
Notifications
You must be signed in to change notification settings - Fork 295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial support for JQL #721
Open
doc-sheet
wants to merge
9
commits into
kayak:master
Choose a base branch
from
doc-sheet:jql_init
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
09291e5
Initial support for JQL
0a8a291
add test for jql
efcc459
add JiraQueryBuilder mention to docs
6a123a3
fix copypaste in docs
5bc8d99
fix code formatting
9c69e02
make jira test and example consistent
f828d1d
add JiraQuery.where() method
afefb46
add Table, Tables methods
a2496c7
show generated jql in example
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,25 @@ the platform-specific Query classes can be used. | |
You can use these query classes as a drop in replacement for the default ``Query`` class shown in the other examples. | ||
Again, if you encounter any issues specific to a platform, please create a GitHub issue on this repository. | ||
|
||
Or even different query languages | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Some services created their own query language similar to SQL. To generate expressions for Jira there is a ``JiraQueryBuilder`` class. | ||
|
||
.. code-block:: python | ||
|
||
from pypika import JiraTable, JiraQueryBuilder | ||
|
||
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(J.repos.notempty() & J.repos.notin(["main", "dev"])) | ||
) | ||
print(j.get_sql()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Some of the other examples show the result explicitly There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
|
||
GROUP BY Modifiers | ||
------------------ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
import unittest | ||
|
||
from pypika.dialects import JiraQueryBuilder, JiraTable | ||
|
||
|
||
class SelectTests(unittest.TestCase): | ||
table_abc = JiraTable() | ||
|
||
def test_in_query(self): | ||
q = JiraQueryBuilder().where(self.table_abc.project.isin(["PROJ1", "PROJ2"])) | ||
|
||
self.assertEqual('project IN ("PROJ1","PROJ2")', str(q)) | ||
|
||
def test_eq_query(self): | ||
q = JiraQueryBuilder().where(self.table_abc.issuetype == "My issue") | ||
|
||
self.assertEqual('issuetype="My issue"', str(q)) | ||
|
||
def test_or_query(self): | ||
q = JiraQueryBuilder().where( | ||
self.table_abc.labels.isempty() | self.table_abc.labels.notin(["stale", "bug fix"]) | ||
) | ||
|
||
self.assertEqual('labels is EMPTY OR labels NOT IN ("stale","bug fix")', str(q)) | ||
|
||
def test_and_query(self): | ||
q = JiraQueryBuilder().where(self.table_abc.repos.notempty() & self.table_abc.repos.notin(["main", "dev"])) | ||
|
||
self.assertEqual('repos is not EMPTY AND repos NOT IN ("main","dev")', str(q)) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the example use
JiraQuery
instead ofJiraQueryBuilder
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think that that would provide consistency with the rest of the API
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 returncls._builder(**kwargs)
Is it ok?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm. I guess
JiraQuery.from_(table).where(table.project.isin(["PROJ1", "PROJ2"]))
looks kind consistent.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the
JiraQuery
could have awhere
class method as well that initializes table.Personally, I tend to used
Field
sMaybe it would read like this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Working in both ways: