Documentation for OQL #8431

dahfjkg · 2024-10-04T13:34:56Z

This is the documentation for OQL following the new structure.

It contains the original Clauses PR and changes from OQL expressions and OQL expression syntax

content/en/docs/refguide/modeling/data/oql/oql-clauses.md

MarkvanMents

Part way through the review
Just noting here that I've moved the document to match the structure we discussed in Confluence. Will continue working on this tomorrow.

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

MarkvanMents · 2024-10-14T14:57:07Z

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

+
+### `SELECT` clause
+
+The `SELECT` clause specifies which entity attributes or other specified data must be retrieved. The `SELECT` clause consists of the term `SELECT` and one or more expressions. Each expression must be separated by a comma. Each expression defines a column in the result. Each expression can have an alias, which will be the name of the column in the result.


You say that you have SELECT plus expressions. However, you explain these expressions in this document, not in the OQL Expressions document. I think this is a bit confusing - is there another word we can use (sub-clauses, or definitions?) instead of expressions here?

Also, you say that Each expression defines a column in the result. However, the * expression defines multiple columns in the result, doesn't it?

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

MarkvanMents

Hi @dahfjkg and @pijuskri
I have done some proofreading in these commits: https://github.com/mendix/docs/pull/8431/files/8786adfd64abf1412b116d6433dd8457a11e7712..239aebdb960b3c3a018fedc47c43b47f5021afb3.

I have also made various suggestions in some comments.

Can you have a look at what I've done so far and see if you think I'm on the right track. We can discuss it further in a call if we need to discuss my changes.

If any of your earlier discussions are resolved can you mark them as resolved so it is clear what is still to do?

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

MarkvanMents

Got a bit further, but still have only got as far as JOIN.
Sorry this is taking so long - need to do other things at the same time!

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

CLAassistant · 2024-10-21T09:42:26Z

All committers have signed the CLA.

MarkvanMents

Hi there,
I've nearly finished my review. Sorry it is taking so long, but I keep being called away to do other things.
I have a couple more questions which are related to parts of the text. See below:

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

Co-authored-by: Mark van Ments <[email protected]>

content/en/docs/refguide/modeling/domain-model/oql/_index.md

Co-authored-by: Mark van Ments <[email protected]>

content/en/docs/refguide/modeling/domain-model/oql/_index.md

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md

MarkvanMents

Reviewed for COUNT (*) as discussed on Slack.

MarkvanMents · 2024-11-19T11:34:04Z

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md

+```sql
+SELECT COUNT(*)
+FROM Module.Person AS P
+JOIN Module.Person/Module.Person_City/Module.City AS C
+GROUP BY C/Name
+```


Will this work, or does COUNT(*) need an AS?

It will need an AS.

MarkvanMents · 2024-11-19T11:35:06Z

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md

+    SELECT COUNT(*)
+    FROM Module.Person
+    WHERE Module.Person/City = Module.City/Name


Will this work, or does COUNT(*) need an AS?

Same here; requires AS, because otherwise COUNT(*) would be a nameless column.

AS is not required here, the column name will be the alias of the subquery PersonCount, the internal subquery column name has no effect on the main queries column names.

Thanks. I missed the fact that it was nested from the diff.

MarkvanMents · 2024-11-19T11:36:25Z

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

+		SELECT COUNT(*)
+		FROM Sales.Customer AS Cust
+		WHERE Cust/LastName = Req/CustomerName


Will this work, or does COUNT(*) need an AS?

AS needed.

AS is not required, same reason as other case with subquery in attribute

MarkvanMents · 2024-11-19T11:37:01Z

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

+		SELECT COUNT(*)
+		FROM Sales.Location


Will this work, or does COUNT(*) need an AS?

Same asnwer; AS needed.

AS is not required, HAVING and WHERE are not affected by changes to mandatory column names. It only applies to the main SELECT query and the attributes/columns of it.

Extra information for union clause

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

passalaqua · 2024-11-26T13:17:18Z

content/en/docs/refguide/modeling/domain-model/oql/oql-expression-syntax.md

+
+`expression` specifies the expression to convert.
+
+##### data_type


We still support CAST to FLOAT (and FLOAT is still a valid keyword in OQL). We have only deprecated it as a valid result type for queries, but intermediate calculations should still work.

Deprecated or removed entirely?
Is FLOAT deprecated (will it go in Mx 11, for example). I can't really see any point in keeping it if we have DECIMAL.

Is there a use case for a new user of OQL to use FLOAT instead of DECIMAL ?

Deprecated or removed entirely?

As I said:

We have only deprecated it as a valid result type for queries, but intermediate calculations should still work.

And indeed, we still have tests for it and it still works, AFAICS.

Either we document here or in the list of keywords, but completely omitting mentioning something that would otherwise break your query if you use as an identifier is not a good idea, IMO. I just wrote the comment here because CAST is the only place I remember still accepts FLOAT.

I pushed a mention of FLOAT

Looks good to me!

Wouldn't a better place for the mention of FLOAT be in the CAST section, given that is the only valid use case?

If we are to move away from Float, I'd not mention any use cases of it at all

Sorry, I reread Augusto's comment. Given the reason to mention it is to explain why its a keyword, then the current placement is good. Nothing else needs to be added.

…o pr/dahfjkg/8431

sbont · 2024-12-11T17:25:52Z

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md

+
+## Introduction
+
+In Studio Pro version 10.17, we introduced OQL v2. You will have to switch to OQL v2 in order to enable View entities. See the [View entities](/refguide/app-settings/#enable-view-entities) app setting for more information.


Note that we've renamed this setting to "OQL version 2", and the anchor will be #oql-version-2.
See also our branch for View Entities at development...sbont:docs:dux-1-view-entities
(Also, I assume you might want to update the Studio Pro release version...)

pijuskri · 2024-12-18T14:02:32Z

content/en/docs/refguide/modeling/domain-model/oql/oql-expression-syntax.md

@@ -58,14 +58,16 @@ There is no direct support for `DATETIME` literals. For functions that take `DAT

 ## System variables

-XPath [system variables](/refguide/xpath-keywords-and-system-variables/) can be used in OQL with the format:
+Most XPath [system variables](/refguide/xpath-keywords-and-system-variables/#system-variables) can be used in OQL with the format:

 ```sql
 '[%SystemVariable%]'
 ```

 These variables can be used the same way as other expressions.


To be more explicit, we should mention that system variables like %CurrentUser% are resolved to id's of objects with corresponding type (LONG ?). Same with date system variables, are they just strings? How do intervals work (like %DayLength%)?

Pushed an update

Documentation for OQL clauses

8786adf

MariaShaposhnikova assigned MarkvanMents Oct 4, 2024

MarkvanMents added Needs R&D technical verification Internal WIP Needs language review Awaiting response labels Oct 7, 2024

pijuskri reviewed Oct 11, 2024

View reviewed changes

MarkvanMents added 3 commits October 14, 2024 15:11

Move to new OQL section of Domain Model

c1c38c6

Proofread

3df814d

Proofread

7369d45

MarkvanMents removed the Awaiting response label Oct 14, 2024

MarkvanMents reviewed Oct 14, 2024

View reviewed changes

Proofread

239aebd

MarkvanMents reviewed Oct 15, 2024

View reviewed changes

pijuskri reviewed Oct 17, 2024

View reviewed changes

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md Outdated Show resolved Hide resolved

Proofread

5b87de2

MarkvanMents reviewed Oct 17, 2024

View reviewed changes

Resolve review comments

1dc3853

Proofread to Subqueries section.

778804a

MarkvanMents reviewed Oct 21, 2024

View reviewed changes

dahfjkg and others added 2 commits October 21, 2024 16:06

Update content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

7f32144

Co-authored-by: Mark van Ments <[email protected]>

Better examples for GROUP BY and HAVING

63990a7

pijuskri reviewed Oct 23, 2024

View reviewed changes

content/en/docs/refguide/modeling/domain-model/oql/_index.md Outdated Show resolved Hide resolved

dahfjkg and others added 3 commits October 25, 2024 14:05

Update content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md

f421fa9

Co-authored-by: Mark van Ments <[email protected]>

Describe OQL v2 behavior changes

578850c

review comments

4d41982

pijuskri reviewed Oct 25, 2024

View reviewed changes

content/en/docs/refguide/modeling/domain-model/oql/_index.md Show resolved Hide resolved

pijuskri reviewed Oct 28, 2024

View reviewed changes

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md Show resolved Hide resolved

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md Outdated Show resolved Hide resolved

content/en/docs/refguide/modeling/domain-model/oql/oql-v2.md Outdated Show resolved Hide resolved

More review comments and more OQL v2 changes

7915620

Add links to OQL v2 validations to corresponding functions

9c30053

MarkvanMents reviewed Nov 19, 2024

View reviewed changes

pijuskri added 3 commits November 19, 2024 17:50

Correct examples with missing attribute aliases

dcb1cea

Add oql UNION clause documentation section

0a4d137

Improve oql-v2 docs on alias requirements

4e2a5ea

Extra information for union clause

dahfjkg commented Nov 25, 2024

View reviewed changes

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md Outdated Show resolved Hide resolved

content/en/docs/refguide/modeling/domain-model/oql/oql-clauses.md Show resolved Hide resolved

passalaqua reviewed Nov 26, 2024

View reviewed changes

MarkvanMents and others added 14 commits November 26, 2024 14:24

Typo

841634a

Merge branch 'development' into pr/dahfjkg/8431

689cf90

Merge branch 'dat/oql-clauses' of https://github.com/dahfjkg/docs int…

3dc9a9c

…o pr/dahfjkg/8431

Proofread

eb6cb7c

Add example about UNION of associations

f692c0e

Delete old OQL Clauses

d542cc6

Remove old OQL Expressions documentation

34bac48

rename data-sets document

e2acf96

Move Datasets into Data/Entities section

d74afff

Rename Domain Model section to Data

6181931

Move OQL in navigation.

a118e63

Reorganize reserved words

09f2483

Proofread

0d8ccec

Mention that FLOAT is not to be used in OQL

fa52d8d

sbont reviewed Dec 11, 2024

View reviewed changes

sbont mentioned this pull request Dec 11, 2024

Add view entities #8789

Draft

dahfjkg added 2 commits December 18, 2024 10:07

More details on system variables in OQL

833492b

Change link to setting that enables OQL v2

7200ba2

MarkvanMents added 10.19 and removed Needs R&D technical verification Internal WIP labels Dec 18, 2024

pijuskri reviewed Dec 18, 2024

View reviewed changes

Add more information on tokens in OQL

edeaf73

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for OQL #8431

Documentation for OQL #8431

dahfjkg commented Oct 4, 2024 •

edited

Loading

MarkvanMents left a comment

MarkvanMents Oct 14, 2024

MarkvanMents left a comment

MarkvanMents left a comment

CLAassistant commented Oct 21, 2024 •

edited

Loading

MarkvanMents left a comment

MarkvanMents left a comment

MarkvanMents Nov 19, 2024

hugomendix Nov 19, 2024

MarkvanMents Nov 19, 2024

hugomendix Nov 19, 2024

pijuskri Nov 19, 2024

hugomendix Nov 19, 2024

MarkvanMents Nov 19, 2024

hugomendix Nov 19, 2024

pijuskri Nov 19, 2024

MarkvanMents Nov 19, 2024

hugomendix Nov 19, 2024

pijuskri Nov 19, 2024

passalaqua Nov 26, 2024

MarkvanMents Nov 26, 2024

pijuskri Nov 26, 2024

passalaqua Nov 27, 2024 •

edited

Loading

dahfjkg Dec 5, 2024

passalaqua Dec 5, 2024

pijuskri Dec 5, 2024

dahfjkg Dec 5, 2024

pijuskri Dec 5, 2024

sbont Dec 11, 2024

pijuskri Dec 18, 2024

dahfjkg Dec 24, 2024


		### `SELECT` clause

		The `SELECT` clause specifies which entity attributes or other specified data must be retrieved. The `SELECT` clause consists of the term `SELECT` and one or more expressions. Each expression must be separated by a comma. Each expression defines a column in the result. Each expression can have an alias, which will be the name of the column in the result.


		`expression` specifies the expression to convert.

		##### data_type


		## Introduction

		In Studio Pro version 10.17, we introduced OQL v2. You will have to switch to OQL v2 in order to enable View entities. See the [View entities](/refguide/app-settings/#enable-view-entities) app setting for more information.

Documentation for OQL #8431

Are you sure you want to change the base?

Documentation for OQL #8431

Conversation

dahfjkg commented Oct 4, 2024 • edited Loading

MarkvanMents left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MarkvanMents left a comment

Choose a reason for hiding this comment

MarkvanMents left a comment

Choose a reason for hiding this comment

CLAassistant commented Oct 21, 2024 • edited Loading

MarkvanMents left a comment

Choose a reason for hiding this comment

MarkvanMents left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

passalaqua Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dahfjkg commented Oct 4, 2024 •

edited

Loading

CLAassistant commented Oct 21, 2024 •

edited

Loading

passalaqua Nov 27, 2024 •

edited

Loading