Skip to content

Commit f79cde5

Browse files
gdaleckaFylmTM
authored andcommitted
docs about query hints and parameters (#30)
1 parent 025976d commit f79cde5

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

docs/cypher/index.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
# Cypher
22

3-
TODO
3+
## Execution
44

5+
Queries can be executed either for Cypher file (in this case data source selection is required),
6+
or from data source editor. To open data source editor, right click on data source and choose `Open editor`.
7+
8+
Keyboard shortcut for query execution is *Ctrl + Enter* with the cursor on the query. Alternatively right click on
9+
the query statement, select `Graph Database` -> `Execute Query`.
10+
11+
If query execution fails, an error hint is displayed.
12+
![plugin screenshot](../screenshots/error_hint.png "Error hint")
13+
14+
The hint disappears as soon as any user interaction like mouse movement takes place.
15+
Afterwards it is possible to view the error details in `Log` tab.
16+
17+
If parameters are needed for query execution, they can be provided in `Paramters` tab in JSON format.
18+
For instance, for query `MATCH (n) WHERE n.name = $name RETURN n`, parameter could look like `{"name": "Johan"}`.
19+
20+
![plugin screenshot](../screenshots/query_parameters_sample.png "Providing query parameters")
21+
22+
`Log` tab displays, what parameters where used for query execution.
523
<!--
624
General information
725
File type support

docs/screenshots/error_hint.png

31 KB
Loading
27.1 KB
Loading

0 commit comments

Comments
 (0)