Skip to content

docs about query hints and parameters #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 20, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/cypher/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# Cypher

TODO
## Execution

Queries can be executed either for Cypher file (in this case data source selection is required),
or from data source editor. To open data source editor, right click on data source and choose `Open editor`.

Keyboard shortcut for query execution is *Ctrl + Enter* with the cursor on the query. Alternatively right click on
the query statement, select `Graph Database` -> `Execute Query`.

If query execution fails, an error hint is displayed.
![plugin screenshot](../screenshots/error_hint.png "Error hint")

The hint disappears as soon as any user interaction like mouse movement takes place.
Afterwards it is possible to view the error details in `Log` tab.

If parameters are needed for query execution, they can be provided in `Paramters` tab in JSON format.
For instance, for query `MATCH (n) WHERE n.name = $name RETURN n`, parameter could look like `{"name": "Johan"}`.

![plugin screenshot](../screenshots/query_parameters_sample.png "Providing query parameters")

`Log` tab displays, what parameters where used for query execution.
<!--
General information
File type support
Expand Down
Binary file added docs/screenshots/error_hint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/query_parameters_sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.