15.2.1.3 API for Loading Graphs into Memory
Learn about the APIs used for loading a graph using a JSON configuration file or graph configuration object.
The following methods in PgxSession
can be used to load graphs into
the graph server (PGX).
PgxGraph readGraphWithProperties(String path)
PgxGraph readGraphWithProperties(String path, String newGraphName)
PgxGraph readGraphWithProperties(GraphConfig config)
PgxGraph readGraphWithProperties(GraphConfig config, String newGraphName)
PgxGraph readGraphWithProperties(GraphConfig config, boolean forceUpdateIfNotFresh)
PgxGraph readGraphWithProperties(GraphConfig config, boolean forceUpdateIfNotFresh, String newGraphName)
PgxGraph readGraphWithProperties(GraphConfig config, long maxAge, TimeUnit maxAgeTimeUnit)
PgxGraph readGraphWithProperties(GraphConfig config, long maxAge, TimeUnit maxAgeTimeUnit, boolean blockIfFull, String newGraphName)
read_graph_with_properties(self, config, max_age=9223372036854775807, max_age_time_unit='days',
block_if_full=False, update_if_not_fresh=True, graph_name=None)
The first argument (path
to a graph configuration file
or a parsed config
object) is the meta-data of the graph to be
read. The meta-data includes the following information:
- Location of the graph data such as file location and name, DB location and connection information, and so on
- Format of the graph data such as plain text formats, XML-based formats, binary formats, and so on
- Types and Names of the properties to be loaded
The forceUpdateIfNotFresh
and maxAge
arguments can be used to fine-control the age of the snapshot to be read. The graph
server (PGX) will return an existing graph snapshot if the given graph specification
was already loaded into memory by a different session. So, the
maxAge
argument becomes important if reading from a database in
which the data might change frequently. If no forceUpdateIfNotFresh
or maxAge
is specified, PGX will favor cached data over reading new
snapshots into memory.