Cpg

io.shiftleft.codepropertygraph.generated.Cpg$
See theCpg companion class
object Cpg

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cpg.type

Members list

Concise view

Value members

Concrete methods

def apply(implicit graph: Graph): Cpg

Syntactic sugar for new Cpg(graph). Usage: Cpg(graph) or simply Cpg if you have an implicit Graph in scope

Syntactic sugar for new Cpg(graph). Usage: Cpg(graph) or simply Cpg if you have an implicit Graph in scope

Attributes

def convertPropertyForPersistence(property: Any): Any
def empty: Cpg
def emptyGraph: Graph
def withConfig(config: Config): Cpg
def withStorage(path: Path): Cpg

Instantiate Cpg with storage. If the storage file already exists, it will load (a subset of) the data into memory. Otherwise it will create an empty Cpg. In either case, configuring storage means that OverflowDb will be stored to disk on shutdown (close). I.e. if you want to preserve state between sessions, just use this method to instantiate the Cpg and ensure to properly close it at the end.

Instantiate Cpg with storage. If the storage file already exists, it will load (a subset of) the data into memory. Otherwise it will create an empty Cpg. In either case, configuring storage means that OverflowDb will be stored to disk on shutdown (close). I.e. if you want to preserve state between sessions, just use this method to instantiate the Cpg and ensure to properly close it at the end.

Attributes

path

to the storage file, e.g. /home/user1/overflowdb.bin

def withStorage(path: String): Cpg

Implicits

Implicits

implicit val defaultDocSearchPackage: DocSearchPackages