Skip to content

Commit 03363ad

Browse files
Merge pull request #48 from gregoryking/import-guide-updates
Import guide updates
2 parents 258dd84 + ccb2a89 commit 03363ad

20 files changed

+278
-19
lines changed
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
= New Browser Preview
2+
// http://localhost:4000/browser-preview.workspace.json
3+
4+
== Introduction
5+
6+
Welcome to the New Browser Preview!
7+
Browser's querying functionality has been modernized and integrated into Neo4j Aura, and these benefits are now available in the new Browser, bundled with the Neo4j on-prem distribution.
8+
9+
If you use Neo4j Aura you’ll see the same capabilities as this New Browser Preview offered under the **Query** part of the integrated experience.
10+
Query and Browser are similar, but Query provides features you can expect from a cloud offering, like user content backed by cloud storage, so it’s available wherever you log in.
11+
For the standalone Browser, content continues to be backed by LocalStorage and therefore tied to the browser you use to access the application.
12+
13+
With that context, read on to learn more about the big new updates in this preview:
14+
15+
- New Cypher editor
16+
- Richer table visualization
17+
- More scalable graph visualization
18+
- New history and quick search
19+
- Improved saved Cypher experience
20+
- Revised parameters
21+
22+
== New Cypher editor
23+
24+
One of the biggest improvements is the new editor which is now built from the same source as the Cypher language.
25+
The Cypher language is ever-evolving and the new editor helps you stay up-to-date with the latest language features.
26+
Here are a few ways the new editor helps you do that:
27+
28+
Syntax highlighting:: Richer syntax highlighting identifies potential errors from things like property values being misinterpreted as Cypher keywords and differentiates more tokens for ease of reading.
29+
30+
image::cypher-editor-syntax-highlighting.png[]
31+
32+
33+
Auto completions:: The underpinnings of the Cypher editor now have an improved understanding of valid constructs, meaning it will, for example, more accurately complete the next valid keyword.
34+
35+
image::cypher-editor-auto-completions.gif[]
36+
37+
Inline help:: When using a procedure or making a function call, helpful descriptions and signatures are presented, allowing you to better understand what’s expected as an input or what might be returned.
38+
39+
image::cypher-editor-inline-help.png[]
40+
41+
Cypher linting:: One of the most useful new features is Cypher linting, which lets you see useful warnings and errors _before_ running a query.
42+
This helps shorten the feedback loop, so you don’t have to run a query to spot syntactic or semantic errors.
43+
This is especially useful when editing larger queries or using new language constructs where you might not know what to expect.
44+
45+
image::cypher-editor-linting.png[]
46+
47+
Cypher reference:: As a complement to the in-editor help, a searchable Cypher reference is now available in the sidebar.
48+
This is useful to check the syntax of a Cypher construct or want a quick reference of which temporal functions exist and how to use them, for example.
49+
The reference also provides links to the Cypher manual for more in-depth explanations and examples.
50+
51+
image::cypher-reference.gif[]
52+
53+
== Richer table visualization
54+
55+
The table visualization now employs reactive result fetching by default.
56+
This means that the number of rows returned by a query is automatically limited, regardless of any `LIMIT` statements you apply.
57+
This is useful for both new and experienced users since an unintentional omission of a `LIMIT` statement can lead to an unexpectedly large amount of results returned, which could previously have overwhelmed Browser.
58+
The table now also employs virtualized rendering meaning that even if you do return a larger number of rows, only those in view are rendered to keep the application more responsive.
59+
60+
There are functional improvements too.
61+
A new render for paths, relationships, and nodes allows you to more readily discern labels/types and key/value pairs.
62+
By default, the render is compact, but optionally it allows graph objects to be pretty-printed for situations where readability is more important than compactness.
63+
64+
Simple result filtering is now also available, allowing you to perform simple text matches on returned results.
65+
It's often simpler and quicker than modifying a Cypher statement to contain a WHERE clause.
66+
67+
image::table-visualization.gif[]
68+
69+
70+
== More scalable graph visualization
71+
72+
The graph visualization has been rebuilt using a new engine while maintaining the familiar layout algorithm from the outgoing graph visualization.
73+
This makes the visualization more responsive and allows for a larger number of nodes and relationships to be visualized.
74+
75+
Another important functional change is that the visualization now only displays items you explicitly return in Cypher statements - it no longer automatically connects returned nodes with relationships that exist between them.
76+
This can still be achieved on-demand via a context menu in the visualization to “show all relationships”.
77+
78+
image::scalable-graph-visualization.gif[]
79+
80+
81+
== New history and quick search
82+
83+
The familiar and convenient up/down arrow history feature remains but has been supplemented with a dedicated sidebar to review and manage history, allowing history to be selectively deleted or exported.
84+
85+
For convenience, the history available in the sidebar is also searchable via a fuzzy search from the main editor, allowing you to quickly find a query in your history.
86+
This can be invoked from the […] more menu on the main editor or via Ctrl+R.
87+
88+
image::history-quick-search.gif[]
89+
90+
91+
== Improved saved Cypher experience
92+
93+
The “Favorites” experience from Browser is now “Saved Cypher” and provides a refreshed way of creating and managing Cypher.
94+
You can now more readily re-order items among nested folders, and Cypher statements saved from the editors recall the last folders used for convenience.
95+
96+
image::saved-cypher.gif[]
97+
98+
== Revised paramaters
99+
100+
The parameters implementation has rationalized the `:param` and `:params` variants that differed in Browser.
101+
While singular and plural versions of the command are respected, they behave the same way and offer support for setting parameters singularly via the arrow syntax `:param a => 1` or multiply via Cypher maps `:param {a:1, b: 2}`.
102+
103+
== And finally...
104+
105+
Hope you enjoy using the new Browser preview.
106+
Please note that the following are not yet supported:
107+
108+
- `:server [connect | disconnect]` commands and frames. For the time being the connection header at the top of the page is used to connect to instances
109+
- `:sysinfo` command to review details of your dbms cluster
110+
- `:play` commands to play builtin and custom guides
111+
- `:server user [add | list]` commands to support user management - this is possible via the cypher surface, see docs for more details.
112+
- GraSS and the `:style` command to set custom styles. Some basic styling support is provided via the UI to change colors, captions and size as well as ordering the priority of styles when multiple labels apply to a node.
113+
114+
This new Browser preview will ultimately replace the existing Browser as the default and later, only experience.
115+
If these items or anything else is important to you, please head over to link:https://feedback.neo4j.com/query[] and drop your feedback there.
742 KB
Loading
63.2 KB
Loading
72.8 KB
Loading
58.6 KB
Loading
2.46 MB
Loading
915 KB
Loading
205 KB
Loading
107 KB
Loading
131 KB
Loading

0 commit comments

Comments
 (0)