-
Notifications
You must be signed in to change notification settings - Fork 188
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'docs/cleanup-4.8' of https://github.com/Evolveum/midpoint…
… into docs/cleanup-4.8
- Loading branch information
Showing
5 changed files
with
211 additions
and
132 deletions.
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
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
82 changes: 82 additions & 0 deletions
82
docs/concepts/query/midpoint-query-language/query-playground/index.adoc
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,82 @@ | ||
| = Query Playground and Query Converter | ||
| :page-nav-title: Errors while querying | ||
| :page-display-order: 600 | ||
|
|
||
| To experiment with the query language, there is hardly a better place than the actual running midPoint. | ||
| Log in the GUI as administrator and choose *Query playground* in the main menu on the left, all the way down, just above *About*. | ||
|
|
||
| [#_query_playground] | ||
| == Query playground | ||
| To test the query, you have to: | ||
| . Select the *Object type*, | ||
| ** Object type defines type of objects the query will be selecting from. While searching in GUI the object type is defined by actually opened view. In query playground you need to define it manually. | ||
| ** check *Distinct* if needed (first try without it), | ||
| . write the *query* into the text area, | ||
| . press *Translate and execute*. | ||
| Alternatively use an existing example from the selection box below. | ||
| You can either execute the query or just simulate it. | ||
| In both cases you will see the translated SQL query (or HQL for the old Generic repository) and the parameter values. | ||
| [NOTE] | ||
| Container value queries are not yet supported by the Query playground. | ||
| [IMPORTANT] | ||
| ==== | ||
| The *distinct* option is often essential to get the right count of objects when searching in the Generic repository. | ||
| This is caused by `LEFT JOIN` used even when traversing to multi-value containers. | ||
| E.g., filter on `assignment/targetRef` causes each object with multiple assignments to be returned multiple times. | ||
| Using Exists filter (see later) does not fix this in the Generic repository either, as it also uses `LEFT JOIN` internally. | ||
| The new xref:/midpoint/reference/repository/native-postgresql/[Native repository] does not suffer | ||
| by these problems as it always uses SQL `EXISTS` when traversing to multi-value containers and also for Exists filter. | ||
| Native repository actually *ignores distinct* if there is no `JOIN` in the final query, as the returned raws must be distinct. | ||
| Native repository uses `LEFT JOIN` only to traverse across single-valued containers and references and their targets, | ||
| so even then the distinct option is useless and, when honoured, can potentially hurt SQL performance. | ||
| ==== | ||
| === Fluent API script translation | ||
| Query playground offers an option to translate queries from fluent API scripts. | ||
| This way you can debug the Groovy code for an expression directly in the GUI before using it. | ||
| To do this, follow these steps: | ||
| * Check *Translate from Query API script*, the expression text area will appear. | ||
| * Enter the code as an expression, e.g.: | ||
| + | ||
| [source,xml] | ||
| ---- | ||
| <expression> | ||
| <script> | ||
| <code> | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.*; | ||
| prismContext.queryFor(FocusType.class) | ||
| .item(FocusType.F_NAME).startsWith("a").build(); | ||
| </code> | ||
| </script> | ||
| </expression> | ||
| ---- | ||
| * Choose the *Object type*, just like for any other query. | ||
| Just use the type from `queryFor(...)` call, in our example `FocusType`. | ||
| If the query does not provide expected results, very likely the object type selection is not right. | ||
| * Press *Translate and execute*. | ||
| This will execute the query in the expression and also shows the query in the text area for | ||
| XML/JSON/YAML query - in the language currently chosen. | ||
| Using the expression requires proper imports - depending on the complexity of the script you | ||
| may need additional imports from packages like `com.evolveum.midpoint.schema`, | ||
| `com.evolveum.midpoint.prism.query` or others. | ||
| [#_query_converter] | ||
| == Query converter | ||
Oops, something went wrong.