Skip to content

Commit

Permalink
updated content and added new images
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexicaWright committed Feb 16, 2022
1 parent fe2fc44 commit 662575f
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: browser-manual
title: Neo4j Browser
version: '4.3'
version: '4.4'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
neo4j-version: '4.3'
neo4j-version-exact: '4.3.0'
neo4j-buildnumber: '4.3'
neo4j-browser-version: '4.3.0'
docs-version: '4.3'
neo4j-version: '4.4'
neo4j-version-exact: '4.4.4'
neo4j-buildnumber: '4.4'
neo4j-browser-version: '4.4.3'
docs-version: '4.4'
Binary file added docs/modules/ROOT/images/graph-result-frame.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/modules/ROOT/images/param-assist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 14 additions & 4 deletions docs/modules/ROOT/pages/operations/query-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,13 @@ RETURN n
[NOTE]
====
To run this example, in the *Browser Settings* drawer, check *Enable multi statement query editor*.
Note that you do not see the output as you are used to when you run multiple statements.
Note that the results are displayed in a different way when you run multpile statements.
In Neo4j Browser, the current state of multi-statement is to set up your environment with multiple statements so that you can execute queries and examine the results, one by one.
Alternatively, you can run the `:param` command separately from the `MATCH` query.
====
=====


== Cypher result

It is possible to save the result from a Cypher query to a parameter.
Expand Down Expand Up @@ -326,7 +325,7 @@ You can clear all currently set parameters from Neo4j Browser by running:
----


=== Set several paramters
=== Set several parameters

You can set several parameters with the `:params` command, this also clears all currently set parameters.

Expand Down Expand Up @@ -355,6 +354,18 @@ $f = false
----
====

== Parameter assistance

If you run a query using parameters without first declaring them all, Browser returns a `ParameterMissing` error and lists the missing parameter(s).
You can click the provided template to populate the editor with the command for setting parameters and all you have to do is enter the value(s) for the missing parameter(s).
Since the result frame is reusable, once you have set your parameter(s), you can run the same Cypher query again without having to re-enter it.

image::param-assist.png[]

[NOTE]
====
The command offered with parameter assistance is always `:params` even if you only have one parameter.
====

== Duration for the query parameters

Expand All @@ -366,4 +377,3 @@ You can save a `:params` command as a favorite to quickly populate parameters ag
//Save the favorites to persist on the disk if you are using Neo4j Desktop.
//Save the favorites to persist in the browsers local storage.
//The localStorage and sessionStorage properties allow to save key/value pairs in a web browser.

12 changes: 7 additions & 5 deletions docs/modules/ROOT/pages/operations/result-frames.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,18 @@ To see the results, switch the mode to the *Table* view.
== Graph result frame

The graph visualization functionality is designed to display a node-graph representation of the underlying data stored in the database in response to a given Cypher query.
It shows circles for nodes and lines for relationships and is especially useful for determining areas of interest or quickly assessing the current state and structure of the data.
Nodes are represented as circles and relationships as lines and is especially useful for determining areas of interest or quickly assessing the current state and structure of the data.

image:graph.png[]
image:graph-result-frame.png[]


.Handy tips
[TIP]
====
* Enable zoom in and out of your graph by entering into fullscreen mode.
* Use the controls in the bottom right corner of the frame to zoom in and out of the visualization.
Additionally, you can zoom using trackpad zoom gestures or a mouse wheel in combination with a modifier key.
On Mac, use `⌘ + scroll` and on Windows and Linux, use `Ctrl + scroll` to trigger zoom.
You can also use the _Fit to screen_ button to fit all query results into the view.
* Click a node or a relationship to view its properties.
The nodes already have sensible captions assigned by the Browser, which auto-selects a property from the property list to use as a caption.
To change how your graph looks like, see xref:operations/browser-styling.adoc[].
Expand Down Expand Up @@ -62,7 +65,7 @@ The connections could easily be lost in a non-visual presentation.


[[plain-text-result-frame]]
== Plain text result frame
== Plain text result frame

The *Text* result view displays the result as a plain text table.
It also reports the query time, including the actual query execution time, latency, and deserialization costs.
Expand All @@ -77,4 +80,3 @@ The *Code* result view displays the submitted request, the Neo4j Server version
It also reports the query time, including the actual query execution time, latency, and deserialization costs.

image:code.png[]

0 comments on commit 662575f

Please sign in to comment.