Package org.neo4j.gds.doc

Interface QueryExample

  • All Superinterfaces:
    DocQuery
    public interface QueryExample
extends DocQuery
    Query examples are specified in two sections: 
     [role=query-example]
 --
 .Header text goes here:
 [source, cypher]
 ----
 MATCH (n) RETURN n.a AS a, n.b AS b
 ----
 .Results
 [opts="header"]
 |===
 | a        | b
 | "Alice"  | 7
 | "Bob"    | 11
 |===
 --
    The sections are turned into the query and assertions about the query result, respectively, and they then get turned into a single test case.

    • Method Detail

      • query

        java.lang.String query()
        Specified by:
        query in interface DocQuery

      • resultColumns

        @Default
default java.util.List<java.lang.String> resultColumns()

      • results

        @Default
default java.util.List<java.util.List<java.lang.String>> results()

      • assertResults

        @Default
default boolean assertResults()

      • runAsOperator

        @Derived
default boolean runAsOperator()
        Specified by:
        runAsOperator in interface DocQuery

      • operator

        @Default
default java.lang.String operator()
        Specified by:
        operator in interface DocQuery

      • builder

        static org.neo4j.gds.doc.ImmutableQueryExample.Builder builder()