oracle.pgx.api.subgraph

Class PgViewSubgraphReader

java.lang.Object

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

oracle.pgx.api.subgraph.PgViewSubgraphReader

Direct Known Subclasses:

PreparedPgViewPgqlQuery

public class PgViewSubgraphReader
extends AbstractSubgraphReader<PgViewSubgraphReader>

A subgraph reader for reading graphs from PG Views, using a set of PGQL queries.

Method Summary

Modifier and Type	Method and Description
PgViewSubgraphReader	connections(int numConnections) sets the number of connections to open to load the data in parallel
PgViewSubgraphReader	dataSourceId(java.lang.String dataSourceId) sets the dataSourceId to which to connect
PgViewSubgraphReader	jdbcUrl(java.lang.String jdbcUrl) sets the jdbcUrl to use for connecting to the DB
PgViewSubgraphReader	keystoreAlias(java.lang.String keystoreAlias) sets the keystore alias to retrieve the password from the keystore
PgxFuture<PgxGraph>	loadAsync() Load the subgraph.
PgxFuture<PgxGraph>	loadAsync(java.lang.String graphName) Load the subgraph.
PgViewSubgraphReader	owner(java.lang.String owner) sets the owner (schema) of the PG view from which to load the data
PgViewSubgraphReader	password(java.lang.String password) sets the password to use for connecting to the database
PreparedPgViewPgqlQuery	preparedPgqlQuery(java.lang.String query) Adds a prepared query to list of queries that will be executed to load the subgraph.
PgViewSubgraphReader	queryPgql(java.lang.String query) Adds another filtering query to the list of queries that will be executed to load the subgraph.
PgViewSubgraphReader	schema(java.lang.String schema) sets the schema from which to load the PG view
PgViewSubgraphReader	username(java.lang.String userName) sets the username of the DB user to use to connect to the DB
PgViewSubgraphReader	withConfig(PartitionedGraphConfig config) sets the graph configuration to use for loading the subgraph.

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

load, load

Methods inherited from class java.lang.Object

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

Method Detail

connections

public PgViewSubgraphReader connections(int numConnections)

sets the number of connections to open to load the data in parallel

Parameters:

numConnections - the number of connections

Returns:

this loader

dataSourceId

public PgViewSubgraphReader dataSourceId(java.lang.String dataSourceId)

sets the dataSourceId to which to connect

Parameters:

dataSourceId - the datasourceId

Returns:

this loader

jdbcUrl

public PgViewSubgraphReader jdbcUrl(java.lang.String jdbcUrl)

sets the jdbcUrl to use for connecting to the DB

Parameters:

jdbcUrl - the jdbc url

Returns:

this loader

keystoreAlias

public PgViewSubgraphReader keystoreAlias(java.lang.String keystoreAlias)

sets the keystore alias to retrieve the password from the keystore

Parameters:

keystoreAlias - the keystore alias

Returns:

this loader

loadAsync

public PgxFuture<PgxGraph> loadAsync()

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Overrides:

loadAsync in class AbstractSubgraphReader<PgViewSubgraphReader>

Returns:

The subgraph.

loadAsync

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

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Specified by:

loadAsync in class AbstractSubgraphReader<PgViewSubgraphReader>

Parameters:

graphName - the name of the graph

Returns:

The subgraph.

owner

public PgViewSubgraphReader owner(java.lang.String owner)

sets the owner (schema) of the PG view from which to load the data

Parameters:

owner - the owner

Returns:

this loader

password

public PgViewSubgraphReader password(java.lang.String password)

sets the password to use for connecting to the database

Parameters:

password - the password

Returns:

this loader

preparedPgqlQuery

public PreparedPgViewPgqlQuery preparedPgqlQuery(java.lang.String query)

Adds a prepared query to list of queries that will be executed to load the subgraph. The query has to also start with a MATCH clause. This returns a builder which can be used to specify arguments for the prepared query. All the arguments must be provided before the reading operation is triggered.

Parameters:

query - The PGQL query.

Returns:

A builder used for providing arguments of the prepared query.

queryPgql

public PgViewSubgraphReader queryPgql(java.lang.String query)

Adds another filtering query to the list of queries that will be executed to load the subgraph. The query has to be starting at the first MATCH pattern (e.g. MATCH (u)-[e]->(v) WHERE ...).

Parameters:

query - the PGQL query to use for filtering

Returns:

this loader

schema

public PgViewSubgraphReader schema(java.lang.String schema)

sets the schema from which to load the PG view

Parameters:

schema - the schema

Returns:

this loader

username

public PgViewSubgraphReader username(java.lang.String userName)

sets the username of the DB user to use to connect to the DB

Parameters:

userName - the username

Returns:

this loader

withConfig

public PgViewSubgraphReader withConfig(PartitionedGraphConfig config)

sets the graph configuration to use for loading the subgraph. It has to correspond to a graph configuration for a graph that comes from a PG view.

Parameters:

config - the configuration of the graph to load

Returns:

this loader