Class PartitionedGraphConfig

java.lang.Object
oracle.pgx.config.AbstractConfig
oracle.pgx.config.GraphConfig
oracle.pgx.config.AbstractPartitionedGraphConfig
oracle.pgx.config.PartitionedGraphConfig
All Implemented Interfaces:
CommonLoadableConfig<Format>, DbConnectionConfig, oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder
@Generated("config_generator.py") public class PartitionedGraphConfig extends AbstractPartitionedGraphConfig
PGX Engine Partitioned Graph Config

  • Method Details

    • parse

      public static PartitionedGraphConfig parse(InputStream is, boolean strict, String parentPath) throws IOException
      Parses an input stream.
      Parameters:
      is - the input stream
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • parse

      public static PartitionedGraphConfig parse(Map<String,Object> raw, boolean strict, String parentPath)
      Parses a raw key/value mapping.
      Parameters:
      raw - the raw key/value mapping to parse
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config

    • parse

      public static PartitionedGraphConfig parse(Properties props, boolean strict)
      Parses a properties file.
      Parameters:
      props - the properties to parse
      strict - if true, parses in strict mode
      Returns:
      the parsed graph config

    • getConfigFields

      public static PartitionedGraphConfig.Field[] getConfigFields()

    • getValues

      public Map<PartitionedGraphConfig.Field, Object> getValues()
      Gets the parsed values.
      Specified by:
      getValues in class AbstractConfig
      Returns:
      the parsed values

    • isEmpty

      public boolean isEmpty()
      Checks if it's empty.
      Returns:
      true, if the Map 'values' is empty.

    • hasDefaultValue

      public boolean hasDefaultValue(PartitionedGraphConfig.Field field)
      Checks for default value.
      Specified by:
      hasDefaultValue in class AbstractPartitionedGraphConfig
      Parameters:
      field - the field
      Returns:
      true, if value for given field is the default value

    • getValuesWithoutDefaults

      public Map<PartitionedGraphConfig.Field, Object> getValuesWithoutDefaults()
      Gets the values without defaults.
      Returns:
      the values without defaults

    • getLeftoverValues

      public Map<String,Object> getLeftoverValues()
      Gets the values that do not belong to any field.
      Returns:
      the values that do not belong to any field

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean hideSensitiveData)

    • getName

      public String getName()
      name of the graph
      Returns:
      the graph name

    • getQueries

      public List<String> getQueries()
      A list of queries used to determine which data to load from the database. Data matching at least one of the queries will be loaded. Not setting any query will load the entire graph.
      Specified by:
      getQueries in class AbstractPartitionedGraphConfig
      Returns:
      the list of queries

    • getPreparedQueries

      public List<PreparedQueryConfig> getPreparedQueries()
      An additional list of prepared queries with arguments, working in the same way as 'queries'. Data matching at least one those queries will also be loaded.

    • getOptimizedFor

      public GraphOptimizedFor getOptimizedFor()
      Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
      Specified by:
      getOptimizedFor in class GraphConfig
      Returns:
      by_label if the graph should be partitioned during loading, false Indicates if the graph should use data-structures optimized for fast updates

    • getVertexIdStrategy

      public IdStrategy getVertexIdStrategy()
      Indicates what ID strategy should be used for the vertices of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value

    • getEdgeIdStrategy

      public IdStrategy getEdgeIdStrategy()
      Indicates what ID strategy should be used for the edges of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value

    • getVertexIdType

      public IdType getVertexIdType()
      type of the vertex ID. For partitioned graphs, setting it to a specific type requires the IDs in the vertex providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different vertex providers and PGX will automatically generate globally-unique 'partitioned' IDs for the vertices
      Specified by:
      getVertexIdType in class GraphConfig
      Returns:
      the vertex ID type

    • getEdgeIdType

      public IdType getEdgeIdType()
      type of the edge ID. For partitioned graphs, setting it to long requires the IDs in the edge providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different edge providers and PGX will automatically generate globally-unique 'partitioned' IDs for the edges
      Overrides:
      getEdgeIdType in class GraphConfig
      Returns:
      the edge ID type

    • getArrayCompactionThreshold

      public Double getArrayCompactionThreshold()
      [only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array. If lower than the engine min_array_compaction_threshold value, min_array_compaction_threshold will be used instead
      Specified by:
      getArrayCompactionThreshold in class GraphConfig
      Returns:
      the compaction threshold

    • getVertexProviders

      public List<EntityProviderConfig> getVertexProviders()
      list of vertex providers in this graph
      Specified by:
      getVertexProviders in class AbstractPartitionedGraphConfig
      Returns:
      the list of URIs

    • getEdgeProviders

      public List<EntityProviderConfig> getEdgeProviders()
      list of edge providers in this graph
      Specified by:
      getEdgeProviders in class AbstractPartitionedGraphConfig
      Returns:
      the list of URIs

    • getLoadingOptions

      public GraphLoadingConfig getLoadingOptions()
      loading-specific configuration
      Specified by:
      getLoadingOptions in class GraphConfig
      Returns:
      the loading configuration

    • getRedactionRules

      public List<oracle.pgx.config.PgxRedactionRuleConfig> getRedactionRules()
      array of redaction rules
      Specified by:
      getRedactionRules in class AbstractPartitionedGraphConfig
      Returns:
      the list of PgxRedactionRuleConfig

    • getRulesMapping

      public List<oracle.pgx.config.PgxRedactionRuleMappingConfig> getRulesMapping()
      mapping for redaction rules to users/roles
      Specified by:
      getRulesMapping in class AbstractPartitionedGraphConfig
      Returns:
      the list of PgxRedactionRuleMappingConfig

    • getSourceName

      public String getSourceName()
      name of the database graph, if the graph is loaded from a database

    • getSourceType

      public SourceType getSourceType()
      source type for database graphs

    • isEscapeKeysWithPgxSpecialCharacters

      public Boolean isEscapeKeysWithPgxSpecialCharacters()
      if true, sub-graph loading logic will escape keys that come from DB that contain the following special characters (),"

    • getNumConnections

      public Integer getNumConnections()
      number of connections to read/write data from/to the RDBMS table
      Specified by:
      getNumConnections in class AbstractPartitionedGraphConfig
      Returns:
      the number of connections

    • getSchema

      public String getSchema()
      schema to use when reading/writing RDBMS objects
      Returns:
      the schema

    • getJdbcUrl

      public String getJdbcUrl()
      jdbc URL pointing to an RDBMS instance
      Returns:
      the JDBC URL

    • getUsername

      public String getUsername()
      username to use when connecting to an RDBMS instance
      Returns:
      the username

    • getDataSourceId

      public String getDataSourceId()
      data source id to use to connect to an RDBMS instance
      Returns:
      the data source id

    • getMaxPrefetchedRows

      public Integer getMaxPrefetchedRows()
      maximum number of rows prefetched during each round trip resultset-database
      Returns:
      the maximum number of prefetched rows

    • getErrorHandling

      public GraphErrorHandlingConfig getErrorHandling()
      error handling configuration
      Returns:
      the error handling configuration

    • getLocalDateFormat

      public List<String> getLocalDateFormat()
      array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
      Returns:
      the date format

    • getTimeFormat

      public List<String> getTimeFormat()
      the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
      Returns:
      the time format

    • getTimestampFormat

      public List<String> getTimestampFormat()
      the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
      Returns:
      the timestamp format

    • getTimeWithTimezoneFormat

      public List<String> getTimeWithTimezoneFormat()
      the time with timezone format to use when loading and storing time with timezone properties. Please see DateTimeFormatter for a documentation of the format string
      Returns:
      the time with timezone format

    • getTimestampWithTimezoneFormat

      public List<String> getTimestampWithTimezoneFormat()
      the timestamp with timezone format to use when loading and storing timestamp with timezone properties. Please see DateTimeFormatter for a documentation of the format string
      Returns:
      the timestamp with timezone format

    • getVectorComponentDelimiter

      public Character getVectorComponentDelimiter()
      delimiter for the different components of vector properties

    • getPoint2d

      public String getPoint2d()
      longitude and latitude as floating point values separated by a space

    • getAttributes

      public Map getAttributes()
      additional attributes needed to read/write the graph data
      Returns:
      the map of attributes

    • getKeystoreAlias

      public String getKeystoreAlias()
      alias to the keystore to use when connecting to database
      Returns:
      the keystore alias or null if underlying format does not require a keystore

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class AbstractPartitionedGraphConfig