oracle.pgx.api.subgraph

Class GenericSubgraphReader

java.lang.Object

oracle.pgx.api.subgraph.AbstractSubgraphReader<GenericSubgraphReader>

oracle.pgx.api.subgraph.GenericSubgraphReader

public class GenericSubgraphReader
extends AbstractSubgraphReader<GenericSubgraphReader>

Entry point for subgraph reading. This reader does not support any operation by itself. To use the initial subgraph reading feature, specify a source. You may, for example, use fromPgView(String) to start configuring a reading operation from PG Views, using some PGQL queries.

Constructor Summary

Constructors

Constructor and Description
GenericSubgraphReader(PgxSession session, oracle.pgx.api.subgraph.internal.KeystoreLookup keystoreLookup, java.util.function.Function<GraphConfig,PgxFuture<PgxGraph>> readFunction) Create an instance of this generic reader.

Method Summary

Modifier and Type	Method and Description
PgSqlSubgraphReader	fromPgSql(java.lang.String graphName) Read a subgraph of a SQL Property Graph, using a set of PGQL queries.
PgSqlSubgraphReader	fromPgSql(java.lang.String schemaName, java.lang.String graphName) Read a subgraph of a SQL Property Graph, using a set of PGQL queries.
PgViewSubgraphReader	fromPgView(java.lang.String viewName) Read a subgraph from PG Views, using a set of PGQL queries.
PgViewSubgraphReader	fromPgView(java.lang.String schemaName, java.lang.String viewName) Read a subgraph from PG Views, using a set of PGQL queries.
PgxFuture<PgxGraph>	loadAsync(java.lang.String graphName) Load the subgraph.

Methods inherited from class oracle.pgx.api.subgraph.AbstractSubgraphReader

load, load, loadAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericSubgraphReader

public GenericSubgraphReader(PgxSession session,
                             oracle.pgx.api.subgraph.internal.KeystoreLookup keystoreLookup,
                             java.util.function.Function<GraphConfig,PgxFuture<PgxGraph>> readFunction)

Create an instance of this generic reader. Do not use this constructor, use PgxSession.readSubgraph() to acquire an instance instead.

Parameters:

session - The session for the read operation.

keystoreLookup - A helper of looking up keystore entries.

readFunction - A function used to read the actual subgraph.

Method Detail

fromPgSql

public PgSqlSubgraphReader fromPgSql(java.lang.String graphName)

Read a subgraph of a SQL Property Graph, using a set of PGQL queries.

Parameters:

graphName - The SQL graph name.

Returns:

A config builder for the read operation.

fromPgSql

public PgSqlSubgraphReader fromPgSql(java.lang.String schemaName,
                                     java.lang.String graphName)

Read a subgraph of a SQL Property Graph, using a set of PGQL queries.

Parameters:

graphName - The SQL schema name.

graphName - The SQL graph name.

Returns:

A config builder for the read operation.

fromPgView

public PgViewSubgraphReader fromPgView(java.lang.String viewName)

Read a subgraph from PG Views, using a set of PGQL queries.

Parameters:

viewName - The name of the view in the database.

Returns:

A config builder for the read operation.

fromPgView

public PgViewSubgraphReader fromPgView(java.lang.String schemaName,
                                       java.lang.String viewName)

Read a subgraph from PG Views, using a set of PGQL queries.

Parameters:

viewName - The name of the view in the database.

schemaName - The name of the schema in the database.

Returns:

A config builder for the read operation.

loadAsync

public PgxFuture<PgxGraph> loadAsync(java.lang.String graphName)

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Specified by:

loadAsync in class AbstractSubgraphReader<GenericSubgraphReader>

Parameters:

graphName - the name of the graph

Returns:

The subgraph.