https://github.com/m-thirumal/gremlin-dsl

Gremlin DSL (Domain Specific Language) implementation guide
https://github.com/m-thirumal/gremlin-dsl

apache-tinkerpop domain-specific-language dsl graph-database graph-theory gremlin tinkerpop3

Last synced: 26 days ago
JSON representation

Gremlin DSL (Domain Specific Language) implementation guide

• Host: GitHub
• URL: https://github.com/m-thirumal/gremlin-dsl
• Owner: m-thirumal
• Created: 2022-09-13T15:47:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-14T03:29:43.000Z (about 2 years ago)
• Last Synced: 2025-02-08T12:46:19.659Z (3 months ago)
• Topics: apache-tinkerpop, domain-specific-language, dsl, graph-database, graph-theory, gremlin, tinkerpop3
• Language: Java
• Homepage:
• Size: 3.48 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
= Gremlin DSL

Gremlin DSL (Domain Specific Language) Example/Guide.

For more information refer the link: https://tinkerpop.apache.org/docs/current/reference/#dsl

Dependency required 

[source, xml]

----

    org.apache.tinkerpop

    gremlin-annotations

    3.6.1

----

== Eclipse Set up

* Import this project as `maven spring-boot` project.

* Typically, the Java compilation process is automatically configured to detect annotation processors on the classpath and will automatically use them when found. 

* If that does not happen, it may be necessary to make configuration changes to the build to allow for the compilation process to be aware of the following `javax.annotation.processing.Processor` implementation:

[source, java]

----

org.apache.tinkerpop.gremlin.process.traversal.dsl.GremlinDslProcessor

----

* The annotation processor will generate several classes for the DSL:

`SocialTraversal` - A Traversal interface that extends the SocialTraversalDsl proxying methods to its underlying interfaces (such as GraphTraversal) to instead return a SocialTraversal

`DefaultSocialTraversal` - A default implementation of SocialTraversal (typically not used directly by the user)

`SocialTraversalSource` - Spawns DefaultSocialTraversal instances.

`__` - Spawns anonymous DefaultSocialTraversal instances.

=== Annotation detection

* Right click on the project and select `properties` -> `Java compiler` -> `Annotation Processing`

	** Enable project specific settings 

	** Go to `Factory Path` and add the `jar` path in the repo.

	

image::doc/img/annotation.png[annotation, 1200, 800]

==== Link Generated source to the project for eclipse

* Right click on your project > Build Path > Configure Build Path

* In sources tag, click on `[Add Folder]` button

* Check `target/generated-sources/annotations`

image::doc/img/dsl-annotation.png[dsl, 600, 400]