[TINKERPOP-2050] Add a :bytecode command to Gremlin Console

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Done
• Affects Version/s: 3.2.9
• Fix Version/s: 3.4.0, 3.3.5
• Component/s: console
• Assignee: Stephen Mallette
• Reporter: Jim Hatcher
• Created: 27/Sep/18 16:59
• Updated: 12/Nov/18 17:19
• Resolved: 12/Nov/18 17:19

Description

I am working on a project where there is Java code being written to dynamically generate a Traversal based on a request coming in to an API. You can think of this as a "Traversal Builder."

The code looks something like this:

Traversal<Vertex, Vertex> traversal = g.V();
if (request.searchByAddress == true) {
 traversal.hasLabel("address");
 if (request.address.addressLine1 != null){
 traversal.has("address_line_1", request.address.addressLine1)
 }
}
etc.

When that code is being debugged, a traversal.toString() is run on the traversal to see the ouptut. This output is Gremlin bytecode.

It would be nice to have a way to easily see the Gremlin Groovy that was built so that you could take the Groovy, drop it into Studio, make sure it runs, run a profile() on it, and make sure it's efficient.

I figured out that you can do this by running this code:

private String toGremlinGroovyString(Traversal traversal){
 if (traversal == null){
 return null;
 }

Bytecode bc = traversal.asAdmin().getBytecode();
 return GroovyTranslator.of("g").translate(bc);
 }

I think it would be nice to add that as a method on the Traversal class so that it could be used by driver users more easily.

See comment below for information on the approach taken to help provide support in this area.

Issue Links

• links to: GitHub Pull Request #988