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_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. |
ARRAY_FACTORY_STRATEGY
java_arrays = use normal java arrays only (limited to 32bit in length)
java_2d_arrays = use Java 2D arrays only (achieve arrays of 64bit in length with the cost of indirection) off_heap_arrays = use arrays allocated off-heap (achieve 64bit in length without performance penalty, but with the price of breaking out of the JVM) dynamic = decide at run-time which allocation strategy to use based on the requested array length |
BFS_ITERATE_QUE_TASK_SIZE
task size for BFS iterate QUE phase
|
BFS_THRESHOLD_READ_BASED
threshold of BFS traversal level items to switch to read-based visiting strategy
|
BFS_THRESHOLD_SINGLE_THREADED
until what number of BFS traversal level items vertices are visited single-threaded
|
BIG_PARTITION_THRESHOLD
the threshold for partitions to be considered 'big'.
|
CC
(only relevant if native analysis is enabled) C++ compiler executable (either absolute path or resolvable via
$PATH ) |
CFLAGS
(only relevant if native analysis is enabled) flags for C++ compiler
|
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.
|
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. |
EXPLICIT_SPIN_LOCKS
true means spin explicitly in a loop until lock becomes available. |
GRAPHS
list of paths to graph configs to be registered at start-up
|
INVOKEABLE_PROVIDERS
list of invokeable providers to be loaded during startup
|
LARGE_ARRAY_STRATEGY
[relevant for dynamic array factory only] array factory strategy to use when requested array size is exceeding large_array_threshold
|
LARGE_ARRAY_THRESHOLD
[relevant for dynamic array factory only] use large_array_strategy when requested array size is exceeding this number.
|
LAUNCH_WATCHDOGS
(for debugging) if
true , additional watch-dog threads will be launched which monitor and log engine health stats |
LFLAGS
(only relevant if native analysis is enabled) linker flags for C++ compiler
|
MAX_ACTIVE_SESSIONS
the maximum number of sessions allowed to be active at a time
|
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_CLEANUP_INTERVAL
memory cleanup tick in seconds
|
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.
|
NUM_WORKERS_ANALYSIS
how many worker threads to use for analysis tasks
|
NUM_WORKERS_FAST_TRACK_ANALYSIS
how many worker threads to use for fast-track analysis tasks
|
NUM_WORKERS_IO
how many worker threads to use for I/O tasks (load/refresh/write from/to disk).
|
PARALLELISM
number of worker threads to be used in thread pool.
|
PARALLELIZATION_STRATEGY
which parallelization strategy to use.
|
PATH_TO_GM_COMPILER
if set, use this path to
gm_comp binary for dynamic compilations. |
PATTERN_MATCHING_SEMANTIC
the graph pattern matching semantic which is either isomorphism or homomorphism
|
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.
|
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. |
TASK_LENGTH
default task length (only relevant for task-stealing strategies).
|
THROW_OUT_OF_MEMORY_ERROR_DURING_ALLOCATION
(for debugging) if
true , engine will throw OutOfMemoryErrors on purpose when trying to allocate large memory chunks. |
THROW_OUT_OF_MEMORY_ERROR_DURING_LOADING
(for debugging) if
true , engine will throw OutOfMemoryErrors on purpose when trying to load graphs from disk. |
THROW_OUT_OF_MEMORY_ERROR_DURING_MUTATION
(for debugging) if
true , engine will throw OutOfMemoryErrors on purpose when trying to mutate graphs. |
TMP_DIR
Use this path as temporary directory to store compilation artifacts and other temporary data.
|
UNSAFE_ALLOW_FOREIGN_SYNTAX
Deprecated.
|
UNSAFE_ALLOW_LOCAL_FILESYSTEM
Deprecated.
|
USE_NATIVE_ANALYSIS
execute analyses using Java (
false ) or C++ (true ) runtime |
USE_NATIVE_LOADERS
use Java (
false ) or C++ (true ) graph loader framework |
USE_STRING_POOL
If
true , PGX will store string properties in a pool in order to consume less memory on string properties |
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.lang.Class<?> |
getType()
Gets the type of this field.
|
boolean |
isArray()
Checks if this field is an array.
|
boolean |
isEnum()
Checks if this field is of enum type.
|
boolean |
isPath()
Checks if this field is a path.
|
boolean |
isPrimitive()
Checks if this field is of primitive type.
|
boolean |
isRequired()
Checks if this field is required.
|
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.
|
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_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 graphs
can have auto refresh enabledpublic static final PgxConfig.Field ARRAY_FACTORY_STRATEGY
public static final PgxConfig.Field BFS_ITERATE_QUE_TASK_SIZE
public static final PgxConfig.Field BFS_THRESHOLD_READ_BASED
public static final PgxConfig.Field BFS_THRESHOLD_SINGLE_THREADED
public static final PgxConfig.Field BIG_PARTITION_THRESHOLD
public static final PgxConfig.Field CC
$PATH
)public static final PgxConfig.Field CFLAGS
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 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 runtime. Note: the built-in Green-Marl compilers don't support all platforms. You can also use your own version of the compiler by setting the path_to_gm_compiler field.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 GRAPHS
public static final PgxConfig.Field INVOKEABLE_PROVIDERS
public static final PgxConfig.Field LARGE_ARRAY_STRATEGY
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 LFLAGS
public static final PgxConfig.Field MAX_ACTIVE_SESSIONS
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_CLEANUP_INTERVAL
public static final PgxConfig.Field MS_BFS_FRONTIER_TYPE_STRATEGY
public static final PgxConfig.Field NUM_SPIN_LOCKS
public static final PgxConfig.Field NUM_WORKERS_ANALYSIS
public static final PgxConfig.Field NUM_WORKERS_FAST_TRACK_ANALYSIS
public static final PgxConfig.Field NUM_WORKERS_IO
public static final PgxConfig.Field PARALLELISM
public static final PgxConfig.Field PARALLELIZATION_STRATEGY
public static final PgxConfig.Field PATH_TO_GM_COMPILER
gm_comp
binary for dynamic compilations. If not set and enable_gm_compiler is true
, PGX will try to utilize one of the built-in compiler binaries.public static final PgxConfig.Field PATTERN_MATCHING_SEMANTIC
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 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 TASK_LENGTH
public static final PgxConfig.Field THROW_OUT_OF_MEMORY_ERROR_DURING_ALLOCATION
true
, engine will throw OutOfMemoryErrors on purpose when trying to allocate large memory chunks.public static final PgxConfig.Field THROW_OUT_OF_MEMORY_ERROR_DURING_LOADING
true
, engine will throw OutOfMemoryErrors on purpose when trying to load graphs from disk.public static final PgxConfig.Field THROW_OUT_OF_MEMORY_ERROR_DURING_MUTATION
true
, engine will throw OutOfMemoryErrors on purpose when trying to mutate graphs.public static final PgxConfig.Field TMP_DIR
/tmp
on Linux)@Deprecated public static final PgxConfig.Field UNSAFE_ALLOW_FOREIGN_SYNTAX
@Deprecated public static final PgxConfig.Field UNSAFE_ALLOW_LOCAL_FILESYSTEM
public static final PgxConfig.Field USE_NATIVE_ANALYSIS
false
) or C++ (true
) runtimepublic static final PgxConfig.Field USE_NATIVE_LOADERS
false
) or C++ (true
) graph loader frameworkpublic static final PgxConfig.Field USE_STRING_POOL
true
, PGX will store string properties in a pool in order to consume less memory on string propertiespublic java.lang.Object getDefaultVal()
ConfigField
getDefaultVal
in interface ConfigField
public java.util.List<java.lang.String> getKeyAliases()
ConfigField
getKeyAliases
in interface ConfigField
public java.lang.Class<?> getType()
ConfigField
getType
in interface ConfigField
public boolean isArray()
ConfigField
isArray
in interface ConfigField
public boolean isEnum()
ConfigField
isEnum
in interface ConfigField
public boolean isPath()
ConfigField
isPath
in interface ConfigField
public boolean isPrimitive()
ConfigField
isPrimitive
in interface ConfigField
public boolean isRequired()
ConfigField
isRequired
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);
Copyright © 2016, 2017 Oracle Corp. All Rights Reserved.