PgxDistConfig.Field (Oracle Graph Java API Reference Release 20.4 (F15858-05))

java.lang.Object
- java.lang.Enum<PgxDistConfig.Field>
- - oracle.pgx.config.PgxDistConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PgxDistConfig.Field>, ConfigField

Enclosing class:

PgxDistConfig
```
public static enum PgxDistConfig.Field
extends java.lang.Enum<PgxDistConfig.Field>
implements ConfigField
```
Fields of PGX.D Engine Config.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIN_REQUEST_CACHE_TIMEOUT` after how many seconds admin request results get removed from the cache.
`ALLOWED_REMOTE_LOADING_LOCATIONS` (This option may reduce security, use it only if you know what you are doing!) Allow loading graphs into the PGX engine from remote locations.
`AUTHORIZATION` mapping of users and roles to resources and permissions for authorization
`AUTHORIZATION_SESSION_CREATE_ALLOW_ALL` if `true` allow all users to create a PGX session regardless of permissions granted to them
`BACKEND_WRAPPER` Only for internal use.
`BUILTINS_PATH` Path to the builtin algorithms directory.
`COMMON_LOG_CONFIGURE` Path to a log configuration in Log4j2 (version 2) syntax.
`DATA_MEMORY_LIMITS` memory limits configuration parameters
`DEBUG_SERVER` Hostname of the debug server.
`ENABLE_CSRF_TOKEN_CHECKS` if true, the PGX webapp will verify CSRF token cookie and request parameters sent by the client exist and match.
`ENABLE_EXPERIMENTAL_HETERO_GRAPH_LOADER` if `true` it allows to load Heterogeneous graphs.
`ENABLE_MEMORY_LIMITS_CHECKS` if true, PGX will enforce the configured memory limits
`ENABLE_SECURE_HANDSHAKE` if `true` PGX will use TLS-PSK to establish RPC channels between remote backend processes in the cluster
`ENABLE_SHUTDOWN_CLEANUP_HOOK` if `true` PGX will add a JVM shutdown hook that will automatically shutdown PGX at JVM shutdown.
`EXECUTABLE_PATH` Path to the PGX.D executable.
`FAULT_TOLERANCE` Whether or not to enable fault tolerance in PGX.D, i.e.
`FILE_LOCATIONS` the file-locations that can be used in the authorization-config
`GHOST_MAX_NODE_COUNTS` The maximum number of ghost vertices for each graph.
`GHOST_MIN_NEIGHBORS` The minimum number of neighbors a vertex must have in order to be made a ghost (which is a vertex replicated on every machine).
`GROUP_MEMBERSHIP` If enabled, PGX.D will run failure detection and execute a coordinated shutdown of the cluster if any of the machines in the cluster fails.
`HANDSHAKE_PORT` a TCP port which will be used for handshaking of distributed backend processes.
`HOSTNAMES` A list of names or IP addresses of hosts which should be involved in a PGX.D cluster.
`IF_ETHERNET` IP network interface, used to initialize the network transport layer when using IP (Internet Protocol).
`IF_INFINIBAND` InfiniBand network interface, used to initialize the network transport layer when using InfiniBand.
`INIT_PGQL_ON_STARTUP` if `true` PGQL is directly initialized on start-up of PGX.
`INSTANCE_NAME` Instance name sent as label to debug server.
`INTERVAL_TO_POLL_MAX` Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed.
`JAVA_CLASS_PATH` Path to required java libraries.
`LARGE_BUF_COUNT` Number of large buffers populated in the pool.
`LARGE_BUF_SIZE_KB` Size in kB of the large buffers.
`LAUNCH_WATCHDOGS` (for debugging) if `true`, additional watch-dog threads will be launched which monitor and log engine health stats.
`LOG_CONFIGURE` Path to a log configuration in Log4j (version 1) syntax.
`LOG_STD_REDIRECT` Path to a log file into which the standard output streams (stdout, stderr) of PGX.D backend should be redirected.
`MAX_HTTP_CLIENT_REQUEST_SIZE` maximum size in bytes of any http request sent to to the PGX server over the REST API.
`NUM_WORKER_THREADS` Number of threads used for performing the main computation and for performing auxiliary functions related to remote data (e.g.
`PARTITIONING_IGNORE_GHOSTNODES` If set to `true`, the partitioning strategy will ignore the ghost nodes.
`PARTITIONING_SHUFFLE_VERTICES` If set to `true`, the vertices of the graph will be randomly shuffled among machines before partitioning.
`PARTITIONING_STRATEGY` Partitioning strategy of the vertices of the graph.
`PGX_REALM` configuration parameters for the realm
`PRELOAD_GRAPHS` List of graph configs to be registered at start-up.
`PROC_ID` Internal unique machine identifier in the cluster.
`RESOURCE_MONITOR` Frequency at which to send resource statistics to the debug server, in ms.
`RUN_EXPERIMENTAL_ALGORITHMS` [GM-13080] Only for internal use.
`SECURE_HANDSHAKE_SECRET_FILE` the file path of the secret in `pkcs12` format.
`STRICT_MODE` if `true`, exceptions are thrown and logged with `ERROR` level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors.
`TMP_DIR` Use this path as temporary directory to store compilation artifacts and other temporary data.
`USE_BULK_COMMUNICATION` If set to `true`, will use bulk communication for intermachine data transfers.
`USE_INFINIBAND` If set to `true`, InfiniBand will be used.
`ZOOKEEPER_TIMEOUT` If connecting to zookeeper service (for YARN deployment), the timeout in ms the runtime waits for connecting to zookeeper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getDefaultVal()` Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()` Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()` Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.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.
`java.lang.String`	`toKey()` Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static PgxDistConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PgxDistConfig.Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, 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 Detail
  - ADMIN_REQUEST_CACHE_TIMEOUT
```
public static final PgxDistConfig.Field ADMIN_REQUEST_CACHE_TIMEOUT
```
    after how many seconds admin request results get removed from the cache. Requests which are not done or not yet consumed are excluded from this timeout.
  - ALLOWED_REMOTE_LOADING_LOCATIONS
```
public static final PgxDistConfig.Field ALLOWED_REMOTE_LOADING_LOCATIONS
```
    (This option may reduce security, use it only if you know what you are doing!) Allow loading graphs into the PGX engine from remote locations. If empty, as by default, no remote location is allowed. Any of the following locations can be listed: "https", "ftps", "s3", "hdfs" (all without colon ":"). Alternatively, "*" can be used to enable all locations at once; no other value is allowed with "*". Note that pre-loaded graphs are loaded from any location, regardless of the value of this setting
  - AUTHORIZATION
```
public static final PgxDistConfig.Field AUTHORIZATION
```
    mapping of users and roles to resources and permissions for authorization
  - AUTHORIZATION_SESSION_CREATE_ALLOW_ALL
```
public static final PgxDistConfig.Field AUTHORIZATION_SESSION_CREATE_ALLOW_ALL
```
    if true allow all users to create a PGX session regardless of permissions granted to them
  - BACKEND_WRAPPER
```
public static final PgxDistConfig.Field BACKEND_WRAPPER
```
    Only for internal use.
  - BUILTINS_PATH
```
public static final PgxDistConfig.Field BUILTINS_PATH
```
    Path to the builtin algorithms directory.
  - COMMON_LOG_CONFIGURE
```
public static final PgxDistConfig.Field COMMON_LOG_CONFIGURE
```
    Path to a log configuration in Log4j2 (version 2) syntax. Contents in the file only affects PGX.D backend components shared with PGX.SM via JNI. Note: This parameter is set automatically by `start-server.sh`, do not change it.
  - DATA_MEMORY_LIMITS
```
public static final PgxDistConfig.Field DATA_MEMORY_LIMITS
```
    memory limits configuration parameters
  - DEBUG_SERVER
```
public static final PgxDistConfig.Field DEBUG_SERVER
```
    Hostname of the debug server.
  - ENABLE_CSRF_TOKEN_CHECKS
```
public static final PgxDistConfig.Field ENABLE_CSRF_TOKEN_CHECKS
```
    if true, the PGX webapp will verify CSRF token cookie and request parameters sent by the client exist and match. This is to prevent CSRF attacks.
  - ENABLE_EXPERIMENTAL_HETERO_GRAPH_LOADER
```
public static final PgxDistConfig.Field ENABLE_EXPERIMENTAL_HETERO_GRAPH_LOADER
```
    if true it allows to load Heterogeneous graphs. Note that this is currently experimental feature.
  - ENABLE_MEMORY_LIMITS_CHECKS
```
public static final PgxDistConfig.Field ENABLE_MEMORY_LIMITS_CHECKS
```
    if true, PGX will enforce the configured memory limits
  - ENABLE_SECURE_HANDSHAKE
```
public static final PgxDistConfig.Field ENABLE_SECURE_HANDSHAKE
```
    if true PGX will use TLS-PSK to establish RPC channels between remote backend processes in the cluster
  - ENABLE_SHUTDOWN_CLEANUP_HOOK
```
public static final PgxDistConfig.Field ENABLE_SHUTDOWN_CLEANUP_HOOK
```
    if true PGX will add a JVM shutdown hook that will automatically shutdown PGX at JVM shutdown. Notice: Having the shutdown hook deactivated and not shutting down PGX explicitly may result in pollution of your temp directory.
  - EXECUTABLE_PATH
```
public static final PgxDistConfig.Field EXECUTABLE_PATH
```
    Path to the PGX.D executable.
  - FAULT_TOLERANCE
```
public static final PgxDistConfig.Field FAULT_TOLERANCE
```
    Whether or not to enable fault tolerance in PGX.D, i.e. attempt to recover from failures.
  - FILE_LOCATIONS
```
public static final PgxDistConfig.Field FILE_LOCATIONS
```
    the file-locations that can be used in the authorization-config
  - GHOST_MAX_NODE_COUNTS
```
public static final PgxDistConfig.Field GHOST_MAX_NODE_COUNTS
```
    The maximum number of ghost vertices for each graph.
  - GHOST_MIN_NEIGHBORS
```
public static final PgxDistConfig.Field GHOST_MIN_NEIGHBORS
```
    The minimum number of neighbors a vertex must have in order to be made a ghost (which is a vertex replicated on every machine).
  - GROUP_MEMBERSHIP
```
public static final PgxDistConfig.Field GROUP_MEMBERSHIP
```
    If enabled, PGX.D will run failure detection and execute a coordinated shutdown of the cluster if any of the machines in the cluster fails.
  - HANDSHAKE_PORT
```
public static final PgxDistConfig.Field HANDSHAKE_PORT
```
    a TCP port which will be used for handshaking of distributed backend processes.
  - HOSTNAMES
```
public static final PgxDistConfig.Field HOSTNAMES
```
    A list of names or IP addresses of hosts which should be involved in a PGX.D cluster. The first host specified in the list will be the leader(master) host initially.
  - IF_ETHERNET
```
public static final PgxDistConfig.Field IF_ETHERNET
```
    IP network interface, used to initialize the network transport layer when using IP (Internet Protocol). Typically, this corresponds to Ethernet interface.
  - IF_INFINIBAND
```
public static final PgxDistConfig.Field IF_INFINIBAND
```
    InfiniBand network interface, used to initialize the network transport layer when using InfiniBand.
  - INIT_PGQL_ON_STARTUP
```
public static final PgxDistConfig.Field INIT_PGQL_ON_STARTUP
```
    if true PGQL is directly initialized on start-up of PGX. Otherwise, it is initialized during the first use of PGQL.
  - INSTANCE_NAME
```
public static final PgxDistConfig.Field INSTANCE_NAME
```
    Instance name sent as label to debug server.
  - INTERVAL_TO_POLL_MAX
```
public static final PgxDistConfig.Field INTERVAL_TO_POLL_MAX
```
    Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed.
  - JAVA_CLASS_PATH
```
public static final PgxDistConfig.Field JAVA_CLASS_PATH
```
    Path to required java libraries.
  - LARGE_BUF_COUNT
```
public static final PgxDistConfig.Field LARGE_BUF_COUNT
```
    Number of large buffers populated in the pool.
  - LARGE_BUF_SIZE_KB
```
public static final PgxDistConfig.Field LARGE_BUF_SIZE_KB
```
    Size in kB of the large buffers.
  - LAUNCH_WATCHDOGS
```
public static final PgxDistConfig.Field LAUNCH_WATCHDOGS
```
    (for debugging) if true, additional watch-dog threads will be launched which monitor and log engine health stats.
  - LOG_CONFIGURE
```
public static final PgxDistConfig.Field LOG_CONFIGURE
```
    Path to a log configuration in Log4j (version 1) syntax. Contents in the file only affects a PGX.D backend. Note: This parameter is set automatically by `start-server.sh`, do not change it.
  - LOG_STD_REDIRECT
```
public static final PgxDistConfig.Field LOG_STD_REDIRECT
```
    Path to a log file into which the standard output streams (stdout, stderr) of PGX.D backend should be redirected. No redirection happens when the path is null.
  - MAX_HTTP_CLIENT_REQUEST_SIZE
```
public static final PgxDistConfig.Field MAX_HTTP_CLIENT_REQUEST_SIZE
```
    maximum size in bytes of any http request sent to to the PGX server over the REST API. Setting it to -1 allows requests of any size.
  - NUM_WORKER_THREADS
```
public static final PgxDistConfig.Field NUM_WORKER_THREADS
```
    Number of threads used for performing the main computation and for performing auxiliary functions related to remote data (e.g. communication).
  - PARTITIONING_IGNORE_GHOSTNODES
```
public static final PgxDistConfig.Field PARTITIONING_IGNORE_GHOSTNODES
```
    If set to true, the partitioning strategy will ignore the ghost nodes.
  - PARTITIONING_SHUFFLE_VERTICES
```
public static final PgxDistConfig.Field PARTITIONING_SHUFFLE_VERTICES
```
    If set to true, the vertices of the graph will be randomly shuffled among machines before partitioning. If the data source does not contain enough randomness, this could be beneficial for query and analytics performance on graphs with many properties, labels or data providers. Shuffling can however increase the time necessary to load the graph.
  - PARTITIONING_STRATEGY
```
public static final PgxDistConfig.Field PARTITIONING_STRATEGY
```
    Partitioning strategy of the vertices of the graph. Valid values are 'out' (the vertices will be attributed to each machine so that every machine has the same total number of outgoing edges), 'in' (similar, but for incoming edges) and 'out_in' (same number of outgoing plus incoming edges).
  - PGX_REALM
```
public static final PgxDistConfig.Field PGX_REALM
```
    configuration parameters for the realm
  - PRELOAD_GRAPHS
```
public static final PgxDistConfig.Field PRELOAD_GRAPHS
```
    List of graph configs to be registered at start-up. Each item includes path to a graph config, the name of the graph and whether it should be published.
  - PROC_ID
```
public static final PgxDistConfig.Field PROC_ID
```
    Internal unique machine identifier in the cluster.
  - RESOURCE_MONITOR
```
public static final PgxDistConfig.Field RESOURCE_MONITOR
```
    Frequency at which to send resource statistics to the debug server, in ms.
  - RUN_EXPERIMENTAL_ALGORITHMS
```
public static final PgxDistConfig.Field RUN_EXPERIMENTAL_ALGORITHMS
```
    [GM-13080] Only for internal use.
  - SECURE_HANDSHAKE_SECRET_FILE
```
public static final PgxDistConfig.Field SECURE_HANDSHAKE_SECRET_FILE
```
    the file path of the secret in pkcs12 format. This is only used when enable_secure_handshaking is true.
  - STRICT_MODE
```
public static final PgxDistConfig.Field STRICT_MODE
```
    if true, exceptions are thrown and logged with ERROR level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors. If false, engine logs problems with ERROR/WARN level (depending on severity) and makes best guesses / uses sensible defaults instead of throwing exceptions.
  - TMP_DIR
```
public static final PgxDistConfig.Field TMP_DIR
```
    Use this path as temporary directory to store compilation artifacts and other temporary data. If set to <system-tmp-dir>, use standard tmp directory of underlying system (/tmp on Linux)
  - USE_BULK_COMMUNICATION
```
public static final PgxDistConfig.Field USE_BULK_COMMUNICATION
```
    If set to true, will use bulk communication for intermachine data transfers.
  - USE_INFINIBAND
```
public static final PgxDistConfig.Field USE_INFINIBAND
```
    If set to true, InfiniBand will be used. Must be set to false on systems that do not support InfiniBand.
  - ZOOKEEPER_TIMEOUT
```
public static final PgxDistConfig.Field ZOOKEEPER_TIMEOUT
```
    If connecting to zookeeper service (for YARN deployment), the timeout in ms the runtime waits for connecting to zookeeper.
- Method Detail
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - getKeyAliases
```
public java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - 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
  - 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
  - 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
  - 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
  - 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
  - toKey
```
public java.lang.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<PgxDistConfig.Field>
  - valueOf
```
public static PgxDistConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - values
```
public static PgxDistConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PgxDistConfig.Field c : PgxDistConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum PgxDistConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

ADMIN_REQUEST_CACHE_TIMEOUT

ALLOWED_REMOTE_LOADING_LOCATIONS

AUTHORIZATION

AUTHORIZATION_SESSION_CREATE_ALLOW_ALL

BACKEND_WRAPPER

BUILTINS_PATH

COMMON_LOG_CONFIGURE

DATA_MEMORY_LIMITS

DEBUG_SERVER

ENABLE_CSRF_TOKEN_CHECKS

ENABLE_EXPERIMENTAL_HETERO_GRAPH_LOADER

ENABLE_MEMORY_LIMITS_CHECKS

ENABLE_SECURE_HANDSHAKE

ENABLE_SHUTDOWN_CLEANUP_HOOK

EXECUTABLE_PATH

FAULT_TOLERANCE

FILE_LOCATIONS

GHOST_MAX_NODE_COUNTS

GHOST_MIN_NEIGHBORS

GROUP_MEMBERSHIP

HANDSHAKE_PORT

HOSTNAMES

IF_ETHERNET

IF_INFINIBAND

INIT_PGQL_ON_STARTUP

INSTANCE_NAME

INTERVAL_TO_POLL_MAX

JAVA_CLASS_PATH

LARGE_BUF_COUNT

LARGE_BUF_SIZE_KB

LAUNCH_WATCHDOGS

LOG_CONFIGURE

LOG_STD_REDIRECT

MAX_HTTP_CLIENT_REQUEST_SIZE

NUM_WORKER_THREADS

PARTITIONING_IGNORE_GHOSTNODES

PARTITIONING_SHUFFLE_VERTICES

PARTITIONING_STRATEGY

PGX_REALM

PRELOAD_GRAPHS

PROC_ID

RESOURCE_MONITOR

RUN_EXPERIMENTAL_ALGORITHMS

SECURE_HANDSHAKE_SECRET_FILE

STRICT_MODE

TMP_DIR

USE_BULK_COMMUNICATION

USE_INFINIBAND

ZOOKEEPER_TIMEOUT

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values