Documentation for OQL

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/creating-the-domain-model.md

@@ -68,7 +68,7 @@ invoice.location = { x: 400, y: 100 };
 
 *Studio Pro Guide*
 
-* [Domain Model](/refguide/domain-model/)
+* [Data in the Domain Model](/refguide/domain-model/)
 * [Entities](/refguide/entities/)
 
 Metamodel reference guide

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/aws-authentication.md

@@ -218,7 +218,7 @@ To help you work with signature version 4 headers, the following sections of thi
 
 #### Domain Model {#domain-model}
 
-The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Domain Model](/refguide/domain-model/).
+The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Data in the Domain Model](/refguide/domain-model/).
 
 You can view the domain model in the **App Explorer** in the **AWS Authentication** > **Domain model** section. The following entities are relevant for signature version 4 headers authentication:
 
@@ -311,7 +311,7 @@ It takes the following parameters as input:
 * A `Credentials` object
 * A `ENUM_Region` enumeration value
 
-The output is a boolean indicating whether the credentials are valid. 
+The output is a Boolean indicating whether the credentials are valid. 
 
 ## Read More
 

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/genai-commons.md

@@ -54,7 +54,7 @@ The technical purpose of GenAI Commons module is to define a common domain model
 
 ### Domain Model {#domain-model} 
 
-The domain model in Mendix is a data model that describes the information in your application domain in an abstract way. For more general information, see the [Domain Model](/refguide/domain-model/) documentation. To learn about where the entities from the domain model are used and relevant during implementation, see the [Microflows](#microflows) section below.
+The domain model in Mendix is a data model that describes the information in your application domain in an abstract way. For more general information, see the [Data in the Domain Model](/refguide/domain-model/) documentation. To learn about where the entities from the domain model are used and relevant during implementation, see the [Microflows](#microflows) section below.
 
 {{< figure src="/attachments/appstore/platform-supported-content/modules/genai/genaicommons/genai-commons-domain-model.png" alt="" >}}
 
@@ -250,7 +250,7 @@ An optional input object for the image generations operations to set optional re
 | `Height` | This determines the height of the image. |
 | `Width` | This determines the width of the image. |
 | `NumberOfImages` | This determines the number of images to be generated. |
-| `Seed` | This can be used to influence the randomness of the generation. Ensures the reproducability and consistency in the generated images by controlling the initial state of the random number generator. |
+| `Seed` | This can be used to influence the randomness of the generation. Ensures the reproducibility and consistency in the generated images by controlling the initial state of the random number generator. |
 | `CfgScale` | This can be used to influence the randomness of the generation. Adjusts the balance between adherence to the prompt and creative randomness in the image generation process. |
 | `ImageGenerationType` | This describes the type of image generation. Currently only text to image is supported. For more information, see [ENUM_ImageGenerationType](#enum-imagegenerationtype). |
 
@@ -655,7 +655,7 @@ This Java action adds a new [KnowledgeBaseChunk](#knowledgebasechunk-entity) to
 | `InputText` | String | mandatory | Input text to generate an embedding vector for. |
 | `HumanReadableID` | String | mandatory | This is a front-end identifier that can be used for showing or retrieving sources in a custom way. If it is not relevant, "empty" must be passed explicitly here. |
 | `MxObject` | Type parameter | optional | This parameter is used to capture the Mendix object to which the chunk refers. This can be used for finding back the record in the Mendix database later on after the retrieval step. |
-| `MetadataCollection` | [MetadataCollection](#metadatacollection-entity) | optional | This is an optional MetadataCollection that contains extra information about the KnowledgeBaaseChunk. Any key-value pairs can be stored. In the retrieval operations it is possible to filter on one or multiple metadata key-value pairs. |
+| `MetadataCollection` | [MetadataCollection](#metadatacollection-entity) | optional | This is an optional MetadataCollection that contains extra information about the KnowledgeBaseChunk. Any key-value pairs can be stored. In the retrieval operations it is possible to filter on one or multiple metadata key-value pairs. |
 
 ###### Return Value
 
@@ -703,7 +703,7 @@ This microflow creates a new [MetadataCollection](#metadatacollection-entity) an
 
 | Name | Type | Mandatory | Description |
 |--- |--- |--- |--- |
-| `Key` | String | madatory | This is the name of the metadata and typically tells how the value should be interpreted. |
+| `Key` | String | mandatory | This is the name of the metadata and typically tells how the value should be interpreted. |
 | `Value` | String | mandatory | This is the value of the metadata that provides additional information about the chunk in the context of the given key. |
 
 ###### Return Value

content/en/docs/appstore/use-content/platform-supported-content/modules/sap/sap-event-mesh-connector.md

@@ -65,7 +65,7 @@ To help you work with the SAP Event Mesh connector, the following sections of th
 
 ### Domain Model {#domain-model}
 
-The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Domain Model](/refguide/domain-model/).
+The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Data in the Domain Model](/refguide/domain-model/).
 
 The entities in the table below describe all generalizations. These are reused by the different models for the specific microflow activities or for storing connection details.
 

content/en/docs/appstore/use-content/platform-supported-content/modules/sap/sap-odata-connector.md

@@ -778,7 +778,7 @@ This documentation describes two different domain models.
 
 2. The OData Connector for SAP solutions Domain Model – this contains entities which are used by the OData Connector for SAP solutions itself: for example, to construct the request which needs to be sent to the OData service. A description of this domain model is included for completeness in the section [OData Connector for SAP Solutions Domain Model](#ConnectorDM)
 
-For more information on domain models, see [Domain Model](/refguide/domain-model/).
+For more information on domain models, see [Data in the Domain Model](/refguide/domain-model/).
 
 #### SAP Service Domain Model
 
@@ -868,7 +868,7 @@ This domain model is part of the OData Connector for SAP solutions module and ca
 
 * [Attributes](/refguide/attributes/)
 * [Data Types](/refguide/data-types/)
-* [Domain Model](/refguide/domain-model/)
+* [Data in the Domain Model](/refguide/domain-model/)
 * [Entities](/refguide/entities/)
 * [SAP Cloud Connector](/developerportal/deploy/sap-cloud-platform/sap-cloud-connector/)
 * [SAP Help Portal](https://help.sap.com)

content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/snowflake-rest-sql.md

@@ -106,7 +106,7 @@ To help you work with the Snowflake REST SQL connector, the following sections o
 
 ### Domain Model {#domain-model}
 
-The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Domain Model](/refguide/domain-model/).
+The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Data in the Domain Model](/refguide/domain-model/).
 
 #### ConnectionDetails {#connection-details}
 

content/en/docs/appstore/use-content/platform-supported-content/services/use-sap-model-creator.md

@@ -37,7 +37,7 @@ The Data Model module contains up to four resources which help to consume the OD
 
 #### Domain Model
 
-Each Mendix SAP data model has a domain model that describes the information in the OData service. The domain model consists of entities and their relations represented by associations. For more information, see [Domain Model](/refguide/domain-model/).
+Each Mendix SAP data model has a domain model that describes the information in the OData service. The domain model consists of entities and their relations represented by associations. For more information, see [Domain Model].
 
 {{< figure src="/attachments/appstore/platform-supported-content/services/sap-model-creator/sap-service-example.png" class="no-border" >}}
 

content/en/docs/deployment/private-cloud/reduced-downtime-deployment.md

@@ -6,7 +6,7 @@ weight: 35
 ---
 ## Introduction
 
-Kubernetes allows to update an app without downtime by [performing a rolling update](https://kubernetes.io/docs/tutorials/kubernetes-basics/update/update-intro/). Instead of stopping an app and then starting it with an updated version or configuration, Kubernetes can replace pods (replicas) one by one with an updated version. Existing pods handle requests until the newer version is fully started. Any changes in the [domain model](/refguide/domain-model/) need a database (schema) update. While the update process runs, you cannot modify any persistent entities.
+Kubernetes allows to update an app without downtime by [performing a rolling update](https://kubernetes.io/docs/tutorials/kubernetes-basics/update/update-intro/). Instead of stopping an app and then starting it with an updated version or configuration, Kubernetes can replace pods (replicas) one by one with an updated version. Existing pods handle requests until the newer version is fully started. Any changes in the [Data in the Domain Model](/refguide/domain-model/) need a database (schema) update. While the update process runs, you cannot modify any persistent entities.
 
 The Private Cloud Operator uses a [recreate](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#recreate-deployment) strategy by default. That is, the current version (configuration) of an app stops, and then the new version starts. Alternatively, the Private Cloud Operator can use a **PreferRolling** strategy. That is, the Operator tries to perform a rolling update whenever possible. If the Operator detects that a database schema update is needed, it switches to a Recreate strategy to perform a full restart. If the new version of the app has model changes, deploying it requires a schema update. In this case, the Private Cloud Operator automatically stops all replicas of the app, causing downtime.
 
@@ -44,9 +44,9 @@ The following changes in the UI can be done without downtime, but as soon as the
 
 * Page changes, including layout or CSS changes
 * Changes in nanoflows or microflow parameters, if the microflow is used on a page
-* Changes in Javascript actions
+* Changes in JavaScript actions
 
-Thes following changes will be deployed with downtime, because the model must be updated:
+The following changes will be deployed with downtime, because the model must be updated:
 
 * Adding Marketplace modules that have persistent entities
 * Updating the object model in the app itself, or its Marketplace modules

content/en/docs/refguide/modeling/consistency-errors/_index.md

@@ -31,7 +31,7 @@ Errors need to be solved before your app can be deployed. A consistency error ca
 * [Navigation](/refguide/consistency-errors-navigation/) 
 * [Microflows](/refguide/microflows/)
 * [Workflows](/refguide/workflows/)
-* [Domain Model](/refguide/domain-model/)
+* [Data in the Domain Model](/refguide/domain-model/)
 * [Integration](/refguide/integration/)
 * [Security](/refguide/security/)
 

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

@@ -1,6 +1,6 @@
 ---
-title: "Domain Model"
-linktitle: "Domain Model (Data)"
+title: "Data in the Domain Model"
+linktitle: "Data (Domain Model)"
 url: /refguide/domain-model/
 weight: 30
 description: "Introduces the domain model in Studio Pro."

content/en/docs/refguide/modeling/resources/data-sets/_index.md → content/en/docs/refguide/modeling/domain-model/entities/data-sets.md

@@ -1,7 +1,7 @@
 ---
 title: "Datasets"
 url: /refguide/data-sets/
-weight: 50
+weight: 80
 #If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
 ---
 

content/en/docs/refguide/modeling/domain-model/entities/indexes.md

@@ -25,7 +25,7 @@ Indexes are ordered, which means that when you create an index on two or more at
 
 ### Indexes on System Members
 
-If you choose to store an entity's `owner` and `changedBy` system members, an index is created. This is not so for the `createdDate` and `changedDate` system members. In addition, an index is created for the automatically generated attribute `id`. See [Domain Model](/refguide/domain-model/) for more information about the implementation of these attributes.
+If you choose to store an entity's `owner` and `changedBy` system members, an index is created. This is not so for the `createdDate` and `changedDate` system members. In addition, an index is created for the automatically generated attribute `id`. See [Data in the Domain Model](/refguide/domain-model/) for more information about the implementation of these attributes.
 
 ### Indexes on Non-Persistable Entities
 

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

@@ -0,0 +1,77 @@
+---
+title: "OQL"
+url: /refguide/oql/
+weight: 90
+---
+
+## Introduction
+
+The Mendix Object Query Language (OQL) is a relational query language inspired by [SQL](https://en.wikipedia.org/wiki/Sql). The major advantage of OQL is that it uses Mendix entity and association names instead of actual database table names. In that way, it is possible to create queries that use names from the data model of your Mendix app without thinking about how that data model is represented in the database.
+
+In addition, OQL can use predefined relations (associations) to easily join objects without having to calculate which columns should be coupled. Despite these differences, many SQL keywords also work in OQL.
+
+Some examples of OQL queries are:
+
+* `SELECT LastName FROM Sales.Customer` – retrieves the family names of all customers
+* `SELECT FirstName FROM Sales.Customer WHERE LastName = 'Jansen'` – retrieves the given name of all customers with family name "Jansen"
+* `SELECT SUM(TotalAmount) FROM Sales."Order" WHERE IsPaid = true` – retrieves the sum of the total amount on all paid orders (`Order` needs to be wrapped in quotes, see the [Reserved Words](#reserved-oql-words) section below)
+
+{{% alert color="info" %}}
+OQL queries do not take security into account out-of-the-box. This means that you can use OQL to manually define custom security expressions. In some cases, handling security yourself using OQL—instead of using the out-of-the-box security of XPath—may result in faster queries.
+{{% /alert %}}
+
+{{% alert color="info" %}}
+You can try your OQL example online in the [OQL Playground](https://service.mendixcloud.com/p/OQL) demo app.
+{{% /alert %}} 
+
+## Reserved Words {#reserved-oql-words}
+
+Words with a specific purpose in OQL are reserved. If you use reserved words for entity, variable, or attribute names in an OQL query, they must be wrapped in double quotes `" "`. For example, in the OQL query `SELECT AVG(TotalPrice) FROM Sales."Order" WHERE IsPaid = 1`, `Order` needs to be wrapped in quotes because it is a reserved word, as it can be used to `ORDER BY`.
+
+Here is a list of all OQL reserved words:
+
+`ALL`, `AND`, `AS`, `ASC`, `AVG`
+
+`BOOLEAN`, `BY`
+
+`CASE`, `CAST`, `COUNT`
+
+`DATEDIFF`, `DATEPART`, `DATETIME`, `DAY`, `DAYOFYEAR`, `DECIMAL`, `DESC`, `DISTINCT`
+
+`ELSE`, `END`, `EXISTS`
+
+`FALSE`, `FLOAT`, `FROM`, `FULL`
+
+`GROUP`
+
+`HAVING`, `HOUR`
+
+`IN`, `INNER`, `INTEGER`, `IS`
+
+`JOIN`
+
+`LEFT`, `LIKE`, `LIMIT`, `LONG`
+
+`MAX`, `MILLISECOND`, `MIN`, `MINUTE`, `MONTH`
+
+`NOT`, `NULL`
+
+`OFFSET`, `ON`, `OR`, `ORDER`, `OUTER`
+
+`QUARTER`
+
+`RIGHT`
+
+`SECOND`, `SELECT`, `STRING`, `SUM`
+
+`THEN`, `TRUE`
+
+`UNION`
+
+`WEEK`, `WEEKDAY`, `WHEN`, `WHERE`
+
+`YEAR`
+
+{{% alert color="info" %}}
+Mendix does not support Float data type since version 8. In OQL, `FLOAT` is a reserved word for legacy reasons. It should not be used.
+{{% /alert %}}