Package oracle.pgx.config

Enum Class GraphLoadingConfig.Field

java.lang.Object
java.lang.Enum<GraphLoadingConfig.Field>
oracle.pgx.config.GraphLoadingConfig.Field
All Implemented Interfaces:
Serializable, Comparable<GraphLoadingConfig.Field>, Constable, ConfigField
Enclosing class:
GraphLoadingConfig
public static enum GraphLoadingConfig.Field extends Enum<GraphLoadingConfig.Field> implements ConfigField
Fields of PGX Engine Graph Loading Config

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTO_REFRESH
    if true the graph gets refreshed automatically in periodic intervals.
    CREATE_EDGE_ID_INDEX
    if true, an index is prepared during loading which enables retrieval of edge paths
    CREATE_EDGE_ID_MAPPING
    if true, a mapping is prepared during loading which enables edge key arguments and filters containing edge keys
    CREATE_LABEL_HISTOGRAM
    whether a label histogram needs to be generated when the graph is loaded
    CREATE_VERTEX_ID_INDEX
    if true, an index is prepared during loading which enables retrieval of vertex paths
    CREATE_VERTEX_ID_MAPPING
    if true, a mapping is prepared during loading which enables vertex arguments and vertex filters
    FETCH_INTERVAL_SEC
    (only relevant if the format supports delta updates) the interval in which the graph source is queried for changes
    LOAD_EDGE_LABEL
    whether or not to load the edge label if it is available
    LOAD_VERTEX_LABELS
    whether or not to load the vertex label if it is available
    LOADING_PROGRESS_REPORTING_FREQUENCY
    indicates at what frequency the loading of vertices and edges should be logged.
    PARTITION_DISCARD_DEFAULT_VALUES
    [relevant for partition_while_loading]when partition_while_loading is specified, if set to by_label, the properties that contain only default values are removed from vertex and edge providers.
    PROPERTY_VALUE_DELIMITER
    if null read the whole string value as label.
    SKIP_EDGES
    whether or not to load the edges
    SKIP_VERTICES
    whether or not to load the vertices
    SNAPSHOTS_SOURCE
    source of graph snapshots: if REFRESH, new snapshots can be created only by reading the graph again via this config (e.g., with `readGraphWithProperties`), or equivalently via auto-refresh if enabled; if CHANGE_SET, new snapshots can be added only via changesets by any session.
    STRICT_MODE
    if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors.
    UPDATE_INTERVAL_SEC
    the interval in which a new snapshot is created, either by reloading the entire graph or if the format supports delta-updates, out of the cached changes.
    UPDATE_PROPERTIES_IN_PLACE
    if true, non-structural updates get applied to the graph in-place, else non-structural updates also cause new snapshots of the graph to be created.
    UPDATE_THRESHOLD
    (only relevant if the format supports delta updates) the maximum number of changes that are cached before a new snapshot is created.
    USE_VERTEX_PROPERTY_VALUE_AS_LABEL
    load the given property as vertex label.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getDefaultVal()
    Gets the default value of this field.
    List<String>
    getKeyAliases()
    Gets the key aliases of this field which are also recognized during parsing.
    List<String>
    getSingletonListKeyAliases()
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    Class<?>
    getType()
    Gets the type of this field.
    boolean
    isArray()
    Checks if this field is an array.
    boolean
    isHidden()
    Checks if this field should be hidden.
    boolean
    isPath()
    Checks if this field is a path.
    boolean
    isRequired()
    Checks if this field is required.
    boolean
    isSensitive()
    Checks if this field holds a sensitive data.
    String
    toKey()
    Get the key of this field, which is how this field is represented in serialized form.
    String
    toString()
     
    static GraphLoadingConfig.Field
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GraphLoadingConfig.Field[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface oracle.pgx.config.ConfigField

    isEnum, isPrimitive

  • Enum Constant Details

    • CREATE_VERTEX_ID_INDEX

      public static final GraphLoadingConfig.Field CREATE_VERTEX_ID_INDEX
      if true, an index is prepared during loading which enables retrieval of vertex paths

    • CREATE_VERTEX_ID_MAPPING

      public static final GraphLoadingConfig.Field CREATE_VERTEX_ID_MAPPING
      if true, a mapping is prepared during loading which enables vertex arguments and vertex filters

    • CREATE_EDGE_ID_INDEX

      public static final GraphLoadingConfig.Field CREATE_EDGE_ID_INDEX
      if true, an index is prepared during loading which enables retrieval of edge paths

    • CREATE_EDGE_ID_MAPPING

      public static final GraphLoadingConfig.Field CREATE_EDGE_ID_MAPPING
      if true, a mapping is prepared during loading which enables edge key arguments and filters containing edge keys

    • AUTO_REFRESH

      public static final GraphLoadingConfig.Field AUTO_REFRESH
      if true the graph gets refreshed automatically in periodic intervals. Note: Depending on the global settings, only fixed (pre-loaded) graphs can be auto-refreshed

    • SNAPSHOTS_SOURCE

      public static final GraphLoadingConfig.Field SNAPSHOTS_SOURCE
      source of graph snapshots: if REFRESH, new snapshots can be created only by reading the graph again via this config (e.g., with `readGraphWithProperties`), or equivalently via auto-refresh if enabled; if CHANGE_SET, new snapshots can be added only via changesets by any session. Note: CHANGE_SET is not compatible with auto-refresh

    • FETCH_INTERVAL_SEC

      public static final GraphLoadingConfig.Field FETCH_INTERVAL_SEC
      (only relevant if the format supports delta updates) the interval in which the graph source is queried for changes

    • UPDATE_INTERVAL_SEC

      public static final GraphLoadingConfig.Field UPDATE_INTERVAL_SEC
      the interval in which a new snapshot is created, either by reloading the entire graph or if the format supports delta-updates, out of the cached changes. (only relevant if the format supports delta updates) Set to -1 if you want to disable periodic snapshot creation. Note: one of update_interval_sec and update_threshold must be set

    • UPDATE_THRESHOLD

      public static final GraphLoadingConfig.Field UPDATE_THRESHOLD
      (only relevant if the format supports delta updates) the maximum number of changes that are cached before a new snapshot is created. Set to -1 if you want to disable the threshold for snapshot creation. Note: one of update_interval_sec and update_threshold must be set

    • STRICT_MODE

      public static final GraphLoadingConfig.Field STRICT_MODE
      if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors. If false, loader may use less memory during loading phase, but behave unexpectedly with erratic input files

    • LOAD_VERTEX_LABELS

      public static final GraphLoadingConfig.Field LOAD_VERTEX_LABELS
      whether or not to load the vertex label if it is available

    • LOAD_EDGE_LABEL

      public static final GraphLoadingConfig.Field LOAD_EDGE_LABEL
      whether or not to load the edge label if it is available

    • USE_VERTEX_PROPERTY_VALUE_AS_LABEL

      public static final GraphLoadingConfig.Field USE_VERTEX_PROPERTY_VALUE_AS_LABEL
      load the given property as vertex label. Currently only available for loading from PG

    • PROPERTY_VALUE_DELIMITER

      public static final GraphLoadingConfig.Field PROPERTY_VALUE_DELIMITER
      if null read the whole string value as label. Otherwise, split the string using the specified delimiter and use all values as vertex labels

    • SKIP_EDGES

      public static final GraphLoadingConfig.Field SKIP_EDGES
      whether or not to load the edges

    • SKIP_VERTICES

      public static final GraphLoadingConfig.Field SKIP_VERTICES
      whether or not to load the vertices

    • CREATE_LABEL_HISTOGRAM

      public static final GraphLoadingConfig.Field CREATE_LABEL_HISTOGRAM
      whether a label histogram needs to be generated when the graph is loaded

    • UPDATE_PROPERTIES_IN_PLACE

      public static final GraphLoadingConfig.Field UPDATE_PROPERTIES_IN_PLACE
      if true, non-structural updates get applied to the graph in-place, else non-structural updates also cause new snapshots of the graph to be created.

    • PARTITION_DISCARD_DEFAULT_VALUES

      public static final GraphLoadingConfig.Field PARTITION_DISCARD_DEFAULT_VALUES
      [relevant for partition_while_loading]when partition_while_loading is specified, if set to by_label, the properties that contain only default values are removed from vertex and edge providers.

    • LOADING_PROGRESS_REPORTING_FREQUENCY

      public static final GraphLoadingConfig.Field LOADING_PROGRESS_REPORTING_FREQUENCY
      indicates at what frequency the loading of vertices and edges should be logged. The frequency will be rounded up to the next multiple of 10,000.

  • Method Details

    • values

      public static GraphLoadingConfig.Field[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GraphLoadingConfig.Field valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getKeyAliases

      public List<String> getKeyAliases()
      Description copied from interface: ConfigField
      Gets the key aliases of this field which are also recognized during parsing.
      Specified by:
      getKeyAliases in interface ConfigField
      Returns:
      the key aliases

    • getSingletonListKeyAliases

      public List<String> getSingletonListKeyAliases()
      Description copied from interface: ConfigField
      Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
      Specified by:
      getSingletonListKeyAliases in interface ConfigField
      Returns:
      the singleton list key aliases

    • getType

      public Class<?> getType()
      Description copied from interface: ConfigField
      Gets the type of this field.
      Specified by:
      getType in interface ConfigField
      Returns:
      the type

    • isRequired

      public boolean isRequired()
      Description copied from interface: ConfigField
      Checks if this field is required.
      Specified by:
      isRequired in interface ConfigField
      Returns:
      true, if required

    • isArray

      public boolean isArray()
      Description copied from interface: ConfigField
      Checks if this field is an array.
      Specified by:
      isArray in interface ConfigField
      Returns:
      true, if array

    • isPath

      public boolean isPath()
      Description copied from interface: ConfigField
      Checks if this field is a path.
      Specified by:
      isPath in interface ConfigField
      Returns:
      true, if path

    • getDefaultVal

      public Object getDefaultVal()
      Description copied from interface: ConfigField
      Gets the default value of this field.
      Specified by:
      getDefaultVal in interface ConfigField
      Returns:
      the default value

    • toKey

      public String toKey()
      Description copied from interface: ConfigField
      Get the key of this field, which is how this field is represented in serialized form.
      Specified by:
      toKey in interface ConfigField
      Returns:
      the key.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<GraphLoadingConfig.Field>

    • isSensitive

      public boolean isSensitive()
      Description copied from interface: ConfigField
      Checks if this field holds a sensitive data.
      Specified by:
      isSensitive in interface ConfigField
      Returns:
      true, if use for sensitive data

    • isHidden

      public boolean isHidden()
      Description copied from interface: ConfigField
      Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
      Specified by:
      isHidden in interface ConfigField
      Returns:
      true if field should be hidden, false otherwise