Documentation for logic expressions and insights #676
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
irfanbozkurt
commented
Mar 21, 2023
sdmuki
suggested changes
Mar 23, 2023
|
|
||
| Following are example query instances taken from an SDQL query | ||
| ```JSON | ||
| "q1": { |
Contributor
There was a problem hiding this comment.
For each query you need to explain how it produces a result. It's not very intuitive in some cases.
| 2. Else if query instance does not have a condition defined (either **in-line** or **in-instance condition**), $qN evaluates to **true** or **false** depending on if user provides valid data as an answer to this query instance. | ||
| - If data cannot be found in the persistence layer, $qN evaluates to false. | ||
| - Else if data provided by user is not a valid answer (e.g. answering "yes" to an age query instance), $qN evaluates to false. | ||
| - Else, "$qN" in a logic expression will be evaluated to **true**, representing that user has given permission for data asked by $qN, and they also provided a valid value for asked data type. |
Contributor
There was a problem hiding this comment.
remove this. don't use logic expression. We have two ways to evaluate them
| - If data cannot be found in the persistence layer, $qN evaluates to false. | ||
| - Else if data provided by user is not a valid answer (e.g. answering "yes" to an age query instance), $qN evaluates to false. | ||
| - Else, "$qN" in a logic expression will be evaluated to **true**, representing that user has given permission for data asked by $qN, and they also provided a valid value for asked data type. | ||
| 3. Else $qN evaluates to true or false depending on the conditions applied. |
Contributor
There was a problem hiding this comment.
Name it in-query conditions instead of in-instance. We have conditions inside a query and outside a query.
| - Else, "$qN" in a logic expression will be evaluated to **true**, representing that user has given permission for data asked by $qN, and they also provided a valid value for asked data type. | ||
| 3. Else $qN evaluates to true or false depending on the conditions applied. | ||
| - Conditions that are applied within a query instance ([see](/documentation/sdql/README.md)) are called **in-instance conditions**. | ||
| - For [certain query types](/documentation/sdql/LOGICEXPRESSIONS.md), conditions can be applied **in-line** directly in the logic expression. |
Contributor
There was a problem hiding this comment.
remove this from here. This section is about queries? Nothing about logic evaluation should be here.
| - Conditions that are applied within a query instance ([see](/documentation/sdql/README.md)) are called **in-instance conditions**. | ||
| - For [certain query types](/documentation/sdql/LOGICEXPRESSIONS.md), conditions can be applied **in-line** directly in the logic expression. | ||
|
|
||
| Consider following age query instances. "$q2" in a logic expression will be equivalent to "$q3>=10". |
Contributor
There was a problem hiding this comment.
This needs change. You drove to evaluating logic expressions without properly introducing query evaluation.
| </tr> | ||
| </table> | ||
|
|
||
| ## 2- Insight Instances |
Contributor
There was a problem hiding this comment.
Get rid of "instances". We already have too many terms and it does not add a value.
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.
No description provided.