Package oracle.pgx.api.expansion

Class PgqlViewGraphExpander

java.lang.Object
oracle.pgx.api.expansion.AbstractGraphExpander<PgqlViewGraphExpander>
oracle.pgx.api.expansion.PgqlViewGraphExpander
Direct Known Subclasses:
PreparedPgViewPgqlQuery
@BetaApi public class PgqlViewGraphExpander extends AbstractGraphExpander<PgqlViewGraphExpander>
Expander for PGQL-based graph expansions from either PG View or SQL Property Graphs.

  • Constructor Details

    • PgqlViewGraphExpander

      public PgqlViewGraphExpander(PartitionedGraphConfig graphConfig, PgxSession session, 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 Details

    • fromPgPgql

      public PgqlViewGraphExpander fromPgPgql(String pgGraphName)
      Expand from a (different) PG PGQL.
      Parameters:
      pgGraphName - The name of the graph.
      Returns:
      This expander.

    • fromPgPgql

      public PgqlViewGraphExpander fromPgPgql(String schemaName, String pgGraphName)
      Expand from a (different) PG PGQL.
      Parameters:
      schemaName - The name of the schema.
      pgGraphName - The name of the graph.
      Returns:
      This expander.

    • fromPgSql

      public PgqlViewGraphExpander fromPgSql(String sqlGraphName)
      Expand from a (different) SQL Property Graph.
      Parameters:
      sqlGraphName - The SQL Graph name.
      Returns:
      This expander.

    • fromPgSql

      public PgqlViewGraphExpander fromPgSql(String schemaName, String sqlGraphName)
      Expand from a (different) SQL Property Graph.
      Parameters:
      schemaName - The SQL Schema name.
      sqlGraphName - The SQL Graph name.
      Returns:
      This expander.

    • queryPgql

      public PgqlViewGraphExpander queryPgql(String query)
      Add a PGQL query to the expansion. Additional data matching this query will be loaded.
      Parameters:
      query - The query.
      Returns:
      This expander.

    • preparedPgqlQuery

      public PreparedPgViewPgqlQuery preparedPgqlQuery(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.

    • dataSourceId

      public PgqlViewGraphExpander dataSourceId(String dataSourceId)
      sets the dataSourceId to which to connect
      Parameters:
      dataSourceId - the datasourceId
      Returns:
      this loader

    • jdbcUrl

      public PgqlViewGraphExpander jdbcUrl(String jdbcUrl)
      sets the jdbcUrl to use for connecting to the DB
      Parameters:
      jdbcUrl - the jdbc url
      Returns:
      this loader

    • username

      public PgqlViewGraphExpander username(String userName)
      sets the username of the DB user to use to connect to the DB
      Parameters:
      userName - the username
      Returns:
      this loader

    • keystoreAlias

      public PgqlViewGraphExpander keystoreAlias(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(String password)
      sets the password to use for connecting to the database
      Parameters:
      password - the password
      Returns:
      this loader

    • 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