CodeQL documentation: reorganize 'Advanced QL' topics #2583
Conversation
This file contains hidden or 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
max-schaefer
previously approved these changes
Jan 3, 2020
shati-patel
reviewed
Jan 3, 2020
|
|
||
| Going from ``Element -> File`` and ``Element -> Location -> StartLine`` is linear--that is, there is only one ``File``, ``Location``, etc. for each ``Element``. | ||
|
|
||
| However, as written it is difficult for the optimizer to pick out the best ordering. Generally, we want to do the quick, linear parts first, and then join on the resultant larger tables. Joining first and then doing the linear lookups later would likely result in poor performance. We can initiate this kind of ordering by splitting the above predicate as follows: |
There was a problem hiding this comment.
... would likely result in poor performance. We can initiate this kind of ordering ...
Sounds like we want to initiate the "bad" ordering! Perhaps swap the order of the two preceding sentences.
| .. code-block:: ql | ||
|
|
||
| predicate similar(Element e1, Element e2) { | ||
| e1.getName() = e2.getName() and |
There was a problem hiding this comment.
The first half of this topic uses the "autoformatted" style, in particular 2 spaces for indentation instead of 4. Probably worth doing that here too.
(I wouldn't worry about it in the older standalone topics, but the difference is quite noticeable here.)
|
Thanks @shati-patel. I've addressed both of your comments. |
shati-patel
previously approved these changes
Jan 3, 2020
Co-Authored-By: shati-patel <[email protected]>
|
I have now (rather belatedly) added redirects for the topics that were removed in this PR. |
This was referenced Feb 11, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The topics that currently live under Advanced QL in the 'Learning CodeQL' Sphinx project are a bit random. I've started to move them around into (hopefully) more logical/helpful locations:
@max-schaefer would you mind reviewing the technical aspect of these changes please?
@shati-patel do you agree with this restructuring? (and please can you review the text?)
TODO