Package org.neo4j.gds.doc

Interface QueryExampleGroup

  • public interface QueryExampleGroup
    Query examples are grouped by displayName like so ('myGroup' becomes the displayName): 
     [role=query-example, group=myGroup]
 --
 [...]
 --

 [role=query-example, group=myGroup]
 --
 [...]
 --
    When it comes to executing tests, the query examples in a group are executed in document order with a single for-each query. This ensures the effects from one query are visible to other queries. Think mutate followed by stream, or write followed by arbitrary Cypher. If you do not specify the group attribute, your query is assigned a dummy displayName and executed in isolation.

    • Method Detail

      • displayName

        java.lang.String displayName()
        Only used for test names in JUnit

      • queryExamples

        java.util.List<QueryExample> queryExamples()

      • builder

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