十六 Gremlin Core Notes

GremlinScriptEngineManager

JSR223,是java 的脚本引擎，gremlin 使用groovy 作为脚本语言来定义gremlin

整个 gremlin 的 script-engine-manager 结构是

• GremlinScriptEngineManager

• DefaultGremlinScriptEngineManager implements GremlinScriptEngineManager

• CachedGremlinScriptEngineManager extends DefaultGremlinScriptEngineManager

• SingleGremlinScriptEngineManager 引用 cachedManager 来实现单例模式；

在DefaultManager中，主要的工作就是
查找GremlinScriptEngineFactory 的实现，通过 Factory来创建 script-engine的实例；
主要使用的机制为java spi 机制； 后续我们可以看看， java 的 service provide interface(spi)的实现

GremlinGroovyScriptEngineFactory： 是对于ScriptEngineFactory的实现；

    @Override
    public GremlinScriptEngine getScriptEngine() {
        final List<Customizer> customizers =  manager.getCustomizers(ENGINE_NAME);
        return (customizers.isEmpty()) ? new GremlinGroovyScriptEngine() :
                new GremlinGroovyScriptEngine(customizers.toArray(new Customizer[customizers.size()]));
    }

核心就是 创建：GremlinGroovyScriptEngine，我们看看这个类的核心实现：

• ScriptEngine 使用的是javax.script的核心接口
• GremlinScriptEngine extends ScriptEngine,多出来两个接口，对应图中的travesal

    public default Traversal.Admin eval(final Bytecode bytecode, final String traversalSource) throws ScriptException {
        final Bindings bindings = this.createBindings();
        bindings.putAll(bytecode.getBindings());
        return eval(bytecode, bindings, traversalSource);
    }
    /**
     * Evaluates {@link Traversal} {@link Bytecode} with the specified {@code Bindings}. These {@code Bindings}
     * supplied to this method will be merged with global engine bindings and override them where keys match.
     */
    public Traversal.Admin eval(final Bytecode bytecode, final Bindings bindings, final String traversalSource) throws ScriptException;

• GremlinGroovyScriptEngine extends GroovyScriptEngineImpl，groovyEngine,是java执行groovy的引擎；

        org.apache.tinkerpop.gremlin.process.traversal.Script script = org.apache.tinkerpop.gremlin.process.traversal.translator.GroovyTranslator.of(HIDDEN_G, typeTranslator).translate(bytecode);

核心就是 translate 成为 TRaversal.Admin, 来看看，是如何把一个gremlin语句翻译成 Traversal的；
核心就是 对gremlin AST 分析，然后每个element 与 GraphTraversal 对应，通过eval 生成 TravesalAdmin;

Traversal 的核心接口

设计的核心原理

• Traversal<S, E> extends Iterator<E>, Serializable, Cloneable, AutoCloseable
• public interface Admin<S, E> extends Traversal<S, E>
  Admin 接口是对 traveral 接口的 admin 封装，如果说traveral 代表的是 query，那么admin 就是 CRUD;

traveral 是对一个OLTP 查询的抽象，可以认为是一个 queryPlan;

• DefaultTraversal<S, E> implements Traversal.Admin<S, E>
• DefaultGraphTraversal<S, E> extends DefaultTraversal<S, E> implements GraphTraversal.Admin<S, E>

核心的实现是在GraphTraversal
我们写的 g.V().hasId().outE().inV(),等所有的构建traversal 的语句都在这里，可以是builder。

GraphTraversal 创建，使用的是 GraphTraversalSource；我们主要用到的是 g.V(),g.E(),返回一个traversal
当然我们看GraphTraversalSource的代码，还有很多with的方法，也就是在每个traversal的时候，我们可以按需求定义很多我们需要的东西；

另外一个重要的概念是 Traverser, 这个和执行时有关，代表的是tarversal 执行到的某个阶段，我们可以认为是执行到step的指针。
tarverser 有很多种类型，根据不同的step，会生成不同的tarverser

The objects propagating through the traversal are wrapped in a Traverser<T>.
 The traverser provides the means by which steps remain stateless.
  A traverser maintains all the metadata about the traversal — e.g.,
   how many times the traverser has gone through a loop, the path history of the traverser,
    the current object being traversed, etc. Traverser metadata may be accessed by a step.
     A classic example is the path()-step.

Gremlin 的编译

在gremlin-groovy 包里面，使用的是groovy 的eval 功能，也就是 java-jsr-223, scripe-engine
g.V().out() 这样的语法，eval 出来就是一个 graphTraversal，所以最后的核心依旧是Gremlin-core的内容；
到此为止，gremlin 的编译-> execution plan 就结束了；

Gremlin 的执行

g.V().out()的执行引擎，是一个 尾递归的引擎；从尾部递归到头，压栈，然后从头开始执行；
不明白为啥设计成这个样子；
整个引擎是一个单步的DFS，可以使用barrier 变成 BFS。
目前OLTP中，无法实现 并行的查询比如 kout；