Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package shiftleft
    Definition Classes
    io
  • package queryprimitives

    Domain specific language for querying code property graphs

    Domain specific language for querying code property graphs

    This is the API reference for the CPG query language, a language to mine code for defects and vulnerabilities both interactively on a code analysis shell (REPL), or using non-interactive scripts.

    Queries written in the CPG query language express graph traversals (see https://en.wikipedia.org/wiki/Graph_traversal). Similar to the standard graph traversal language "Gremlin" (see https://en.wikipedia.org/wiki/Gremlin_(programming_language))) these traversals are formulated as sequences of primitive language elements referred to as "steps". You can think of a step as a small program, similar to a unix shell utility, however, instead of processing lines one by one, the step processes nodes of the graph.

    Starting a traversal

    All traversals begin by selecting a set of start nodes, e.g.,

    cpg.method

    will start the traversal at all methods, while

    cpg.local

    will start at all local variables. The complete list of starting points can be found here: io.shiftleft.queryprimitives.steps.starters.Cpg

    Lazy evaluation

    Queries are lazily evaluated, e.g., cpg.method creates a traversal which you can add more steps to. You can, for example, evaluate the traversal by converting it to a list:

    cpg.method.toList

    Since toList is such a common operation, we provide the shorthand l, meaning that

    cpg.method.l

    provides the same result as the former query.

    Properties

    Nodes have "properties", key-value pairs where keys are strings and values are primitive data types such as strings, integers, or Booleans. Properties of nodes can be selected based on their key, e.g.,

    cpg.method.name

    traverses to all method names. Nodes can also be filtered based on properties, e.g.,

    cpg.method.name(".*exec.*")

    traverse to all methods where name matches the regular expression ".*exec.*". You can see a complete list of properties by browsing to the API documentation of the corresponding step. For example, you can find the properties of method nodes at io.shiftleft.queryprimitives.steps.types.structure.Method.

    Side effects

    Useful if you want to mutate something outside the traversal, or simply debug it: This prints all typeDecl names as it traverses the graph and increments i for each one.

    var i = 0
cpg.typeDecl.sideEffect{typeTemplate => println(typeTemplate.name); i = i + 1}.exec

    [advanced] Selecting multiple things from your traversal

    If you are interested in multiple things along the way of your traversal, you label anything using the as modulator, and use select at the end. Note that the compiler automatically derived the correct return type as a tuple of the labelled steps, in this case with two elements.

    cpg.method.as("method").definingTypeDecl.as("classDef").select.toList
// return type: List[(nodes.Method, nodes.TypeDecl)]

    [advanced] For comprehensions

    You can always start a new traversal from a node, e.g.,

    val someMethod = cpg.method.head
someMethod.start.parameter.toList

    You can use this e.g. in a for comprehension, which is (in this context) essentially an alternative way to select multiple intermediate things. It is more expressive, but more computationally expensive.

    val query = for {
  method <- cpg.method
  param <- method.start.parameter
} yield (method.name, param.name)

query.toList
    Definition Classes
    shiftleft
  • package steps

    Steps for traversing the code property graph

    Steps for traversing the code property graph

    All traversal start at io.shiftleft.queryprimitives.starters.Cpg.

    Definition Classes
    queryprimitives
  • package types
    Definition Classes
    steps
  • package expressions
    Definition Classes
    types
  • package generalizations
    Definition Classes
    expressions
  • Call
  • Identifier
  • Literal

class Identifier[Labels <: HList] extends CpgSteps[codepropertygraph.generated.nodes.Identifier, Labels] with ExpressionBase[codepropertygraph.generated.nodes.Identifier, Labels] with CodeAccessors[codepropertygraph.generated.nodes.Identifier, Labels] with NameAccessors[codepropertygraph.generated.nodes.Identifier, Labels] with OrderAccessors[codepropertygraph.generated.nodes.Identifier, Labels] with LineNumberAccessors[codepropertygraph.generated.nodes.Identifier, Labels] with EvalTypeAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

An identifier, e.g., an instance of a local variable, or a temporary variable

Linear Supertypes
NameAccessors[codepropertygraph.generated.nodes.Identifier, Labels], ExpressionBase[codepropertygraph.generated.nodes.Identifier, Labels], LineNumberAccessors[codepropertygraph.generated.nodes.Identifier, Labels], CodeAccessors[codepropertygraph.generated.nodes.Identifier, Labels], StringPropertyAccessors[codepropertygraph.generated.nodes.Identifier, Labels], EvalTypeAccessors[codepropertygraph.generated.nodes.Identifier, Labels], OrderAccessors[codepropertygraph.generated.nodes.Identifier, Labels], PropertyAccessors[codepropertygraph.generated.nodes.Identifier, Labels], CpgSteps[codepropertygraph.generated.nodes.Identifier, Labels], NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels], Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels], StepsRoot, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Identifier
  2. NameAccessors
  3. ExpressionBase
  4. LineNumberAccessors
  5. CodeAccessors
  6. StringPropertyAccessors
  7. EvalTypeAccessors
  8. OrderAccessors
  9. PropertyAccessors
  10. CpgSteps
  11. NodeSteps
  12. Steps
  13. StepsRoot
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Identifier(raw: GremlinScala[Vertex])

Type Members

  1. type EndDomain0 = codepropertygraph.generated.nodes.Identifier
    Definition Classes
    Steps → StepsRoot
  2. type EndGraph0 = Vertex
    Definition Classes
    Steps → StepsRoot

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _toJson(pretty: Boolean): String
    Attributes
    protected
    Definition Classes
    CpgSteps
  5. def aggregate(into: Buffer[codepropertygraph.generated.nodes.Identifier]): NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels]
    Definition Classes
    NodeSteps
  6. def and(andTraversals: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, HNil]) ⇒ Steps[_, _, _]*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  7. def as[NewLabels <: HList](stepLabel: StepLabel[codepropertygraph.generated.nodes.Identifier])(implicit prependDomain: shapeless.ops.hlist.Prepend.Aux[Labels, ::[codepropertygraph.generated.nodes.Identifier, HNil], NewLabels]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, NewLabels]
    Definition Classes
    Steps
  8. def as[NewLabels <: HList](stepLabel: String)(implicit prependDomain: shapeless.ops.hlist.Prepend.Aux[Labels, ::[codepropertygraph.generated.nodes.Identifier, HNil], NewLabels]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, NewLabels]
    Definition Classes
    Steps
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def call: Call[Labels]

    Cast to call if applicable

    Cast to call if applicable

    Definition Classes
    ExpressionBase
  11. def cfgNext: Expression[Labels]

    Traverse to next expression in CFG.

    Traverse to next expression in CFG.

    Definition Classes
    ExpressionBase
  12. def cfgPrev: Expression[Labels]

    Traverse to previous expression in CFG.

    Traverse to previous expression in CFG.

    Definition Classes
    ExpressionBase
  13. def clone(): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps → AnyRef
  14. def code(value: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  15. def code(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  16. def code(): Steps[String, String, Labels]
    Definition Classes
    CodeAccessors
  17. def codeExact(values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  18. def codeExact(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  19. def codeNot(values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  20. def codeNot(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    CodeAccessors
  21. val converter: Converter[codepropertygraph.generated.nodes.Identifier] { type GraphType = gremlin.scala.Vertex }
    Definition Classes
    Identifier → StringPropertyAccessors → EvalTypeAccessors → PropertyAccessors → Steps
  22. def count(): Long
    Definition Classes
    Steps
  23. def dedup(): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  24. def emit(emitTraversal: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, HNil]) ⇒ Steps[_, _, _]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  25. def emit(): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. def evalType(_values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  29. def evalType(_value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  30. def evalType(): Steps[String, String, Labels]
    Definition Classes
    EvalTypeAccessors
  31. def evalTypeExact(_values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  32. def evalTypeExact(_value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  33. def evalTypeNot(_values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  34. def evalTypeNot(_value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    EvalTypeAccessors
  35. def exec(): Unit
    Definition Classes
    Steps
  36. def expression: Expression[Labels]

    Traverse to sub expressions

    Traverse to sub expressions

    Definition Classes
    ExpressionBase
  37. def expressionUp: Expression[Labels]

    Traverse to enclosing expression

    Traverse to enclosing expression

    Definition Classes
    ExpressionBase
  38. def file: File[Labels]

    Traverse to source file

    Traverse to source file

    Definition Classes
    CpgSteps
  39. def filter(predicate: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]) ⇒ Steps[_, _, _]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  40. def filterNot(predicate: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]) ⇒ Steps[_, _, _]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  41. def filterOnEnd(predicate: (codepropertygraph.generated.nodes.Identifier) ⇒ Boolean): NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels]
    Definition Classes
    NodeSteps
  42. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. def flatMap[NewSteps <: StepsRoot](fun: (codepropertygraph.generated.nodes.Identifier) ⇒ NewSteps)(implicit constr: Aux[gremlin.scala.dsl.Steps.flatMap.NewSteps.EndDomain0, Labels, gremlin.scala.dsl.Steps.flatMap.NewSteps.EndGraph0, NewSteps], newConverter: Converter[gremlin.scala.dsl.Steps.flatMap.NewSteps.EndDomain0]): NewSteps
    Definition Classes
    Steps
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. implicit val graph: Graph
    Definition Classes
    CpgSteps
  46. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def head(): codepropertygraph.generated.nodes.Identifier
    Definition Classes
    Steps
  48. def headOption(): Option[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  49. def id(ids: AnyRef*): NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels]
    Definition Classes
    NodeSteps
  50. def identifier: Identifier[Labels]

    Cast to identifier, if applicable

    Cast to identifier, if applicable

    Definition Classes
    ExpressionBase
  51. def isDefined: Boolean
    Definition Classes
    Steps
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def iterate(): Unit
    Definition Classes
    Steps
  54. def l: List[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  55. def lineNumber(value: Integer*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    LineNumberAccessors
  56. def lineNumber(value: Integer): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    LineNumberAccessors
  57. def lineNumber(): Steps[Integer, Integer, Labels]
    Definition Classes
    LineNumberAccessors
  58. def lineNumberNot(values: Integer*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    LineNumberAccessors
  59. def lineNumberNot(value: Integer): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    LineNumberAccessors
  60. def literal: Literal[Labels]

    Cast to literal if applicable

    Cast to literal if applicable

    Definition Classes
    ExpressionBase
  61. def map[NewEndDomain, NewEndGraph, NewSteps <: StepsRoot](fun: (codepropertygraph.generated.nodes.Identifier) ⇒ NewEndDomain)(implicit newConverter: Aux[NewEndDomain, NewEndGraph], constr: Aux[NewEndDomain, Labels, NewEndGraph, NewSteps]): NewSteps
    Definition Classes
    Steps
  62. def method: Method[Labels]

    Traverse to enclosing method

    Traverse to enclosing method

    Definition Classes
    ExpressionBase
  63. def name(value: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where the name matches at least one of the regular expressions in values

    Traverse to nodes where the name matches at least one of the regular expressions in values

    Definition Classes
    NameAccessors
  64. def name(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where the name matches the regular expression value

    Traverse to nodes where the name matches the regular expression value

    Definition Classes
    NameAccessors
  65. def name(): Steps[String, String, Labels]

    Traverse to name

    Traverse to name

    Definition Classes
    NameAccessors
  66. def nameExact(values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where name matches one of the elements in values exactly.

    Traverse to nodes where name matches one of the elements in values exactly.

    Definition Classes
    NameAccessors
  67. def nameExact(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where name matches value exactly.

    Traverse to nodes where name matches value exactly.

    Definition Classes
    NameAccessors
  68. def nameNot(values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where name does not match any of the regular expressions in values.

    Traverse to nodes where name does not match any of the regular expressions in values.

    Definition Classes
    NameAccessors
  69. def nameNot(value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

    Traverse to nodes where name does not match the regular expression value.

    Traverse to nodes where name does not match the regular expression value.

    Definition Classes
    NameAccessors
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. def onRaw(fun: (GremlinScala[Vertex]) ⇒ GremlinScala[Vertex]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  74. def or(orTraversals: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, HNil]) ⇒ Steps[_, _, _]*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  75. def order(value: Integer*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    OrderAccessors
  76. def order(value: Integer): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    OrderAccessors
  77. def order(): Steps[Integer, Integer, Labels]
    Definition Classes
    OrderAccessors
  78. def orderBy[A](fun: (codepropertygraph.generated.nodes.Identifier) ⇒ A): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  79. def orderNot[Out](values: Integer*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    OrderAccessors
  80. def orderNot(value: Integer): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    OrderAccessors
  81. def p(): Unit
    Definition Classes
    Steps
  82. def property[P](property: Key[P]): Steps[P, P, Labels]
    Definition Classes
    PropertyAccessors
  83. def propertyFilter[Out, P](property: Key[P], value: P): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    PropertyAccessors
  84. def propertyFilterMultiple[Out, P](property: Key[P], values: P*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    PropertyAccessors
  85. def propertyFilterNot[Out, P](property: Key[P], value: P): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    PropertyAccessors
  86. def propertyFilterNotMultiple[Out, P](property: Key[P], values: P*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    PropertyAccessors
  87. val raw: GremlinScala[Vertex]
    Definition Classes
    CpgSteps → NodeSteps → Steps → StepsRoot
  88. def refsTo: Declaration[Labels]

    Traverse to all declarations of this identifier

  89. def repeat[NewEndDomain >: codepropertygraph.generated.nodes.Identifier](repeatTraversal: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, HNil]) ⇒ Steps[NewEndDomain, Vertex, _])(implicit newConverter: Aux[NewEndDomain, Vertex]): Steps[NewEndDomain, Vertex, Labels]
    Definition Classes
    Steps
  90. def s(): Stream[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  91. def select[StepLabelsTuple <: Product, StepLabels <: HList, H0, T0 <: HList, SelectedTypes <: HList, SelectedTypesTuple <: Product, SelectedGraphTypesTuple <: Product, LabelNames <: HList, Z](stepLabelsTuple: StepLabelsTuple)(implicit toHList: Aux[StepLabelsTuple, StepLabels], hasOne: Aux[StepLabels, H0, T0], hasTwo: IsHCons[T0], extractLabelType: Aux[StepLabels, SelectedTypes], tupler: shapeless.ops.hlist.Tupler.Aux[SelectedTypes, SelectedTypesTuple], conv: Aux[SelectedTypesTuple, SelectedGraphTypesTuple], stepLabelToString: Aux[GetLabelName.type, StepLabels, LabelNames], trav: Aux[LabelNames, List, String], folder: Aux[StepLabels, (HNil, Map[String, Any]), combineLabelWithValue.type, (SelectedTypes, Z)]): Steps[SelectedTypesTuple, SelectedGraphTypesTuple, Labels]
    Definition Classes
    Steps
  92. def select[Label, LabelGraph](label: StepLabel[Label])(implicit conv1: Aux[Label, LabelGraph]): Steps[Label, LabelGraph, Labels]
    Definition Classes
    Steps
  93. def select[LabelsGraph <: HList, LabelsGraphTuple, LabelsTuple]()(implicit conv1: Aux[Labels, LabelsGraph], tupler1: shapeless.ops.hlist.Tupler.Aux[LabelsGraph, LabelsGraphTuple], tupler2: shapeless.ops.hlist.Tupler.Aux[Labels, LabelsTuple], conv2: Aux[LabelsTuple, LabelsGraphTuple]): Steps[LabelsTuple, LabelsGraphTuple, Labels]
    Definition Classes
    Steps
  94. def sideEffect(fun: (codepropertygraph.generated.nodes.Identifier) ⇒ Any): NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels]
    Definition Classes
    NodeSteps
  95. def stringProperty(property: Key[String]): Steps[String, String, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  96. def stringPropertyFilter(property: Key[String], value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  97. def stringPropertyFilterExact[Out](property: Key[String], _value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  98. def stringPropertyFilterExactMultiple[Out](property: Key[String], values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  99. def stringPropertyFilterMultiple(property: Key[String], values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  100. def stringPropertyFilterNot[Out](property: Key[String], value: String): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  101. def stringPropertyFilterNotMultiple[Out](property: Key[String], values: String*): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Attributes
    protected
    Definition Classes
    StringPropertyAccessors
  102. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  103. def times(maxLoops: Int): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  104. def toBuffer(): Buffer[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  105. def toJson: String

    Execute traversal and convert the result to json.

    Execute traversal and convert the result to json.

    Definition Classes
    CpgSteps
  106. def toJsonPretty: String
    Definition Classes
    CpgSteps
  107. def toList(): List[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  108. def toMaps(): Steps[Map[String, AnyRef], Map[String, AnyRef], Labels]
    Definition Classes
    CpgSteps
  109. def toParameter: MethodParameter[Labels]

    Traverse to related parameter

    Traverse to related parameter

    Definition Classes
    ExpressionBase
  110. def toSet(): Set[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  111. def toStream(): Stream[codepropertygraph.generated.nodes.Identifier]
    Definition Classes
    Steps
  112. def toString(): String
    Definition Classes
    Steps → AnyRef → Any
  113. def typ: Type[Labels]

    Traverse to expression evaluation type

    Traverse to expression evaluation type

    Definition Classes
    ExpressionBase
  114. def until(untilTraversal: (Steps[codepropertygraph.generated.nodes.Identifier, Vertex, HNil]) ⇒ Steps[_, _, _]): Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]
    Definition Classes
    Steps
  115. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  116. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  118. def walkIn(edgeType: String): GremlinScala[Vertex]
    Definition Classes
    NodeSteps

Inherited from NameAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from ExpressionBase[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from LineNumberAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from CodeAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from StringPropertyAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from EvalTypeAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from OrderAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from PropertyAccessors[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from CpgSteps[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from NodeSteps[codepropertygraph.generated.nodes.Identifier, Labels]

Inherited from Steps[codepropertygraph.generated.nodes.Identifier, Vertex, Labels]

Inherited from StepsRoot

Inherited from AnyRef

Inherited from Any

Ungrouped