oracle.pgx.api.expansion

Class PreparedPgViewPgqlQuery

java.lang.Object

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

oracle.pgx.api.expansion.PgqlViewGraphExpander

oracle.pgx.api.expansion.PreparedPgViewPgqlQuery

All Implemented Interfaces:

oracle.pgx.api.subgraph.internal.PreparedQueryBuilder<PreparedPgViewPgqlQuery>, PreparedPgqlQueryBuilder<PreparedPgViewPgqlQuery>

public class PreparedPgViewPgqlQuery
extends PgqlViewGraphExpander
implements PreparedPgqlQueryBuilder<PreparedPgViewPgqlQuery>

A configuration builder for graph expansion using a prepared PGQL query. Use this class to provide all the required arguments for the query or to continue configuring the expand operation.

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	edgePropertiesMergingStrategy(PropertyMergeStrategy edgePropertyMergeStrategy) Set the strategy for how edge properties of duplicate elements are handled.
PgxGraph	expand() Call the expand operation and await execution.
PgxGraph	expand(java.lang.String newGraphName) Call the expand operation and await execution.
PgxFuture<PgxGraph>	expandAsync() Call the expand operation.
PgxFuture<PgxGraph>	expandAsync(java.lang.String newGraphName) Call the expand operation.
PgxGraph	expandNewSnapshot() Blocking version of AbstractGraphExpander.expandNewSnapshotAsync().
PgxFuture<PgxGraph>	expandNewSnapshotAsync() Call the expand operation.
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	owner(java.lang.String owner) sets the owner (schema) of the PG view from which to load the data
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	schema(java.lang.String schema) sets the schema from which to load the PG view
PgqlViewGraphExpander	username(java.lang.String userName) sets the username of the DB user to use to connect to the DB
PgqlViewGraphExpander	vertexPropertiesMergingStrategy(PropertyMergeStrategy vertexPropertyMergeStrategy) Set the strategy for how vertex properties of duplicate elements are handled.
PreparedPgViewPgqlQuery	withArg(int position, QueryArgumentType type, java.lang.Object value)
PgqlViewGraphExpander	withConfig(PartitionedGraphConfig config) Specify a graph config used to load the additional graph data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pgx.api.subgraph.PreparedPgqlQueryBuilder

withBooleanArg, withDateArg, withDoubleArg, withFloatArg, withIntegerArg, withLongArg, withStringArg, withTimeArg, withTimestampArg, withTimestampWithTimezoneArg, withTimeWithTimezoneArg

Method Detail

withArg

public PreparedPgViewPgqlQuery withArg(int position,
                                       QueryArgumentType type,
                                       java.lang.Object value)

Specified by:

withArg in interface oracle.pgx.api.subgraph.internal.PreparedQueryBuilder<PreparedPgViewPgqlQuery>

connections

public PgqlViewGraphExpander connections(int numConnections)

Description copied from class: PgqlViewGraphExpander

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

Overrides:

connections in class PgqlViewGraphExpander

Parameters:

numConnections - the number of connections

Returns:

this loader

dataSourceId

public PgqlViewGraphExpander dataSourceId(java.lang.String dataSourceId)

Description copied from class: PgqlViewGraphExpander

sets the dataSourceId to which to connect

Overrides:

dataSourceId in class PgqlViewGraphExpander

Parameters:

dataSourceId - the datasourceId

Returns:

this loader

edgePropertiesMergingStrategy

public PgqlViewGraphExpander edgePropertiesMergingStrategy(PropertyMergeStrategy edgePropertyMergeStrategy)

Description copied from class: AbstractGraphExpander

Set the strategy for how edge properties of duplicate elements are handled. The default strategy is defined by PropertyMergeStrategy.getDefault().

Overrides:

edgePropertiesMergingStrategy in class AbstractGraphExpander<PgqlViewGraphExpander>

Parameters:

edgePropertyMergeStrategy - The edge property merge strategy.

Returns:

This expander.

expand

public PgxGraph expand()
                throws java.util.concurrent.ExecutionException,
                       java.lang.InterruptedException

Description copied from class: AbstractGraphExpander

Call the expand operation and await execution.

Overrides:

expand in class AbstractGraphExpander<PgqlViewGraphExpander>

Returns:

The new graph.

Throws:

java.util.concurrent.ExecutionException - when the execution fails.

java.lang.InterruptedException - when the operation gets interrupted.

expand

public PgxGraph expand(java.lang.String newGraphName)
                throws java.util.concurrent.ExecutionException,
                       java.lang.InterruptedException

Description copied from class: AbstractGraphExpander

Call the expand operation and await execution.

Overrides:

expand in class AbstractGraphExpander<PgqlViewGraphExpander>

Parameters:

newGraphName - The new graph name.

Returns:

The new graph.

Throws:

java.util.concurrent.ExecutionException - when the execution fails.

java.lang.InterruptedException - when the operation gets interrupted.

expandAsync

public PgxFuture<PgxGraph> expandAsync()

Description copied from class: AbstractGraphExpander

Call the expand operation.

Overrides:

expandAsync in class AbstractGraphExpander<PgqlViewGraphExpander>

Returns:

The new graph.

expandAsync

public PgxFuture<PgxGraph> expandAsync(java.lang.String newGraphName)

Description copied from class: AbstractGraphExpander

Call the expand operation.

Overrides:

expandAsync in class AbstractGraphExpander<PgqlViewGraphExpander>

Returns:

The new graph.

expandNewSnapshot

public PgxGraph expandNewSnapshot()
                           throws java.util.concurrent.ExecutionException,
                                  java.lang.InterruptedException

Description copied from class: AbstractGraphExpander

Blocking version of AbstractGraphExpander.expandNewSnapshotAsync(). Calls the expand operation and awaits execution. This creates a new snapshot, instead of a new graph.

Overrides:

expandNewSnapshot in class AbstractGraphExpander<PgqlViewGraphExpander>

Returns:

The new graph.

Throws:

java.util.concurrent.ExecutionException - when the execution fails.

java.lang.InterruptedException - when the operation gets interrupted.

expandNewSnapshotAsync

public PgxFuture<PgxGraph> expandNewSnapshotAsync()

Description copied from class: AbstractGraphExpander

Call the expand operation. This creates a new snapshot of the base graph, instead of a new graph.

Overrides:

expandNewSnapshotAsync in class AbstractGraphExpander<PgqlViewGraphExpander>

Returns:

The new graph.

fromPgSql

public PgqlViewGraphExpander fromPgSql(java.lang.String sqlGraphName)

Description copied from class: PgqlViewGraphExpander

Expand from a (different) SQL Property Graph.

Overrides:

fromPgSql in class PgqlViewGraphExpander

Parameters:

sqlGraphName - The SQL Graph name.

Returns:

This expander.

fromPgSql

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

Description copied from class: PgqlViewGraphExpander

Expand from a (different) SQL Property Graph.

Overrides:

fromPgSql in class PgqlViewGraphExpander

Parameters:

schemaName - The SQL Schema name.

sqlGraphName - The SQL Graph name.

Returns:

This expander.

fromPgView

public PgqlViewGraphExpander fromPgView(java.lang.String pgViewName)

Description copied from class: PgqlViewGraphExpander

Expand from a (different) PG View.

Overrides:

fromPgView in class PgqlViewGraphExpander

Parameters:

pgViewName - The name of the view.

Returns:

This expander.

fromPgView

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

Description copied from class: PgqlViewGraphExpander

Expand from a (different) PG View.

Overrides:

fromPgView in class PgqlViewGraphExpander

Parameters:

schemaName - The name of the schema.

pgViewName - The name of the view.

Returns:

This expander.

jdbcUrl

public PgqlViewGraphExpander jdbcUrl(java.lang.String jdbcUrl)

Description copied from class: PgqlViewGraphExpander

sets the jdbcUrl to use for connecting to the DB

Overrides:

jdbcUrl in class PgqlViewGraphExpander

Parameters:

jdbcUrl - the jdbc url

Returns:

this loader

keystoreAlias

public PgqlViewGraphExpander keystoreAlias(java.lang.String keystoreAlias)

Description copied from class: PgqlViewGraphExpander

sets the keystore alias to retrieve the password from the keystore

Overrides:

keystoreAlias in class PgqlViewGraphExpander

Parameters:

keystoreAlias - the keystore alias

Returns:

this loader

owner

public PgqlViewGraphExpander owner(java.lang.String owner)

Description copied from class: PgqlViewGraphExpander

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

Overrides:

owner in class PgqlViewGraphExpander

Parameters:

owner - the owner

Returns:

this loader

password

public PgqlViewGraphExpander password(java.lang.String password)

Description copied from class: PgqlViewGraphExpander

sets the password to use for connecting to the database

Overrides:

password in class PgqlViewGraphExpander

Parameters:

password - the password

Returns:

this loader

preparedPgqlQuery

public PreparedPgViewPgqlQuery preparedPgqlQuery(java.lang.String query)

Description copied from class: PgqlViewGraphExpander

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.

Overrides:

preparedPgqlQuery in class PgqlViewGraphExpander

Parameters:

query - The query.

Returns:

A builder where query arguments must be provided.

queryPgql

public PgqlViewGraphExpander queryPgql(java.lang.String query)

Description copied from class: PgqlViewGraphExpander

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

Overrides:

queryPgql in class PgqlViewGraphExpander

Parameters:

query - The query.

Returns:

This expander.

schema

public PgqlViewGraphExpander schema(java.lang.String schema)

Description copied from class: PgqlViewGraphExpander

sets the schema from which to load the PG view

Overrides:

schema in class PgqlViewGraphExpander

Parameters:

schema - the schema

Returns:

this loader

username

public PgqlViewGraphExpander username(java.lang.String userName)

Description copied from class: PgqlViewGraphExpander

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

Overrides:

username in class PgqlViewGraphExpander

Parameters:

userName - the username

Returns:

this loader

vertexPropertiesMergingStrategy

public PgqlViewGraphExpander vertexPropertiesMergingStrategy(PropertyMergeStrategy vertexPropertyMergeStrategy)

Description copied from class: AbstractGraphExpander

Set the strategy for how vertex properties of duplicate elements are handled. The default strategy is defined by PropertyMergeStrategy.getDefault().

Overrides:

vertexPropertiesMergingStrategy in class AbstractGraphExpander<PgqlViewGraphExpander>

Parameters:

vertexPropertyMergeStrategy - The vertex property merge strategy.

Returns:

This expander.

withConfig

public PgqlViewGraphExpander withConfig(PartitionedGraphConfig config)

Description copied from class: AbstractGraphExpander

Specify a graph config used to load the additional graph data. This config will always be used instead of the config of the base graph.

Overrides:

withConfig in class AbstractGraphExpander<PgqlViewGraphExpander>

Parameters:

config - The graph config.

Returns:

This expander.