Cypher Cheat Sheet

How the cheat sheet works

Configuration

Example structure

[.neo4j-ee] (1)
==== (2)
[source, cypher, role=noheader] (3)
----
MATCH (n)
RETURN n AS node
----

[.description] (4)
--  (5)
Description

More description
--
====
1 Add a role for each cheat-sheet that the example applies to. Leave blank if it applies in all cases.
2 Use an example block to contain the Cypher example and description.
3 Add an optional block for a Cypher example, specifying [source, cypher,`role=noheader].
4 Add a required description block.
5 If the description consists of more than one paragraph of text, use an open block.

Playbook configuration

asciidoc:
  attributes:
    page-cheatsheets: (1)
      - name: 'Neo4j Enterprise Edition' (2)
        label: 'Enterprise Edition' (3)
        class: 'neo4j-ee' (4)
        default: true (5)
      - name: 'Neo4j Community Edition'
        class: 'neo4j-ce'
      - name: 'Deprecated'
        class: 'deprecated'
        label-only: true (6)
1 Add a page-cheatsheets section to the playbook to define the different views that a user can choose from. In this example we’ve added two views: Neo4j Enterprise Edition and Neo4j Community Edition.
2 Add a name for each view. This text is displayed in the dropdown that you use to select which Cheat Sheet you want to view.
3 [Optional] Add label text. When an example is not applicable in all views, a label is displayed to indicate which views it applies to. If no label value is specified, the value of name is used.
4 Specify a class for each view. This is used to add a role to the example block. For example, the class neo4j-ee is specified by [.neo4j-ee].
5 Specify a default view. This is the view that is displayed when the page is loaded.
6 If you want to display a label for some entries without that label appearing in the dropdown, you can use the label-only attribute. In this example, entries that have the [.deprecated] role will have the Deprecated label displayed, but 'Deprecated' is not an option you can select from the dropdown. In this preview build, both Configuration and Deprecated have been added as label-only views.

Section title

Subsection title

<CYPHER EXAMPLE>

Text describing the example. This example has no role, and therefore no labels. It is displayed in all views.

<CYPHER EXAMPLE>

This example only applies to Neo4j Enterprise Edition and is marked with the [.neo4j-ee] role.

Neo4j Enterprise Edition

Title with link

This entry has no example code.

This entry has no example code.

It contains:

  • more than one paragraph

  • a list

Therefore it is formatted as an open block

MATCH (n)
RETURN n AS node

Displayed for Neo4j Enterprise Edition and AuraDS Enterprise

AuraDS Enterprise

Neo4j Enterprise Edition

MATCH (n:A&B)
RETURN n.name AS name

This example is displayed in all views, and is deprecated.

Deprecated

Not on Aura

Neo4j Community Edition

Neo4j Enterprise Edition

Not on Aura examples

This section applies to Neo4j Community Edition and Neo4j Enterprise Edition. It does not apply to any flavour of Aura. So, we’ve added two roles: [.neo4j-ce.neo4j-ee].

When generating a Neo4j (ie not Aura) cheat sheet, we would only add those two versions to the playbook:

- name: 'Neo4j Community Edition'
  class: 'neo4j-ce'
- name: 'Neo4j Enterprise Edition'
  class: 'neo4j-ee'
  default: true

In this example the labels would not be displayed.

If we add any other versions to the playbook, such as AuraDB Enterprise, the labels will be displayed when viewing the examples for Neo4j Community Edition or Neo4j Enterprise Edition, but the content will be hidden entirely when viewing the AuraDB Enterprise examples.

Deprecated

Deprecated

Deprecated examples

Deprecated

This section contains deprecated examples. The section has a [.deprecated] role, and the subsection and examples also have the role. That’s a lot of labels.

Deprecated

(neo4j:Neo4j {name: "Neo4j"})
(neo4j)-[:INCLUDES]->(browser:Product {name: "Neo4j Browser"})
(browser)-[:HAS]->(:Feature {name: "Cypher"})
(browser)-[:HAS]->(:Feature {name: "Dev Tools"})
(browser)-[:HAS]->(:Feature {name: "Visualization"})
(neo4j)-[:CONNECTS_WITH]->(drivers:Drivers {name: "Drivers"})
(drivers)-[:SUPPORTS]->(:Language {name: "Java"})

Deprecated cypher example.

Deprecated