Package: gremlinpython
Apache TinkerPop™is a graph computing framework for both graph databases (OLTP) and
graph analytic systems (OLAP).Gremlinis the graph traversal language of
TinkerPop. It can be described as a functional, data-flow language that enables users to succinctly express complex
traversals on (or queries of) their application’s property graph.Gremlin-Python implements Gremlin within the Python language and can be used on any Python virtual machine including
the popular CPython machine. Python’s syntax has the same constructs as Java including “dot notation” for function
chaining(a.b.c), round bracket function arguments(a(b,c)), and support for global namespaces(a(b())vsa(__.b())). As such, anyone familiar with Gremlin-Java will immediately be able to work with
Gremlin-Python. Moreover, there are a few added constructs to Gremlin-Python that make traversals a bit more succinct.Gremlin-Python is designed to connect to a “server” that is hosting a TinkerPop-enabled graph system. That “server”
could beGremlin Serveror aremote Gremlin providerthat exposes
protocols by which Gremlin-Python can connect.A typical connection to a server running on “localhost” that supports the Gremlin Server protocol using websockets
from the Python shell looks like this:>>> from gremlin_python.process.anonymous_traversal import traversal
>>> from gremlin_python.driver.driver_remote_connection import DriverRemoteConnection
>>> g = traversal().with_remote(DriverRemoteConnection('ws://localhost:8182/gremlin','g'))Once “g” has been created using a connection, it is then possible to start writing Gremlin traversals to query the
remote graph:>>> g.V().both()[1:3].to_list()
[v[2], v[4]]
>>> g.V().both()[1].to_list()
[v[2]]
>>> g.V().both().name.to_list()
[lop, vadas, josh, marko, marko, josh, peter, ripple, lop, marko, josh, lop]Sample TraversalsThe Gremlin language allows users to write highly expressive graph traversals and has a broad list of functions that
cover a wide body of features. TheReference Documentationdescribes these functions and other aspects of the TinkerPop ecosystem including some specifics onGremlin in Pythonitself. Most of the
examples found in the documentation use Groovy language syntax in theGremlin Console.
For the most part, these examples should generally translate to Python withsome modification. Given the
strong correspondence between canonical Gremlin in Java and its variants like Python, there is a limited amount of
Python-specific documentation and examples. This strong correspondence among variants ensures that the general
Gremlin reference documentation is applicable to all variants and that users moving between development languages can
easily adopt the Gremlin variant for that language.Create Vertexfromgremlin_python.process.traversalimportTfromgremlin_python.process.traversalimportCardinalityid=T.idsingle=Cardinality.singledefcreate_vertex(self,vid,vlabel):# default database cardinality is used when Cardinality argument is not specifiedg.add_v(vlabel).property(id,vid).\property(single,'name','Apache').\property('lastname','Tinkerpop').\next()Find Verticesdeflist_all(self,limit=500):g.V().limit(limit).element_map().to_list()deffind_vertex(self,vid):g.V(vid).element_map().next()deflist_by_label_name(self,vlabel,name):g.V().has(vlabel,'name',name).element_map().to_list()Update Vertexfromgremlin_python.process.traversalimportCardinalitysingle=Cardinality.singledefupdate_vertex(self,vid,name):g.V(vid).property(single,'name',name).next()NOTE that versions suffixed with “rc” are considered release candidates (i.e. pre-alpha, alpha, beta, etc.) and
thus for early testing purposes only. These releases are not suitable for production.