Cpg

object Cpg

TODO this is now being generated as well - for now we'll just forward calls to generated.Cpg next step is to remove this class and move remove the generated part from the generated package

class Object
trait Matchable
class Any

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

Create an empty code property graph

Create an empty code property graph

def emptyGraph: Graph
def withConfig(config: Config): Cpg
def withStorage(path: String): 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 the cpg 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 the cpg at the end.

Value Params
path

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

Implicits

Implicits

implicit
val docSearchPackages: DocSearchPackages