oracle.pgx.api.subgraph

Class PreparedPgViewPgqlQuery

java.lang.Object

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

oracle.pgx.api.subgraph.PgViewSubgraphReader

oracle.pgx.api.subgraph.PreparedPgViewPgqlQuery

All Implemented Interfaces:

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

public class PreparedPgViewPgqlQuery
extends PgViewSubgraphReader
implements PreparedPgqlQueryBuilder<PreparedPgViewPgqlQuery>

A configuration builder for initial subgraph reading using a prepared PGQL query. Use this class to provide all the required arguments for the query or to continue configuring the read operation.

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
PgxGraph	load(java.lang.String graphName) Blocking version of AbstractSubgraphReader.loadAsync(String).
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
PreparedPgViewPgqlQuery	withArg(int position, QueryArgumentType type, java.lang.Object value)
PgViewSubgraphReader	withConfig(PartitionedGraphConfig config) sets the graph configuration to use for loading the subgraph.

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

load

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 PgViewSubgraphReader connections(int numConnections)

Description copied from class: PgViewSubgraphReader

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

Overrides:

connections in class PgViewSubgraphReader

Parameters:

numConnections - the number of connections

Returns:

this loader

dataSourceId

public PgViewSubgraphReader dataSourceId(java.lang.String dataSourceId)

Description copied from class: PgViewSubgraphReader

sets the dataSourceId to which to connect

Overrides:

dataSourceId in class PgViewSubgraphReader

Parameters:

dataSourceId - the datasourceId

Returns:

this loader

jdbcUrl

public PgViewSubgraphReader jdbcUrl(java.lang.String jdbcUrl)

Description copied from class: PgViewSubgraphReader

sets the jdbcUrl to use for connecting to the DB

Overrides:

jdbcUrl in class PgViewSubgraphReader

Parameters:

jdbcUrl - the jdbc url

Returns:

this loader

keystoreAlias

public PgViewSubgraphReader keystoreAlias(java.lang.String keystoreAlias)

Description copied from class: PgViewSubgraphReader

sets the keystore alias to retrieve the password from the keystore

Overrides:

keystoreAlias in class PgViewSubgraphReader

Parameters:

keystoreAlias - the keystore alias

Returns:

this loader

load

public PgxGraph load(java.lang.String graphName)
              throws java.util.concurrent.ExecutionException,
                     java.lang.InterruptedException

Description copied from class: AbstractSubgraphReader

Blocking version of AbstractSubgraphReader.loadAsync(String). Starts the reading operation and awaits its completion.

Overrides:

load in class AbstractSubgraphReader<PgViewSubgraphReader>

Parameters:

graphName - the graph name

Returns:

The loaded subgraph.

Throws:

java.util.concurrent.ExecutionException - When the operation failed.

java.lang.InterruptedException - When the asynchronous operation is interrupted.

loadAsync

public PgxFuture<PgxGraph> loadAsync()

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Overrides:

loadAsync in class PgViewSubgraphReader

Returns:

The subgraph.

loadAsync

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

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Overrides:

loadAsync in class PgViewSubgraphReader

Parameters:

graphName - the name of the graph

Returns:

The subgraph.

owner

public PgViewSubgraphReader owner(java.lang.String owner)

Description copied from class: PgViewSubgraphReader

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

Overrides:

owner in class PgViewSubgraphReader

Parameters:

owner - the owner

Returns:

this loader

password

public PgViewSubgraphReader password(java.lang.String password)

Description copied from class: PgViewSubgraphReader

sets the password to use for connecting to the database

Overrides:

password in class PgViewSubgraphReader

Parameters:

password - the password

Returns:

this loader

preparedPgqlQuery

public PreparedPgViewPgqlQuery preparedPgqlQuery(java.lang.String query)

Description copied from class: PgViewSubgraphReader

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.

Overrides:

preparedPgqlQuery in class PgViewSubgraphReader

Parameters:

query - The PGQL query.

Returns:

A builder used for providing arguments of the prepared query.

queryPgql

public PgViewSubgraphReader queryPgql(java.lang.String query)

Description copied from class: PgViewSubgraphReader

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 ...).

Overrides:

queryPgql in class PgViewSubgraphReader

Parameters:

query - the PGQL query to use for filtering

Returns:

this loader

schema

public PgViewSubgraphReader schema(java.lang.String schema)

Description copied from class: PgViewSubgraphReader

sets the schema from which to load the PG view

Overrides:

schema in class PgViewSubgraphReader

Parameters:

schema - the schema

Returns:

this loader

username

public PgViewSubgraphReader username(java.lang.String userName)

Description copied from class: PgViewSubgraphReader

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

Overrides:

username in class PgViewSubgraphReader

Parameters:

userName - the username

Returns:

this loader

withConfig

public PgViewSubgraphReader withConfig(PartitionedGraphConfig config)

Description copied from class: PgViewSubgraphReader

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.

Overrides:

withConfig in class PgViewSubgraphReader

Parameters:

config - the configuration of the graph to load

Returns:

this loader