PgxConfig.Field (Oracle Graph Java API Reference for Property Graph Release 22.3 (F59609-02))

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

All Implemented Interfaces:

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

Enclosing class:

PgxConfig
```
public static enum PgxConfig.Field
extends java.lang.Enum<PgxConfig.Field>
implements ConfigField
```
Fields of PGX 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.
`ALLOW_IDLE_TIMEOUT_OVERWRITE` if `true`, sessions can overwrite default idle timeout
`ALLOW_OVERRIDE_SCHEDULING_INFORMATION` if `true` allow all users to override scheduling information like task weight, task priority and number of threads
`ALLOW_TASK_TIMEOUT_OVERWRITE` if `true`, sessions can overwrite default task timeout
`ALLOW_USER_AUTO_REFRESH` if `true` users may enable auto refresh for graphs they load.
`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.
`BASIC_SCHEDULER_CONFIG` configuration parameters for the fork join pool backend
`BFS_ITERATE_QUE_TASK_SIZE` task size for BFS iterate QUE phase
`BFS_THRESHOLD_PARENT_READ_BASED` threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
`BFS_THRESHOLD_READ_BASED` threshold of BFS traversal level items above which to switch to read-based visiting strategy
`BFS_THRESHOLD_SINGLE_THREADED` until what number of BFS traversal level items vertices are visited single-threaded
`BUILTINS_PATH` Path to the builtin algorithms directory.
`CHARACTER_SET` standard charset to use throughout PGX, UTF-8 will be used as default.
`CNI_DIFF_FACTOR_DEFAULT` default diff factor value used in the common neighbor iterator implementations.
`CNI_SMALL_DEFAULT` default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
`CNI_STOP_RECURSION_DEFAULT` default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
`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.
`DFS_THRESHOLD_LARGE` value that determines at which number of visited vertices the DFS implementation will switch to data-structures that are more optimized for larger numbers of vertices.
`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_GM_COMPILER` if `true`, enable dynamic compilation of Green-Marl code during runtime
`ENABLE_GRAPH_LOADING_CACHE` if `true`, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
`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.
`ENTERPRISE_SCHEDULER_CONFIG` configuration parameters for the enterprise scheduler
`ENTERPRISE_SCHEDULER_FLAGS` [relevant for `enterprise_scheduler`] enterprise scheduler specific settings.
`EXECUTABLE_PATH` Path to the PGX.D executable.
`EXISTING_HOSTNAMES` A list of names or IP addresses of hosts that are already part of an existing PGX.D cluster.
`EXPLICIT_SPIN_LOCKS` `true` means spin explicitly in a loop until lock becomes available.
`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).
`GRAPH_ALGORITHM_LANGUAGE` Frontend compiler to use.
`GRAPH_VALIDATION_LEVEL` level of validation performed on newly loaded or created graphs
`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 initial bootstrapping of 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.
`IGNORE_INCOMPATIBLE_BACKEND_OPERATIONS` if `true` only log when encountering incompatible operations and configuration values in RTS or FJ pool.
`IN_PLACE_UPDATE_CONSISTENCY_MODEL` Consistency model used when in-place updates occur.
`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.
`JAVA_HOME_DIR` The path to Java's home directory.
`LARGE_ARRAY_THRESHOLD` threshold when the size of an array is too big to use a normal Java array.
`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_ACTIVE_SESSIONS` the maximum number of sessions allowed to be active at a time
`MAX_DISTINCT_STRINGS_PER_POOL` [only relevant if `string_pooling_strategy` is `indexed`] amount of distinct strings per property after which to stop pooling.
`MAX_HTTP_CLIENT_REQUEST_SIZE` maximum size in bytes of any http request sent to to the PGX server over the REST API.
`MAX_OFF_HEAP_SIZE` maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
`MAX_QUEUE_SIZE_PER_SESSION` the maximum number of pending tasks allowed to be in the queue, per session.
`MAX_SNAPSHOT_COUNT` Number of snapshots that may be loaded in the engine at the same time.
`MEMORY_ALLOCATOR` which memory allocator to use
`MEMORY_CLEANUP_INTERVAL` memory cleanup tick in seconds
`MIN_ARRAY_COMPACTION_THRESHOLD` [only relevant for graphs optimized for updates] minimum value that can be used for the array_compaction_threshold value in graph configuration.
`MIN_FETCH_INTERVAL_SEC` (only relevant if the graph format supports delta updates) for delta-refresh, the lowest interval at which a graph source is queried for changes.
`MIN_UPDATE_INTERVAL_SEC` for auto-refresh, the lowest interval after 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).
`MS_BFS_FRONTIER_TYPE_STRATEGY` the type strategy to use for MS-BFS frontiers
`NUM_SPIN_LOCKS` how many spin locks each generated app will create at instantiation.
`PARALLELISM` number of worker threads to be used in thread pool.
`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.
`PATTERN_MATCHING_SUPERNODE_CACHE_THRESHOLD` minimum number of a node's neighbor to be a supernode.
`PGX_REALM` configuration parameters for the realm
`PGX_SERVER_BASE_URL` should be used when deploying pgx server behind a load balancer to make clients before 21.3 backward compatible, the value should be set to the load balancer address
`POOLING_FACTOR` [only relevant if `string_pooling_strategy` is `on_heap`] this value prevents the string pool to grow as big as the property size which could render the pooling ineffective
`PRELOAD_GRAPHS` list of graph configs to be registered at start-up.
`PROC_ID` Internal unique machine identifier in the cluster.
`RANDOM_GENERATOR_STRATEGY` method of generating random numbers in pgx
`RANDOM_SEED` [relevant for `deterministic` random number generator only] seed for the deterministic random number generator used in pgx.
`READINESS_MEMORY_USAGE_RATIO` memory limit ratio that should be considered to detect if PGX server is ready, used by isReady API, default value is 1.0
`RELEASE_MEMORY_THRESHOLD` threshold percentage of used memory after which the engine starts freeing un-used graphs.
`RESOURCE_MONITOR` Frequency at which to send resource statistics to the debug server, in ms.
`REVISIT_THRESHOLD` maximum number of matched results from a node to be cached
`RUNNING_MEMORY_USAGE_RATIO` memory limit ratio that should be considered to detect if PGX server is running, used by isRunning API default value is 1.0
`SCHEDULER` which scheduler to use.
`SECURE_HANDSHAKE_SECRET_FILE` the file path of the secret in `pkcs12` format.
`SESSION_IDLE_TIMEOUT_SECS` timeout of idling sessions in seconds.
`SESSION_TASK_TIMEOUT_SECS` timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds.
`SMALL_TASK_LENGTH` task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
`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.
`STRING_POOLING_STRATEGY` which string pooling strategy to use
`TASK_LENGTH` default task length (only relevant for task-stealing strategies).
`TMP_DIR` Use this path as temporary directory to store compilation artifacts and other temporary data.
`UDF_CONFIG_DIRECTORY` directory path containing udf config files
`UNSAFE_ALLOW_FOREIGN_SYNTAX` Deprecated.
`USE_INDEX_FOR_REACHABILITY_QUERIES` create index for reachability queries
`USE_INFINIBAND` If set to `true`, InfiniBand will be used.
`USE_MEMORY_MAPPER_FOR_READING_PGB` if `true`, use memory mapped files for reading graphs in PGB format if possible; `false` always use s stream based implementation
`USE_MEMORY_MAPPER_FOR_STORING_PGB` if `true`, use memory mapped files for storing in PGB format if possible; if `false` always use a stream based implementation

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 PgxConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PgxConfig.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 PgxConfig.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. Note: this is only relevant if PGX is deployed as a webapp.
  - ALLOW_IDLE_TIMEOUT_OVERWRITE
```
public static final PgxConfig.Field ALLOW_IDLE_TIMEOUT_OVERWRITE
```
    if true, sessions can overwrite default idle timeout
  - ALLOW_OVERRIDE_SCHEDULING_INFORMATION
```
public static final PgxConfig.Field ALLOW_OVERRIDE_SCHEDULING_INFORMATION
```
    if true allow all users to override scheduling information like task weight, task priority and number of threads
  - ALLOW_TASK_TIMEOUT_OVERWRITE
```
public static final PgxConfig.Field ALLOW_TASK_TIMEOUT_OVERWRITE
```
    if true, sessions can overwrite default task timeout
  - ALLOW_USER_AUTO_REFRESH
```
public static final PgxConfig.Field ALLOW_USER_AUTO_REFRESH
```
    if true users may enable auto refresh for graphs they load. If false only graphs mentioned in preload_graphs can have auto refresh enabled
  - ALLOWED_REMOTE_LOADING_LOCATIONS
```
public static final PgxConfig.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 PgxConfig.Field AUTHORIZATION
```
    mapping of users and roles to resources and permissions for authorization
  - AUTHORIZATION_SESSION_CREATE_ALLOW_ALL
```
public static final PgxConfig.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 PgxConfig.Field BACKEND_WRAPPER
```
    Only for internal use.
  - BASIC_SCHEDULER_CONFIG
```
public static final PgxConfig.Field BASIC_SCHEDULER_CONFIG
```
    configuration parameters for the fork join pool backend
  - BFS_ITERATE_QUE_TASK_SIZE
```
public static final PgxConfig.Field BFS_ITERATE_QUE_TASK_SIZE
```
    task size for BFS iterate QUE phase
  - BFS_THRESHOLD_PARENT_READ_BASED
```
public static final PgxConfig.Field BFS_THRESHOLD_PARENT_READ_BASED
```
    threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
  - BFS_THRESHOLD_READ_BASED
```
public static final PgxConfig.Field BFS_THRESHOLD_READ_BASED
```
    threshold of BFS traversal level items above which to switch to read-based visiting strategy
  - BFS_THRESHOLD_SINGLE_THREADED
```
public static final PgxConfig.Field BFS_THRESHOLD_SINGLE_THREADED
```
    until what number of BFS traversal level items vertices are visited single-threaded
  - BUILTINS_PATH
```
public static final PgxConfig.Field BUILTINS_PATH
```
    Path to the builtin algorithms directory.
  - CHARACTER_SET
```
public static final PgxConfig.Field CHARACTER_SET
```
    standard charset to use throughout PGX, UTF-8 will be used as default. Note: Some formats may not be compatible.
  - CNI_DIFF_FACTOR_DEFAULT
```
public static final PgxConfig.Field CNI_DIFF_FACTOR_DEFAULT
```
    default diff factor value used in the common neighbor iterator implementations.
  - CNI_SMALL_DEFAULT
```
public static final PgxConfig.Field CNI_SMALL_DEFAULT
```
    default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
  - CNI_STOP_RECURSION_DEFAULT
```
public static final PgxConfig.Field CNI_STOP_RECURSION_DEFAULT
```
    default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
  - COMMON_LOG_CONFIGURE
```
public static final PgxConfig.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 PgxConfig.Field DATA_MEMORY_LIMITS
```
    memory limits configuration parameters
  - DEBUG_SERVER
```
public static final PgxConfig.Field DEBUG_SERVER
```
    Hostname of the debug server.
  - DFS_THRESHOLD_LARGE
```
public static final PgxConfig.Field DFS_THRESHOLD_LARGE
```
    value that determines at which number of visited vertices the DFS implementation will switch to data-structures that are more optimized for larger numbers of vertices.
  - ENABLE_CSRF_TOKEN_CHECKS
```
public static final PgxConfig.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_GM_COMPILER
```
public static final PgxConfig.Field ENABLE_GM_COMPILER
```
    if true, enable dynamic compilation of Green-Marl code during runtime
  - ENABLE_GRAPH_LOADING_CACHE
```
public static final PgxConfig.Field ENABLE_GRAPH_LOADING_CACHE
```
    if true, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
  - ENABLE_MEMORY_LIMITS_CHECKS
```
public static final PgxConfig.Field ENABLE_MEMORY_LIMITS_CHECKS
```
    if true, PGX will enforce the configured memory limits
  - ENABLE_SECURE_HANDSHAKE
```
public static final PgxConfig.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 PgxConfig.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.
  - ENTERPRISE_SCHEDULER_CONFIG
```
public static final PgxConfig.Field ENTERPRISE_SCHEDULER_CONFIG
```
    configuration parameters for the enterprise scheduler
  - ENTERPRISE_SCHEDULER_FLAGS
```
public static final PgxConfig.Field ENTERPRISE_SCHEDULER_FLAGS
```
    [relevant for enterprise_scheduler] enterprise scheduler specific settings.
  - EXECUTABLE_PATH
```
public static final PgxConfig.Field EXECUTABLE_PATH
```
    Path to the PGX.D executable.
  - EXISTING_HOSTNAMES
```
public static final PgxConfig.Field EXISTING_HOSTNAMES
```
    A list of names or IP addresses of hosts that are already part of an existing PGX.D cluster. The new follower machine uses this list to join the cluster. The list should be empty when initially bootstrapping a cluster.
  - EXPLICIT_SPIN_LOCKS
```
public static final PgxConfig.Field EXPLICIT_SPIN_LOCKS
```
    true means spin explicitly in a loop until lock becomes available. false means using JDK locks which rely on the JVM to decide whether to context switch or spin. Our experiments showed that setting this value to true results in better performance.
  - FILE_LOCATIONS
```
public static final PgxConfig.Field FILE_LOCATIONS
```
    the file-locations that can be used in the authorization-config
  - GHOST_MAX_NODE_COUNTS
```
public static final PgxConfig.Field GHOST_MAX_NODE_COUNTS
```
    The maximum number of ghost vertices for each graph.
  - GHOST_MIN_NEIGHBORS
```
public static final PgxConfig.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).
  - GRAPH_ALGORITHM_LANGUAGE
```
public static final PgxConfig.Field GRAPH_ALGORITHM_LANGUAGE
```
    Frontend compiler to use.
  - GRAPH_VALIDATION_LEVEL
```
public static final PgxConfig.Field GRAPH_VALIDATION_LEVEL
```
    level of validation performed on newly loaded or created graphs
  - HANDSHAKE_PORT
```
public static final PgxConfig.Field HANDSHAKE_PORT
```
    a TCP port which will be used for handshaking of distributed backend processes.
  - HOSTNAMES
```
public static final PgxConfig.Field HOSTNAMES
```
    A list of names or IP addresses of hosts which should be involved in initial bootstrapping of a PGX.D cluster. The first host specified in the list will become the leader host. The list should be empty when joining an existing cluster.
  - IF_ETHERNET
```
public static final PgxConfig.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 PgxConfig.Field IF_INFINIBAND
```
    InfiniBand network interface, used to initialize the network transport layer when using InfiniBand.
  - IGNORE_INCOMPATIBLE_BACKEND_OPERATIONS
```
public static final PgxConfig.Field IGNORE_INCOMPATIBLE_BACKEND_OPERATIONS
```
    if true only log when encountering incompatible operations and configuration values in RTS or FJ pool. If false throw exceptions
  - IN_PLACE_UPDATE_CONSISTENCY_MODEL
```
public static final PgxConfig.Field IN_PLACE_UPDATE_CONSISTENCY_MODEL
```
    Consistency model used when in-place updates occur. Only relevant if in-place updates are enabled. Currently updates are only applied in place if the updates are not structural (Only modifies properties). Two models are currently implemented, one only delays new tasks when an update occurs, the other also running tasks.
  - INIT_PGQL_ON_STARTUP
```
public static final PgxConfig.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 PgxConfig.Field INSTANCE_NAME
```
    Instance name sent as label to debug server.
  - INTERVAL_TO_POLL_MAX
```
public static final PgxConfig.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 PgxConfig.Field JAVA_CLASS_PATH
```
    Path to required java libraries.
  - JAVA_HOME_DIR
```
public static final PgxConfig.Field JAVA_HOME_DIR
```
    The path to Java's home directory. If set to <system-java-home-dir>, use the java.home system property.
  - LARGE_ARRAY_THRESHOLD
```
public static final PgxConfig.Field LARGE_ARRAY_THRESHOLD
```
    threshold when the size of an array is too big to use a normal Java array. This depends on the used JVM. (defaults to Integer.MAX_VALUE - 3)
  - LARGE_BUF_COUNT
```
public static final PgxConfig.Field LARGE_BUF_COUNT
```
    Number of large buffers populated in the pool.
  - LARGE_BUF_SIZE_KB
```
public static final PgxConfig.Field LARGE_BUF_SIZE_KB
```
    Size in kB of the large buffers.
  - LAUNCH_WATCHDOGS
```
public static final PgxConfig.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 PgxConfig.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 PgxConfig.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_ACTIVE_SESSIONS
```
public static final PgxConfig.Field MAX_ACTIVE_SESSIONS
```
    the maximum number of sessions allowed to be active at a time
  - MAX_DISTINCT_STRINGS_PER_POOL
```
public static final PgxConfig.Field MAX_DISTINCT_STRINGS_PER_POOL
```
    [only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling. If the limit is reached an exception is thrown
  - MAX_HTTP_CLIENT_REQUEST_SIZE
```
public static final PgxConfig.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.
  - MAX_OFF_HEAP_SIZE
```
public static final PgxConfig.Field MAX_OFF_HEAP_SIZE
```
    maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown. Note: this limit is not guaranteed to never be exceeded because of rounding and synchronization trade-offs. It only serves as threshold when PGX starts to reject new memory allocation requests.
  - MAX_QUEUE_SIZE_PER_SESSION
```
public static final PgxConfig.Field MAX_QUEUE_SIZE_PER_SESSION
```
    the maximum number of pending tasks allowed to be in the queue, per session. If a session reaches the maximum, new incoming requests of that sesssion get rejected. A negative value means infinity / unlimited.
  - MAX_SNAPSHOT_COUNT
```
public static final PgxConfig.Field MAX_SNAPSHOT_COUNT
```
    Number of snapshots that may be loaded in the engine at the same time. New snapshots can be created via auto or forced update. If the number of snapshots of a graph reaches this threshold, no more auto-updates will be performed and a forced-updated will result in an exception until one or more snapshots are removed from memory. A value of zero indicates to support an unlimited amount of snapshots.
  - MEMORY_ALLOCATOR
```
public static final PgxConfig.Field MEMORY_ALLOCATOR
```
    which memory allocator to use
  - MEMORY_CLEANUP_INTERVAL
```
public static final PgxConfig.Field MEMORY_CLEANUP_INTERVAL
```
    memory cleanup tick in seconds
  - MIN_ARRAY_COMPACTION_THRESHOLD
```
public static final PgxConfig.Field MIN_ARRAY_COMPACTION_THRESHOLD
```
    [only relevant for graphs optimized for updates] minimum value that can be used for the array_compaction_threshold value in graph configuration. If a graph configuration attempts to use a value lower than the one specified by min_array_compaction_threshold, it will use min_array_compaction_threshold instead
  - MIN_FETCH_INTERVAL_SEC
```
public static final PgxConfig.Field MIN_FETCH_INTERVAL_SEC
```
    (only relevant if the graph format supports delta updates) for delta-refresh, the lowest interval at which a graph source is queried for changes. You can tune this value to prevent PGX from hanging due to too frequent graph delta-refreshing.
  - MIN_UPDATE_INTERVAL_SEC
```
public static final PgxConfig.Field MIN_UPDATE_INTERVAL_SEC
```
    for auto-refresh, the lowest interval after 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). You can tune this value to prevent PGX from hanging due to too frequent graph auto-refreshing.
  - MS_BFS_FRONTIER_TYPE_STRATEGY
```
public static final PgxConfig.Field MS_BFS_FRONTIER_TYPE_STRATEGY
```
    the type strategy to use for MS-BFS frontiers
  - NUM_SPIN_LOCKS
```
public static final PgxConfig.Field NUM_SPIN_LOCKS
```
    how many spin locks each generated app will create at instantiation. Trade-off: small number implies less memory consumption. Big number implies faster execution (if algorithm uses spin locks)
  - PARALLELISM
```
public static final PgxConfig.Field PARALLELISM
```
    number of worker threads to be used in thread pool. Note: if caller thread is part of another thread-pool, this value is ignored and parallelism of parent pool is used.
  - PARTITIONING_IGNORE_GHOSTNODES
```
public static final PgxConfig.Field PARTITIONING_IGNORE_GHOSTNODES
```
    If set to true, the partitioning strategy will ignore the ghost nodes.
  - PARTITIONING_SHUFFLE_VERTICES
```
public static final PgxConfig.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 PgxConfig.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).
  - PATTERN_MATCHING_SUPERNODE_CACHE_THRESHOLD
```
public static final PgxConfig.Field PATTERN_MATCHING_SUPERNODE_CACHE_THRESHOLD
```
    minimum number of a node's neighbor to be a supernode. This is for pattern matching engine.
  - PGX_REALM
```
public static final PgxConfig.Field PGX_REALM
```
    configuration parameters for the realm
  - PGX_SERVER_BASE_URL
```
public static final PgxConfig.Field PGX_SERVER_BASE_URL
```
    should be used when deploying pgx server behind a load balancer to make clients before 21.3 backward compatible, the value should be set to the load balancer address
  - POOLING_FACTOR
```
public static final PgxConfig.Field POOLING_FACTOR
```
    [only relevant if string_pooling_strategy is on_heap] this value prevents the string pool to grow as big as the property size which could render the pooling ineffective
  - PRELOAD_GRAPHS
```
public static final PgxConfig.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 PgxConfig.Field PROC_ID
```
    Internal unique machine identifier in the cluster.
  - RANDOM_GENERATOR_STRATEGY
```
public static final PgxConfig.Field RANDOM_GENERATOR_STRATEGY
```
    method of generating random numbers in pgx
  - RANDOM_SEED
```
public static final PgxConfig.Field RANDOM_SEED
```
    [relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx. The default is -24466691093057031
  - READINESS_MEMORY_USAGE_RATIO
```
public static final PgxConfig.Field READINESS_MEMORY_USAGE_RATIO
```
    memory limit ratio that should be considered to detect if PGX server is ready, used by isReady API, default value is 1.0
  - RELEASE_MEMORY_THRESHOLD
```
public static final PgxConfig.Field RELEASE_MEMORY_THRESHOLD
```
    threshold percentage of used memory after which the engine starts freeing un-used graphs. Examples: A value of 0.0 means graphs get freed as soon as their reference count becomes zero. That is, all sessions which loaded that graph were destroyed/timed out. A value of 1.0 means graphs get never freed. Engine will throw OutOfMemoryErrors as soon as a graph is needed which doesn't fit in memory anymore. A value of 0.7 means the engine keeps all graphs in memory as long as total memory consumption is below 70% of total available memory, even if there is currently no session using them. Once the 70% are surpassed and another graph needs to get loaded, un-used graphs get freed until memory consumption is below 70% again.
  - RESOURCE_MONITOR
```
public static final PgxConfig.Field RESOURCE_MONITOR
```
    Frequency at which to send resource statistics to the debug server, in ms.
  - REVISIT_THRESHOLD
```
public static final PgxConfig.Field REVISIT_THRESHOLD
```
    maximum number of matched results from a node to be cached
  - RUNNING_MEMORY_USAGE_RATIO
```
public static final PgxConfig.Field RUNNING_MEMORY_USAGE_RATIO
```
    memory limit ratio that should be considered to detect if PGX server is running, used by isRunning API default value is 1.0
  - SCHEDULER
```
public static final PgxConfig.Field SCHEDULER
```
    which scheduler to use.
    basic_scheduler = use scheduler with basic features.
    enterprise_scheduler = use scheduler with advanced, enterprise features for running multiple tasks concurrently and increased performance.
    low_latency_scheduler = use scheduler that privileges latency of tasks over throughput or fairness across multiple sessions. The low_latency_scheduler is only available in embedded mode
  - SECURE_HANDSHAKE_SECRET_FILE
```
public static final PgxConfig.Field SECURE_HANDSHAKE_SECRET_FILE
```
    the file path of the secret in pkcs12 format. This is only used when enable_secure_handshaking is true.
  - SESSION_IDLE_TIMEOUT_SECS
```
public static final PgxConfig.Field SESSION_IDLE_TIMEOUT_SECS
```
    timeout of idling sessions in seconds. Set to zero for infinity/no timeout
  - SESSION_TASK_TIMEOUT_SECS
```
public static final PgxConfig.Field SESSION_TASK_TIMEOUT_SECS
```
    timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds. Set to zero for infinity/no timeout
  - SMALL_TASK_LENGTH
```
public static final PgxConfig.Field SMALL_TASK_LENGTH
```
    task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
  - STRICT_MODE
```
public static final PgxConfig.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.
  - STRING_POOLING_STRATEGY
```
public static final PgxConfig.Field STRING_POOLING_STRATEGY
```
    which string pooling strategy to use
  - TASK_LENGTH
```
public static final PgxConfig.Field TASK_LENGTH
```
    default task length (only relevant for task-stealing strategies). F/J pool documentation says this value should be between 100 and 10000. Trade-off: small number implies more fine-grained tasks are generated, higher stealing throughput. High number implies less memory consumption and GC activity
  - TMP_DIR
```
public static final PgxConfig.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)
  - UDF_CONFIG_DIRECTORY
```
public static final PgxConfig.Field UDF_CONFIG_DIRECTORY
```
    directory path containing udf config files
  - UNSAFE_ALLOW_FOREIGN_SYNTAX
```
@Deprecated
public static final PgxConfig.Field UNSAFE_ALLOW_FOREIGN_SYNTAX
```
    Deprecated.
    
    (This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
  - USE_INDEX_FOR_REACHABILITY_QUERIES
```
public static final PgxConfig.Field USE_INDEX_FOR_REACHABILITY_QUERIES
```
    create index for reachability queries
  - USE_INFINIBAND
```
public static final PgxConfig.Field USE_INFINIBAND
```
    If set to true, InfiniBand will be used. Must be set to false on systems that do not support InfiniBand.
  - USE_MEMORY_MAPPER_FOR_READING_PGB
```
public static final PgxConfig.Field USE_MEMORY_MAPPER_FOR_READING_PGB
```
    if true, use memory mapped files for reading graphs in PGB format if possible; false always use s stream based implementation
  - USE_MEMORY_MAPPER_FOR_STORING_PGB
```
public static final PgxConfig.Field USE_MEMORY_MAPPER_FOR_STORING_PGB
```
    if true, use memory mapped files for storing in PGB format if possible; if false always use a stream based implementation
- 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<PgxConfig.Field>
  - valueOf
```
public static PgxConfig.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 PgxConfig.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 (PgxConfig.Field c : PgxConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum PgxConfig.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

ALLOW_IDLE_TIMEOUT_OVERWRITE

ALLOW_OVERRIDE_SCHEDULING_INFORMATION

ALLOW_TASK_TIMEOUT_OVERWRITE

ALLOW_USER_AUTO_REFRESH

ALLOWED_REMOTE_LOADING_LOCATIONS

AUTHORIZATION

AUTHORIZATION_SESSION_CREATE_ALLOW_ALL

BACKEND_WRAPPER

BASIC_SCHEDULER_CONFIG

BFS_ITERATE_QUE_TASK_SIZE

BFS_THRESHOLD_PARENT_READ_BASED

BFS_THRESHOLD_READ_BASED

BFS_THRESHOLD_SINGLE_THREADED

BUILTINS_PATH

CHARACTER_SET

CNI_DIFF_FACTOR_DEFAULT

CNI_SMALL_DEFAULT

CNI_STOP_RECURSION_DEFAULT

COMMON_LOG_CONFIGURE

DATA_MEMORY_LIMITS

DEBUG_SERVER

DFS_THRESHOLD_LARGE

ENABLE_CSRF_TOKEN_CHECKS

ENABLE_GM_COMPILER

ENABLE_GRAPH_LOADING_CACHE

ENABLE_MEMORY_LIMITS_CHECKS

ENABLE_SECURE_HANDSHAKE

ENABLE_SHUTDOWN_CLEANUP_HOOK

ENTERPRISE_SCHEDULER_CONFIG

ENTERPRISE_SCHEDULER_FLAGS

EXECUTABLE_PATH

EXISTING_HOSTNAMES

EXPLICIT_SPIN_LOCKS

FILE_LOCATIONS

GHOST_MAX_NODE_COUNTS

GHOST_MIN_NEIGHBORS

GRAPH_ALGORITHM_LANGUAGE

GRAPH_VALIDATION_LEVEL

HANDSHAKE_PORT

HOSTNAMES

IF_ETHERNET

IF_INFINIBAND

IGNORE_INCOMPATIBLE_BACKEND_OPERATIONS

IN_PLACE_UPDATE_CONSISTENCY_MODEL

INIT_PGQL_ON_STARTUP

INSTANCE_NAME

INTERVAL_TO_POLL_MAX

JAVA_CLASS_PATH

JAVA_HOME_DIR

LARGE_ARRAY_THRESHOLD

LARGE_BUF_COUNT

LARGE_BUF_SIZE_KB

LAUNCH_WATCHDOGS

LOG_CONFIGURE

LOG_STD_REDIRECT

MAX_ACTIVE_SESSIONS

MAX_DISTINCT_STRINGS_PER_POOL

MAX_HTTP_CLIENT_REQUEST_SIZE

MAX_OFF_HEAP_SIZE

MAX_QUEUE_SIZE_PER_SESSION

MAX_SNAPSHOT_COUNT

MEMORY_ALLOCATOR

MEMORY_CLEANUP_INTERVAL

MIN_ARRAY_COMPACTION_THRESHOLD

MIN_FETCH_INTERVAL_SEC

MIN_UPDATE_INTERVAL_SEC

MS_BFS_FRONTIER_TYPE_STRATEGY

NUM_SPIN_LOCKS

PARALLELISM

PARTITIONING_IGNORE_GHOSTNODES

PARTITIONING_SHUFFLE_VERTICES

PARTITIONING_STRATEGY