Package oracle.pgx.api.subgraph

Class PreparedPgSqlPgqlQuery

java.lang.Object

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

oracle.pgx.api.subgraph.PgqlBasedSubgraphReader<R,P>

oracle.pgx.api.subgraph.PreparedPgSqlPgqlQuery

All Implemented Interfaces:

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

public class PreparedPgSqlPgqlQuery
extends PgqlBasedSubgraphReader<R,P>
implements PreparedPgqlQueryBuilder<PreparedPgSqlPgqlQuery>

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	Description
PgSqlSubgraphReader	connections(int numConnections)	sets the number of connections to open to load the data in parallel
PgSqlSubgraphReader	dataSourceId(String dataSourceId)	sets the dataSourceId to which to connect
PgSqlSubgraphReader	escapeKeysWithPgxSpecialCharacters(boolean value)	If this setting is applied, keys with special characters will be ignored while loading subgraph
PgSqlSubgraphReader	jdbcUrl(String jdbcUrl)	sets the jdbcUrl to use for connecting to the DB
PgSqlSubgraphReader	keystoreAlias(String keystoreAlias)	sets the keystore alias to retrieve the password from the keystore
PgxGraph	load(String graphName)	Blocking version of AbstractSubgraphReader.loadAsync(String).
PgxFuture<PgxGraph>	loadAsync()	Load the subgraph.
PgxFuture<PgxGraph>	loadAsync(String graphName)	Load the subgraph.
PgSqlSubgraphReader	password(String password)	sets the password to use for connecting to the database
PreparedPgSqlPgqlQuery	preparedPgqlQuery(String query)	Adds a prepared query to list of queries that will be executed to load the subgraph.
PgSqlSubgraphReader	queryPgql(String query)	Adds another filtering query to the list of queries that will be executed to load the subgraph.
PgSqlSubgraphReader	username(String userName)	sets the username of the DB user to use to connect to the DB
PreparedPgSqlPgqlQuery	withArg(int position, QueryArgumentType type, Object value)
PgSqlSubgraphReader	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 Details

withArg

public PreparedPgSqlPgqlQuery withArg(int position,
 QueryArgumentType type,
 Object value)

Specified by:

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

load

public PgxGraph load(String graphName)
              throws ExecutionException,
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<R extends PgqlBasedSubgraphReader<R,P>>

Parameters:

graphName - the graph name

Returns:

The loaded subgraph.

Throws:

ExecutionException - When the operation failed.

InterruptedException - When the asynchronous operation is interrupted.

withConfig

public PgSqlSubgraphReader withConfig(PartitionedGraphConfig config)

Description copied from class: PgqlBasedSubgraphReader

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 PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

config - the configuration of the graph to load

Returns:

this loader

dataSourceId

public PgSqlSubgraphReader dataSourceId(String dataSourceId)

Description copied from class: PgqlBasedSubgraphReader

sets the dataSourceId to which to connect

Overrides:

dataSourceId in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

dataSourceId - the datasourceId

Returns:

this loader

jdbcUrl

public PgSqlSubgraphReader jdbcUrl(String jdbcUrl)

Description copied from class: PgqlBasedSubgraphReader

sets the jdbcUrl to use for connecting to the DB

Overrides:

jdbcUrl in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

jdbcUrl - the jdbc url

Returns:

this loader

username

public PgSqlSubgraphReader username(String userName)

Description copied from class: PgqlBasedSubgraphReader

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

Overrides:

username in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

userName - the username

Returns:

this loader

keystoreAlias

public PgSqlSubgraphReader keystoreAlias(String keystoreAlias)

Description copied from class: PgqlBasedSubgraphReader

sets the keystore alias to retrieve the password from the keystore

Overrides:

keystoreAlias in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

keystoreAlias - the keystore alias

Returns:

this loader

password

public PgSqlSubgraphReader password(String password)

Description copied from class: PgqlBasedSubgraphReader

sets the password to use for connecting to the database

Overrides:

password in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

password - the password

Returns:

this loader

connections

public PgSqlSubgraphReader connections(int numConnections)

Description copied from class: PgqlBasedSubgraphReader

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

Overrides:

connections in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

numConnections - the number of connections

Returns:

this loader

escapeKeysWithPgxSpecialCharacters

public PgSqlSubgraphReader escapeKeysWithPgxSpecialCharacters(boolean value)

Description copied from class: PgqlBasedSubgraphReader

If this setting is applied, keys with special characters will be ignored while loading subgraph

Overrides:

escapeKeysWithPgxSpecialCharacters in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Returns:

this loader

queryPgql

public PgSqlSubgraphReader queryPgql(String query)

Description copied from class: PgqlBasedSubgraphReader

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 PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

query - the PGQL query to use for filtering

Returns:

this loader

loadAsync

public PgxFuture<PgxGraph> loadAsync(String graphName)

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Overrides:

loadAsync in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

graphName - the name of the graph

Returns:

The subgraph.

loadAsync

public PgxFuture<PgxGraph> loadAsync()

Description copied from class: AbstractSubgraphReader

Load the subgraph.

Overrides:

loadAsync in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Returns:

The subgraph.

preparedPgqlQuery

public PreparedPgSqlPgqlQuery preparedPgqlQuery(String query)

Description copied from class: PgqlBasedSubgraphReader

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.

Specified by:

preparedPgqlQuery in class PgqlBasedSubgraphReader<R extends PgqlBasedSubgraphReader<R,P>,P extends PgqlBasedSubgraphReader<R,P> & PreparedPgqlQueryBuilder<P>>

Parameters:

query - The PGQL query.

Returns:

A builder used for providing arguments of the prepared query.