META-INF.README.asciidoc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-graphgist Show documentation

Cypher tutorial documentation tool.

There is a newer version: 3.1.0-M08

== Introduction ==

THIS IS OUTDATED ... will fix!

This is a tool to easily generate output from Cypher queries.

You feed it with files, where each file can contain multiple queries.
Queries are separated by a blank line.
All queries in the same file will be executed against the same database.
The database has automatic indexing turned on for both nodes and relationships.

The output is formatted for inclusion in Neo4j AsciiDoc documents.
There are output files for:

* the query
* query result
* graph visualization
* live console
* live console, starting with an empty database

== Usage ==

This is how to execute it from a Maven 'pom.xml' file:

----

  org.codehaus.mojo
  exec-maven-plugin
  1.2.1
  
    
      org.neo4j.doc
      cypher-executor
      0.1-SNAPSHOT
    
  
  
    
      execute-queries
      generate-sources
      
        java
      
      
        false
        true
        
          org.neo4j.doc
          cypher-executor
        
        org.neo4j.doc.cypherexecutor.Main
        
          hello-world
        
      
    
  

----

TIP: To execute more files, just add additional ++ elements.

The result will end up in the 'target/snippets' directory.