public static enum PgxConfig.Field extends java.lang.Enum<PgxConfig.Field> implements ConfigField
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 |
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
|
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.
|
DATA_MEMORY_LIMITS
memory limits configuration parameters
|
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_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.
|
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
|
GRAPH_ALGORITHM_LANGUAGE
Frontend compiler to use.
|
GRAPH_VALIDATION_LEVEL
level of validation performed on newly loaded or created graphs
|
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. |
INTERVAL_TO_POLL_MAX
Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
|
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.
|
LAUNCH_WATCHDOGS
(for debugging) if
true , additional watch-dog threads will be launched which monitor and log engine health stats |
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.
|
PATTERN_MATCHING_SUPERNODE_CACHE_THRESHOLD
minimum number of a node's neighbor to be a supernode.
|
PGX_REALM
configuration parameters for the realm
|
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.
|
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.
|
RELEASE_MEMORY_THRESHOLD
threshold percentage of used memory after which the engine starts freeing un-used graphs.
|
REVISIT_THRESHOLD
maximum number of matched results from a node to be cached
|
SCHEDULER
which scheduler to use.
|
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_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
|
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.
|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
isEnum, isPrimitive
public static final PgxConfig.Field ADMIN_REQUEST_CACHE_TIMEOUT
public static final PgxConfig.Field ALLOW_IDLE_TIMEOUT_OVERWRITE
true
, sessions can overwrite default idle timeoutpublic static final PgxConfig.Field ALLOW_OVERRIDE_SCHEDULING_INFORMATION
true
allow all users to override scheduling information like task weight, task priority and number of threadspublic static final PgxConfig.Field ALLOW_TASK_TIMEOUT_OVERWRITE
true
, sessions can overwrite default task timeoutpublic static final PgxConfig.Field ALLOW_USER_AUTO_REFRESH
true
users may enable auto refresh for graphs they load. If false
only graphs mentioned in preload_graphs
can have auto refresh enabledpublic static final PgxConfig.Field ALLOWED_REMOTE_LOADING_LOCATIONS
public static final PgxConfig.Field AUTHORIZATION
public static final PgxConfig.Field AUTHORIZATION_SESSION_CREATE_ALLOW_ALL
true
allow all users to create a PGX session regardless of permissions granted to thempublic static final PgxConfig.Field BASIC_SCHEDULER_CONFIG
public static final PgxConfig.Field BFS_ITERATE_QUE_TASK_SIZE
public static final PgxConfig.Field BFS_THRESHOLD_PARENT_READ_BASED
public static final PgxConfig.Field BFS_THRESHOLD_READ_BASED
public static final PgxConfig.Field BFS_THRESHOLD_SINGLE_THREADED
public static final PgxConfig.Field CHARACTER_SET
public static final PgxConfig.Field CNI_DIFF_FACTOR_DEFAULT
public static final PgxConfig.Field CNI_SMALL_DEFAULT
public static final PgxConfig.Field CNI_STOP_RECURSION_DEFAULT
public static final PgxConfig.Field DATA_MEMORY_LIMITS
public static final PgxConfig.Field DFS_THRESHOLD_LARGE
public static final PgxConfig.Field ENABLE_CSRF_TOKEN_CHECKS
public static final PgxConfig.Field ENABLE_GM_COMPILER
true
, enable dynamic compilation of Green-Marl code during runtimepublic static final PgxConfig.Field ENABLE_GRAPH_LOADING_CACHE
true
, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)public static final PgxConfig.Field ENABLE_MEMORY_LIMITS_CHECKS
public static final PgxConfig.Field ENABLE_SHUTDOWN_CLEANUP_HOOK
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.public static final PgxConfig.Field ENTERPRISE_SCHEDULER_CONFIG
public static final PgxConfig.Field ENTERPRISE_SCHEDULER_FLAGS
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.public static final PgxConfig.Field FILE_LOCATIONS
public static final PgxConfig.Field GRAPH_ALGORITHM_LANGUAGE
public static final PgxConfig.Field GRAPH_VALIDATION_LEVEL
public static final PgxConfig.Field IGNORE_INCOMPATIBLE_BACKEND_OPERATIONS
true
only log when encountering incompatible operations and configuration values in RTS or FJ pool. If false
throw exceptionspublic static final PgxConfig.Field IN_PLACE_UPDATE_CONSISTENCY_MODEL
public static final PgxConfig.Field INIT_PGQL_ON_STARTUP
true
PGQL is directly initialized on start-up of PGX. Otherwise, it is initialized during the first use of PGQL.public static final PgxConfig.Field INTERVAL_TO_POLL_MAX
public static final PgxConfig.Field JAVA_HOME_DIR
public static final PgxConfig.Field LARGE_ARRAY_THRESHOLD
Integer.MAX_VALUE - 3
)public static final PgxConfig.Field LAUNCH_WATCHDOGS
true
, additional watch-dog threads will be launched which monitor and log engine health statspublic static final PgxConfig.Field MAX_ACTIVE_SESSIONS
public static final PgxConfig.Field MAX_DISTINCT_STRINGS_PER_POOL
public static final PgxConfig.Field MAX_HTTP_CLIENT_REQUEST_SIZE
public static final PgxConfig.Field MAX_OFF_HEAP_SIZE
public static final PgxConfig.Field MAX_QUEUE_SIZE_PER_SESSION
public static final PgxConfig.Field MAX_SNAPSHOT_COUNT
public static final PgxConfig.Field MEMORY_ALLOCATOR
public static final PgxConfig.Field MEMORY_CLEANUP_INTERVAL
public static final PgxConfig.Field MIN_ARRAY_COMPACTION_THRESHOLD
public static final PgxConfig.Field MIN_FETCH_INTERVAL_SEC
public static final PgxConfig.Field MIN_UPDATE_INTERVAL_SEC
public static final PgxConfig.Field MS_BFS_FRONTIER_TYPE_STRATEGY
public static final PgxConfig.Field NUM_SPIN_LOCKS
public static final PgxConfig.Field PARALLELISM
public static final PgxConfig.Field PATTERN_MATCHING_SUPERNODE_CACHE_THRESHOLD
public static final PgxConfig.Field PGX_REALM
public static final PgxConfig.Field POOLING_FACTOR
public static final PgxConfig.Field PRELOAD_GRAPHS
public static final PgxConfig.Field RANDOM_GENERATOR_STRATEGY
public static final PgxConfig.Field RANDOM_SEED
public static final PgxConfig.Field RELEASE_MEMORY_THRESHOLD
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 OutOfMemoryError
s 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.public static final PgxConfig.Field REVISIT_THRESHOLD
public static final PgxConfig.Field SCHEDULER
public static final PgxConfig.Field SESSION_IDLE_TIMEOUT_SECS
public static final PgxConfig.Field SESSION_TASK_TIMEOUT_SECS
public static final PgxConfig.Field SMALL_TASK_LENGTH
public static final PgxConfig.Field STRICT_MODE
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.public static final PgxConfig.Field STRING_POOLING_STRATEGY
public static final PgxConfig.Field TASK_LENGTH
public static final PgxConfig.Field TMP_DIR
/tmp
on Linux)public static final PgxConfig.Field UDF_CONFIG_DIRECTORY
@Deprecated public static final PgxConfig.Field UNSAFE_ALLOW_FOREIGN_SYNTAX
public static final PgxConfig.Field USE_INDEX_FOR_REACHABILITY_QUERIES
public static final PgxConfig.Field USE_MEMORY_MAPPER_FOR_READING_PGB
public static final PgxConfig.Field USE_MEMORY_MAPPER_FOR_STORING_PGB
public java.lang.Object getDefaultVal()
ConfigField
getDefaultVal
in interface ConfigField
public java.util.List<java.lang.String> getKeyAliases()
ConfigField
getKeyAliases
in interface ConfigField
public java.util.List<java.lang.String> getSingletonListKeyAliases()
ConfigField
getSingletonListKeyAliases
in interface ConfigField
public java.lang.Class<?> getType()
ConfigField
getType
in interface ConfigField
public boolean isArray()
ConfigField
isArray
in interface ConfigField
public boolean isHidden()
ConfigField
isHidden
in interface ConfigField
public boolean isPath()
ConfigField
isPath
in interface ConfigField
public boolean isRequired()
ConfigField
isRequired
in interface ConfigField
public boolean isSensitive()
ConfigField
isSensitive
in interface ConfigField
public java.lang.String toKey()
ConfigField
toKey
in interface ConfigField
public java.lang.String toString()
toString
in class java.lang.Enum<PgxConfig.Field>
public static PgxConfig.Field valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static PgxConfig.Field[] values()
for (PgxConfig.Field c : PgxConfig.Field.values()) System.out.println(c);