oracle.pgx.api.expansion

Class PgqlViewGraphExpander

java.lang.Object

oracle.pgx.api.expansion.AbstractGraphExpander<PgqlViewGraphExpander>

oracle.pgx.api.expansion.PgqlViewGraphExpander

Direct Known Subclasses:

PreparedPgViewPgqlQuery

public class PgqlViewGraphExpander
extends AbstractGraphExpander<PgqlViewGraphExpander>

Expander for PGQL-based graph expansions from either PG View or SQL Property Graphs.

Constructor Summary

Constructors

Constructor and Description
PgqlViewGraphExpander(PartitionedGraphConfig graphConfig, PgxSession session, java.util.function.Function<oracle.pgx.api.expansion.internal.GraphExpansionConfig,PgxFuture<PgxGraph>> expansionFunction, oracle.pgx.api.subgraph.internal.KeystoreLookup keystoreLookup) Create a new expander from a base graph.

Method Summary

Modifier and Type	Method and Description
PgqlViewGraphExpander	connections(int numConnections) sets the number of connections to open to load the data in parallel
PgqlViewGraphExpander	dataSourceId(java.lang.String dataSourceId) sets the dataSourceId to which to connect
PgqlViewGraphExpander	fromPgSql(java.lang.String sqlGraphName) Expand from a (different) SQL Property Graph.
PgqlViewGraphExpander	fromPgSql(java.lang.String schemaName, java.lang.String sqlGraphName) Expand from a (different) SQL Property Graph.
PgqlViewGraphExpander	fromPgView(java.lang.String pgViewName) Expand from a (different) PG View.
PgqlViewGraphExpander	fromPgView(java.lang.String schemaName, java.lang.String pgViewName) Expand from a (different) PG View.
PgqlViewGraphExpander	jdbcUrl(java.lang.String jdbcUrl) sets the jdbcUrl to use for connecting to the DB
PgqlViewGraphExpander	keystoreAlias(java.lang.String keystoreAlias) sets the keystore alias to retrieve the password from the keystore
PgqlViewGraphExpander	password(java.lang.String password) sets the password to use for connecting to the database
PreparedPgViewPgqlQuery	preparedPgqlQuery(java.lang.String query) Add a new prepared PGQL query to the expansion.
PgqlViewGraphExpander	queryPgql(java.lang.String query) Add a PGQL query to the expansion.
PgqlViewGraphExpander	username(java.lang.String userName) sets the username of the DB user to use to connect to the DB

Methods inherited from class oracle.pgx.api.expansion.AbstractGraphExpander

edgePropertiesMergingStrategy, expand, expand, expandAsync, expandAsync, expandNewSnapshot, expandNewSnapshotAsync, vertexPropertiesMergingStrategy, withConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

PgqlViewGraphExpander

public PgqlViewGraphExpander(PartitionedGraphConfig graphConfig,
                             PgxSession session,
                             java.util.function.Function<oracle.pgx.api.expansion.internal.GraphExpansionConfig,PgxFuture<PgxGraph>> expansionFunction,
                             oracle.pgx.api.subgraph.internal.KeystoreLookup keystoreLookup)

Create a new expander from a base graph. Do not use this constructor, use GenericGraphExpander.withPgql() to acquire an instance of this class instead.

Parameters:

graphConfig - Config of the graph being expanded.

session - Session calling the expand operation.

expansionFunction - A function calling the actual expand operation.

Method Detail

connections

public PgqlViewGraphExpander 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 PgqlViewGraphExpander dataSourceId(java.lang.String dataSourceId)

sets the dataSourceId to which to connect

Parameters:

dataSourceId - the datasourceId

Returns:

this loader

fromPgSql

public PgqlViewGraphExpander fromPgSql(java.lang.String sqlGraphName)

Expand from a (different) SQL Property Graph.

Parameters:

sqlGraphName - The SQL Graph name.

Returns:

This expander.

fromPgSql

public PgqlViewGraphExpander fromPgSql(java.lang.String schemaName,
                                       java.lang.String sqlGraphName)

Expand from a (different) SQL Property Graph.

Parameters:

schemaName - The SQL Schema name.

sqlGraphName - The SQL Graph name.

Returns:

This expander.

fromPgView

public PgqlViewGraphExpander fromPgView(java.lang.String pgViewName)

Expand from a (different) PG View.

Parameters:

pgViewName - The name of the view.

Returns:

This expander.

fromPgView

public PgqlViewGraphExpander fromPgView(java.lang.String schemaName,
                                        java.lang.String pgViewName)

Expand from a (different) PG View.

Parameters:

schemaName - The name of the schema.

pgViewName - The name of the view.

Returns:

This expander.

jdbcUrl

public PgqlViewGraphExpander 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 PgqlViewGraphExpander keystoreAlias(java.lang.String keystoreAlias)

sets the keystore alias to retrieve the password from the keystore

Parameters:

keystoreAlias - the keystore alias

Returns:

this loader

password

public PgqlViewGraphExpander 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)

Add a new prepared PGQL query to the expansion. Additional data matching this query will be loaded. This returns a new builder where arguments for the query must be provided.

Parameters:

query - The query.

Returns:

A builder where query arguments must be provided.

queryPgql

public PgqlViewGraphExpander queryPgql(java.lang.String query)

Add a PGQL query to the expansion. Additional data matching this query will be loaded.

Parameters:

query - The query.

Returns:

This expander.

username

public PgqlViewGraphExpander 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