PgxConfig (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- oracle.pgx.config.AbstractConfig
- - oracle.pgx.config.AbstractEngineConfig
  - - oracle.pgx.config.AbstractPgxConfig
    - - oracle.pgx.config.PgxConfig

@Generated(value="config_generator.py")
public class PgxConfig
extends AbstractPgxConfig

PGX Engine Config

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PgxConfig.Field
Fields of PGX Engine Config

Nested Classes
Modifier and Type	Class and Description
`static class`	`PgxConfig.Field` Fields of PGX Engine Config

Field Summary
- Fields inherited from class oracle.pgx.config.AbstractConfig
  ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getAdminRequestCacheTimeout()` after how many seconds admin request results get removed from the cache.
`java.util.List<java.lang.String>`	`getAllowedRemoteLoadingLocations()` (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.
`java.util.List<AuthorizationEntityConfig>`	`getAuthorization()` mapping of users and roles to resources and permissions for authorization
`java.util.List<PgxConfig.Field>`	`getBackendFields()`
`BasicSchedulerConfig`	`getBasicSchedulerConfig()` configuration parameters for the fork join pool backend
`java.lang.Integer`	`getBfsIterateQueTaskSize()` task size for BFS iterate QUE phase
`java.lang.Double`	`getBfsThresholdParentReadBased()` threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
`java.lang.Integer`	`getBfsThresholdReadBased()` threshold of BFS traversal level items above which to switch to read-based visiting strategy
`java.lang.Integer`	`getBfsThresholdSingleThreaded()` until what number of BFS traversal level items vertices are visited single-threaded
`java.lang.String`	`getCc()` Deprecated.
`java.lang.String`	`getCctraceOut()` Deprecated.
`java.lang.String`	`getCflags()` Deprecated.
`java.lang.String`	`getCharacterSet()` standard charset to use throughout PGX, UTF-8 will be used as default.
`java.lang.Integer`	`getCniDiffFactorDefault()` default diff factor value used in the common neighbor iterator implementations.
`java.lang.Integer`	`getCniSmallDefault()` default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
`java.lang.Integer`	`getCniStopRecursionDefault()` default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
`static PgxConfig.Field[]`	`getConfigFields()`
`java.util.List<java.lang.String>`	`getDatasourceDirWhitelist()` Deprecated.
`java.lang.Integer`	`getDfsThresholdLarge()` 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.
`EnterpriseSchedulerConfig`	`getEnterpriseSchedulerConfig()` configuration parameters for the enterprise scheduler
`EnterpriseSchedulerFlagsConfig`	`getEnterpriseSchedulerFlags()` [relevant for `enterprise_scheduler`] enterprise scheduler specific settings.
`java.util.List<AuthorizationLocationConfig>`	`getFileLocations()` the file-locations that can be used in the authorization-config
`Compiler`	`getGraphAlgorithmLanguage()` Frontend compiler to use.
`java.util.List<java.lang.String>`	`getGraphs()` Deprecated.
`GraphValidationLevel`	`getGraphValidationLevel()` level of validation performed on newly loaded or created graphs
`UpdateConsistencyModel`	`getInPlaceUpdateConsistencyModel()` Consistency model used when in-place updates occur.
`java.lang.Integer`	`getIntervalToPollMax()` Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
`java.lang.String`	`getJavaHomeDir()` The path to Java's home directory.
`java.lang.Integer`	`getLargeArrayThreshold()` threshold when the size of an array is too big to use a normal Java array.
`java.lang.String`	`getLflags()` Deprecated.
`java.lang.Integer`	`getMaxActiveSessions()` the maximum number of sessions allowed to be active at a time
`java.lang.Integer`	`getMaxDistinctStringsPerPool()` [only relevant if `string_pooling_strategy` is `indexed`] amount of distinct strings per property after which to stop pooling.
`java.lang.Long`	`getMaxHttpClientRequestSize()` maximum size in bytes of any http request sent to to the PGX server over the REST API.
`java.lang.Integer`	`getMaxOffHeapSize()` maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
`java.lang.Integer`	`getMaxQueueSizePerSession()` the maximum number of pending tasks allowed to be in the queue, per session.
`java.lang.Integer`	`getMaxSnapshotCount()` Number of snapshots that may be loaded in the engine at the same time.
`MemoryAllocationStrategy`	`getMemoryAllocator()` which memory allocator to use
`java.lang.Integer`	`getMemoryCleanupInterval()` memory cleanup tick in seconds
`java.lang.Double`	`getMinArrayCompactionThreshold()` [only relevant for graphs optimized for updates] minimum value that can be used for the array_compaction_threshold value in graph configuration.
`java.lang.Integer`	`getMinFetchIntervalSec()` (only relevant if the graph format supports delta updates) for delta-refresh, the lowest interval at which a graph source is queried for changes.
`java.lang.Integer`	`getMinUpdateIntervalSec()` 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).
`FrontierTypeStrategy`	`getMsBfsFrontierTypeStrategy()` the type strategy to use for MS-BFS frontiers
`java.lang.Integer`	`getNumSpinLocks()` how many spin locks each generated app will create at instantiation.
`java.lang.Integer`	`getNumWorkersAnalysis()` Deprecated.
`java.lang.Integer`	`getNumWorkersFastTrackAnalysis()` Deprecated.
`java.lang.Integer`	`getNumWorkersIo()` Deprecated.
`java.lang.Integer`	`getParallelism()` number of worker threads to be used in thread pool.
`java.lang.String`	`getPathToGmCompiler()` Deprecated.
`oracle.pgx.config.PatternMatchingSemantic`	`getPatternMatchingSemantic()` Deprecated.
`java.lang.Integer`	`getPatternMatchingSupernodeCacheThreshold()` minimum number of a node's neighbor to be a supernode.
`RealmConfig`	`getPgxRealm()` configuration parameters for the realm
`java.lang.Double`	`getPoolingFactor()` [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
`java.util.List<PreloadGraphConfig>`	`getPreloadGraphs()` list of graph configs to be registered at start-up.
`RandomGeneratorStrategy`	`getRandomGeneratorStrategy()` method of generating random numbers in pgx
`java.lang.Long`	`getRandomSeed()` [relevant for `deterministic` random number generator only] seed for the deterministic random number generator used in pgx.
`java.lang.Double`	`getReleaseMemoryThreshold()` threshold percentage of used memory after which the engine starts freeing un-used graphs.
`java.lang.Integer`	`getRevisitThreshold()` maximum number of matched results from a node to be cached
`SchedulerStrategy`	`getScheduler()` which scheduler to use.
`java.lang.Integer`	`getSessionIdleTimeoutSecs()` timeout of idling sessions in seconds.
`java.lang.Integer`	`getSessionTaskTimeoutSecs()` timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds.
`java.lang.Integer`	`getSmallTaskLength()` task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
`StringPoolingStrategy`	`getStringPoolingStrategy()` [only relevant if `use_string_pool` is enabled] which string pooling strategy to use
`java.lang.Integer`	`getTaskLength()` default task length (only relevant for task-stealing strategies).
`java.lang.String`	`getTmpDir()` Use this path as temporary directory to store compilation artifacts and other temporary data.
`java.lang.String`	`getUdfConfigDirectory()` directory path containing udf config files
`java.util.Map<PgxConfig.Field,java.lang.Object>`	`getValues()` Gets the parsed values.
`java.util.Map<PgxConfig.Field,java.lang.Object>`	`getValuesWithoutDefaults()` Gets the values without defaults.
`boolean`	`hasDefaultValue(PgxConfig.Field field)` Checks for default value.
`java.lang.Boolean`	`isAllowIdleTimeoutOverwrite()` if `true`, sessions can overwrite default idle timeout
`java.lang.Boolean`	`isAllowLocalFilesystem()` Deprecated.
`java.lang.Boolean`	`isAllowOverrideSchedulingInformation()` if `true` allow all users to override scheduling information like task weight, task priority and number of threads
`java.lang.Boolean`	`isAllowTaskTimeoutOverwrite()` if `true`, sessions can overwrite default task timeout
`java.lang.Boolean`	`isAllowUserAutoRefresh()` if `true` users may enable auto refresh for graphs they load.
`java.lang.Boolean`	`isAuthorizationSessionCreateAllowAll()` if `true` allow all users to create a PGX session regardless of permissions granted to them
`java.lang.Boolean`	`isCctrace()` Deprecated.
`java.lang.Boolean`	`isCctracePrintStacktraces()` Deprecated.
`boolean`	`isEmpty()` Checks if it's empty.
`java.lang.Boolean`	`isEnableCsrfTokenChecks()` if true, the PGX webapp will verify CSRF token cookie and request parameters sent by the client exist and match.
`java.lang.Boolean`	`isEnableGmCompiler()` if `true`, enable dynamic compilation of Green-Marl code during runtime
`java.lang.Boolean`	`isEnableGraphLoadingCache()` if `true`, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
`java.lang.Boolean`	`isEnableShutdownCleanupHook()` if `true` PGX will add a JVM shutdown hook that will automatically shutdown PGX at JVM shutdown.
`java.lang.Boolean`	`isEnableSolarisStudioLabeling()` Deprecated.
`java.lang.Boolean`	`isExplicitSpinLocks()` `true` means spin explicitly in a loop until lock becomes available.
`java.lang.Boolean`	`isIgnoreIncompatibleBackendOperations()` if `true` only log when encountering incompatible operations and configuration values in RTS or FJ pool.
`java.lang.Boolean`	`isInitPgqlOnStartup()` if `true` PGQL is directly initialized on start-up of PGX.
`java.lang.Boolean`	`isLaunchWatchdogs()` (for debugging) if `true`, additional watch-dog threads will be launched which monitor and log engine health stats
`java.lang.Boolean`	`isStrictMode()` if `true`, exceptions are thrown and logged with `ERROR` level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors.
`java.lang.Boolean`	`isUnsafeAllowForeignSyntax()` (This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
`static PgxConfig`	`parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)` Parses an input stream.
`static PgxConfig`	`parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)` Parses a raw key/value mapping.
`static PgxConfig`	`parse(java.util.Properties props, boolean strict)` Parses a properties file.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(boolean hideSensitiveData)`
`java.lang.Boolean`	`useMemoryMapperForReadingPgb()` if `true`, use memory mapped files for reading graphs in PGB format if possible; `false` always use s stream based implementation
`java.lang.Boolean`	`useMemoryMapperForStoringPgb()` if `true`, use memory mapped files for storing in PGB format if possible; if `false` always use a stream based implementation
`java.lang.Boolean`	`useNativeAnalysis()` Deprecated.
`java.lang.Boolean`	`useNativeLoaders()` Deprecated.
`java.lang.Boolean`	`useStringPool()` Deprecated.

Methods inherited from class oracle.pgx.config.AbstractPgxConfig
getInstance, getInstance, getRolePermissionMapping, getRuntimeConfig, getUserPermissionMapping, validate

Methods inherited from class oracle.pgx.config.AbstractConfig
getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAdminRequestCacheTimeout
```
public java.lang.Integer getAdminRequestCacheTimeout()
```
    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.
    
    Specified by:
    
    getAdminRequestCacheTimeout in class AbstractEngineConfig
  - getAllowedRemoteLoadingLocations
```
public java.util.List<java.lang.String> getAllowedRemoteLoadingLocations()
```
    (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
    
    Specified by:
    
    getAllowedRemoteLoadingLocations in class AbstractEngineConfig
  - getAuthorization
```
public java.util.List<AuthorizationEntityConfig> getAuthorization()
```
    mapping of users and roles to resources and permissions for authorization
    
    Specified by:
    
    getAuthorization in class AbstractPgxConfig
  - getBackendFields
```
public java.util.List<PgxConfig.Field> getBackendFields()
```
  - getBasicSchedulerConfig
```
public BasicSchedulerConfig getBasicSchedulerConfig()
```
    configuration parameters for the fork join pool backend
  - getBfsIterateQueTaskSize
```
public java.lang.Integer getBfsIterateQueTaskSize()
```
    task size for BFS iterate QUE phase
  - getBfsThresholdParentReadBased
```
public java.lang.Double getBfsThresholdParentReadBased()
```
    threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
  - getBfsThresholdReadBased
```
public java.lang.Integer getBfsThresholdReadBased()
```
    threshold of BFS traversal level items above which to switch to read-based visiting strategy
  - getBfsThresholdSingleThreaded
```
public java.lang.Integer getBfsThresholdSingleThreaded()
```
    until what number of BFS traversal level items vertices are visited single-threaded
  - getCc
```
@Deprecated
public java.lang.String getCc()
```
    Deprecated.
    
    (only relevant if native analysis is enabled) C++ compiler executable (either absolute path or resolvable via $PATH)
  - getCctraceOut
```
@Deprecated
public java.lang.String getCctraceOut()
```
    Deprecated.
    
    [relevant for cctrace] when cctrace is enabled, specifies a path to a file where cctrace should log to. If null it will use the default PGX logger on level TRACE. If it is the special value :stderr: it will log to stderr
  - getCflags
```
@Deprecated
public java.lang.String getCflags()
```
    Deprecated.
    
    (only relevant if native analysis is enabled) flags for C++ compiler
  - getCharacterSet
```
public java.lang.String getCharacterSet()
```
    standard charset to use throughout PGX, UTF-8 will be used as default. Note: Some formats may not be compatible.
  - getCniDiffFactorDefault
```
public java.lang.Integer getCniDiffFactorDefault()
```
    default diff factor value used in the common neighbor iterator implementations.
  - getCniSmallDefault
```
public java.lang.Integer getCniSmallDefault()
```
    default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
  - getCniStopRecursionDefault
```
public java.lang.Integer getCniStopRecursionDefault()
```
    default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
  - getConfigFields
```
public static PgxConfig.Field[] getConfigFields()
```
  - getDatasourceDirWhitelist
```
@Deprecated
public java.util.List<java.lang.String> getDatasourceDirWhitelist()
```
    Deprecated.
    
    if allow_local_filesystem is set, the list of directories from which it is allowed to read files.
    
    Specified by:
    
    getDatasourceDirWhitelist in class AbstractEngineConfig
  - getDfsThresholdLarge
```
public java.lang.Integer getDfsThresholdLarge()
```
    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.
  - getEnterpriseSchedulerConfig
```
public EnterpriseSchedulerConfig getEnterpriseSchedulerConfig()
```
    configuration parameters for the enterprise scheduler
  - getEnterpriseSchedulerFlags
```
public EnterpriseSchedulerFlagsConfig getEnterpriseSchedulerFlags()
```
    [relevant for enterprise_scheduler] enterprise scheduler specific settings.
  - getFileLocations
```
public java.util.List<AuthorizationLocationConfig> getFileLocations()
```
    the file-locations that can be used in the authorization-config
    
    Specified by:
    
    getFileLocations in class AbstractPgxConfig
  - getGraphAlgorithmLanguage
```
public Compiler getGraphAlgorithmLanguage()
```
    Frontend compiler to use.
  - getGraphs
```
@Deprecated
public java.util.List<java.lang.String> getGraphs()
```
    Deprecated.
    
    list of paths to graph configs to be registered at start-up. This field is deprecated and replaced by preload_graphs field.
  - getGraphValidationLevel
```
public GraphValidationLevel getGraphValidationLevel()
```
    level of validation performed on newly loaded or created graphs
  - getInPlaceUpdateConsistencyModel
```
public UpdateConsistencyModel getInPlaceUpdateConsistencyModel()
```
    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.
  - getIntervalToPollMax
```
public java.lang.Integer getIntervalToPollMax()
```
    Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
    
    Specified by:
    
    getIntervalToPollMax in class AbstractEngineConfig
  - getJavaHomeDir
```
public java.lang.String getJavaHomeDir()
```
    The path to Java's home directory. If set to <system-java-home-dir>, use the java.home system property.
  - getLargeArrayThreshold
```
public java.lang.Integer getLargeArrayThreshold()
```
    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)
  - getLflags
```
@Deprecated
public java.lang.String getLflags()
```
    Deprecated.
    
    (only relevant if native analysis is enabled) linker flags for C++ compiler
  - getMaxActiveSessions
```
public java.lang.Integer getMaxActiveSessions()
```
    the maximum number of sessions allowed to be active at a time
  - getMaxDistinctStringsPerPool
```
public java.lang.Integer getMaxDistinctStringsPerPool()
```
    [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
  - getMaxHttpClientRequestSize
```
public java.lang.Long getMaxHttpClientRequestSize()
```
    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.
    
    Specified by:
    
    getMaxHttpClientRequestSize in class AbstractEngineConfig
  - getMaxOffHeapSize
```
public java.lang.Integer getMaxOffHeapSize()
```
    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.
  - getMaxQueueSizePerSession
```
public java.lang.Integer getMaxQueueSizePerSession()
```
    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.
  - getMaxSnapshotCount
```
public java.lang.Integer getMaxSnapshotCount()
```
    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.
  - getMemoryAllocator
```
public MemoryAllocationStrategy getMemoryAllocator()
```
    which memory allocator to use
  - getMemoryCleanupInterval
```
public java.lang.Integer getMemoryCleanupInterval()
```
    memory cleanup tick in seconds
  - getMinArrayCompactionThreshold
```
public java.lang.Double getMinArrayCompactionThreshold()
```
    [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 attemps to use a value lower than the one specified by min_array_compaction_threshold, it will use min_array_compaction_threshold instead
  - getMinFetchIntervalSec
```
public java.lang.Integer getMinFetchIntervalSec()
```
    (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.
  - getMinUpdateIntervalSec
```
public java.lang.Integer getMinUpdateIntervalSec()
```
    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.
  - getMsBfsFrontierTypeStrategy
```
public FrontierTypeStrategy getMsBfsFrontierTypeStrategy()
```
    the type strategy to use for MS-BFS frontiers
  - getNumSpinLocks
```
public java.lang.Integer getNumSpinLocks()
```
    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)
  - getNumWorkersAnalysis
```
@Deprecated
public java.lang.Integer getNumWorkersAnalysis()
```
    Deprecated.
    
    how many worker threads to use for analysis tasks
  - getNumWorkersFastTrackAnalysis
```
@Deprecated
public java.lang.Integer getNumWorkersFastTrackAnalysis()
```
    Deprecated.
    
    how many worker threads to use for fast-track analysis tasks
  - getNumWorkersIo
```
@Deprecated
public java.lang.Integer getNumWorkersIo()
```
    Deprecated.
    
    how many worker threads to use for I/O tasks (load/refresh/write from/to disk). This value won't affect file-based loaders, as they're always single-threaded. Database loaders will open a new connection for each I/O worker.
  - getParallelism
```
public java.lang.Integer getParallelism()
```
    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.
  - getPathToGmCompiler
```
@Deprecated
public java.lang.String getPathToGmCompiler()
```
    Deprecated.
    
    if set, use this path to 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.
  - getPatternMatchingSemantic
```
@Deprecated
public oracle.pgx.config.PatternMatchingSemantic getPatternMatchingSemantic()
```
    Deprecated.
    
    the graph pattern matching semantic which is either homomorphism or isomorphism. This field is deprecated and replaced by the built-in PGQL function all_different(v1, v2, ...) that allows for specifying that the pattern and the match should be isomorphic to each other.
  - getPatternMatchingSupernodeCacheThreshold
```
public java.lang.Integer getPatternMatchingSupernodeCacheThreshold()
```
    minimum number of a node's neighbor to be a supernode. This is for pattern matching engine.
  - getPgxRealm
```
public RealmConfig getPgxRealm()
```
    configuration parameters for the realm
  - getPoolingFactor
```
public java.lang.Double getPoolingFactor()
```
    [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
  - getPreloadGraphs
```
public java.util.List<PreloadGraphConfig> getPreloadGraphs()
```
    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.
    
    Specified by:
    
    getPreloadGraphs in class AbstractPgxConfig
  - getRandomGeneratorStrategy
```
public RandomGeneratorStrategy getRandomGeneratorStrategy()
```
    method of generating random numbers in pgx
  - getRandomSeed
```
public java.lang.Long getRandomSeed()
```
    [relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx. The default is -24466691093057031
  - getReleaseMemoryThreshold
```
public java.lang.Double getReleaseMemoryThreshold()
```
    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.
  - getRevisitThreshold
```
public java.lang.Integer getRevisitThreshold()
```
    maximum number of matched results from a node to be cached
  - getScheduler
```
public SchedulerStrategy getScheduler()
```
    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
  - getSessionIdleTimeoutSecs
```
public java.lang.Integer getSessionIdleTimeoutSecs()
```
    timeout of idling sessions in seconds. Set to zero for infinity/no timeout
  - getSessionTaskTimeoutSecs
```
public java.lang.Integer getSessionTaskTimeoutSecs()
```
    timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds. Set to zero for infinity/no timeout
  - getSmallTaskLength
```
public java.lang.Integer getSmallTaskLength()
```
    task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
  - getStringPoolingStrategy
```
public StringPoolingStrategy getStringPoolingStrategy()
```
    [only relevant if use_string_pool is enabled] which string pooling strategy to use
  - getTaskLength
```
public java.lang.Integer getTaskLength()
```
    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
  - getTmpDir
```
public java.lang.String getTmpDir()
```
    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)
    
    Specified by:
    
    getTmpDir in class AbstractEngineConfig
  - getUdfConfigDirectory
```
public java.lang.String getUdfConfigDirectory()
```
    directory path containing udf config files
    
    Specified by:
    
    getUdfConfigDirectory in class AbstractPgxConfig
  - getValues
```
public java.util.Map<PgxConfig.Field,java.lang.Object> getValues()
```
    Gets the parsed values.
    
    Specified by:
    
    getValues in class AbstractPgxConfig
    
    Returns:
    
    the parsed values
  - getValuesWithoutDefaults
```
public java.util.Map<PgxConfig.Field,java.lang.Object> getValuesWithoutDefaults()
```
    Gets the values without defaults.
    
    Returns:
    
    the values without defaults
  - hasDefaultValue
```
public boolean hasDefaultValue(PgxConfig.Field field)
```
    Checks for default value.
    
    Parameters:
    
    field - the field
    
    Returns:
    
    true, if value for given field is the default value
  - isAllowIdleTimeoutOverwrite
```
public java.lang.Boolean isAllowIdleTimeoutOverwrite()
```
    if true, sessions can overwrite default idle timeout
  - isAllowLocalFilesystem
```
@Deprecated
public java.lang.Boolean isAllowLocalFilesystem()
```
    Deprecated.
    
    (This flag reduces security, enable only if you know what you are doing!) Allow loading from local filesystem, if in client/server mode. The list of directories that are allowed to be read should be listed in datasource_dir_whitelist. WARNING: This should only be enabled if you want to explicitly allow users of the PGX remote interface to access files on the local filesystem.
    
    Specified by:
    
    isAllowLocalFilesystem in class AbstractEngineConfig
  - isAllowOverrideSchedulingInformation
```
public java.lang.Boolean isAllowOverrideSchedulingInformation()
```
    if true allow all users to override scheduling information like task weight, task priority and number of threads
  - isAllowTaskTimeoutOverwrite
```
public java.lang.Boolean isAllowTaskTimeoutOverwrite()
```
    if true, sessions can overwrite default task timeout
  - isAllowUserAutoRefresh
```
public java.lang.Boolean isAllowUserAutoRefresh()
```
    if true users may enable auto refresh for graphs they load. If false only graphs mentioned in preload_graphs can have auto refresh enabled
  - isAuthorizationSessionCreateAllowAll
```
public java.lang.Boolean isAuthorizationSessionCreateAllowAll()
```
    if true allow all users to create a PGX session regardless of permissions granted to them
  - isCctrace
```
@Deprecated
public java.lang.Boolean isCctrace()
```
    Deprecated.
    
    if true log every call to a Control or Core interface
  - isCctracePrintStacktraces
```
@Deprecated
public java.lang.Boolean isCctracePrintStacktraces()
```
    Deprecated.
    
    [relevant for cctrace] when cctrace is enabled, print the stacktrace for each request and result
  - isEmpty
```
public boolean isEmpty()
```
    Checks if it's empty.
    
    Returns:
    
    true, if the Map 'values' is empty.
  - isEnableCsrfTokenChecks
```
public java.lang.Boolean isEnableCsrfTokenChecks()
```
    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.
    
    Specified by:
    
    isEnableCsrfTokenChecks in class AbstractEngineConfig
  - isEnableGmCompiler
```
public java.lang.Boolean isEnableGmCompiler()
```
    if true, enable dynamic compilation of Green-Marl code during runtime
  - isEnableGraphLoadingCache
```
public java.lang.Boolean isEnableGraphLoadingCache()
```
    if true, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
  - isEnableShutdownCleanupHook
```
public java.lang.Boolean isEnableShutdownCleanupHook()
```
    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.
  - isEnableSolarisStudioLabeling
```
@Deprecated
public java.lang.Boolean isEnableSolarisStudioLabeling()
```
    Deprecated.
    
    [relevant when profiling with solaris studio] when enabled, label experiments using the 'er_label' command
  - isExplicitSpinLocks
```
public java.lang.Boolean isExplicitSpinLocks()
```
    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.
  - isIgnoreIncompatibleBackendOperations
```
public java.lang.Boolean isIgnoreIncompatibleBackendOperations()
```
    if true only log when encountering incompatible operations and configuration values in RTS or FJ pool. If false throw exceptions
  - isInitPgqlOnStartup
```
public java.lang.Boolean isInitPgqlOnStartup()
```
    if true PGQL is directly initialized on start-up of PGX. Otherwise, it is initialized during the first use of PGQL.
  - isLaunchWatchdogs
```
public java.lang.Boolean isLaunchWatchdogs()
```
    (for debugging) if true, additional watch-dog threads will be launched which monitor and log engine health stats
  - isStrictMode
```
public java.lang.Boolean isStrictMode()
```
    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.
  - isUnsafeAllowForeignSyntax
```
public java.lang.Boolean isUnsafeAllowForeignSyntax()
```
    (This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
  - parse
```
public static PgxConfig parse(java.io.InputStream is,
                              boolean strict,
                              java.lang.String parentPath)
                       throws java.io.IOException
```
    Parses an input stream.
    
    Parameters:
    
    is - the input stream
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - parse
```
public static PgxConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                              boolean strict,
                              java.lang.String parentPath)
```
    Parses a raw key/value mapping.
    
    Parameters:
    
    raw - the raw key/value mapping to parse
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
  - parse
```
public static PgxConfig parse(java.util.Properties props,
                              boolean strict)
```
    Parses a properties file.
    
    Parameters:
    
    props - the properties to parse
    
    strict - if true, parses in strict mode
    
    Returns:
    
    the parsed graph config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(boolean hideSensitiveData)
```
  - useMemoryMapperForReadingPgb
```
public java.lang.Boolean useMemoryMapperForReadingPgb()
```
    if true, use memory mapped files for reading graphs in PGB format if possible; false always use s stream based implementation
  - useMemoryMapperForStoringPgb
```
public java.lang.Boolean useMemoryMapperForStoringPgb()
```
    if true, use memory mapped files for storing in PGB format if possible; if false always use a stream based implementation
  - useNativeAnalysis
```
@Deprecated
public java.lang.Boolean useNativeAnalysis()
```
    Deprecated.
    
    execute analyses using Java (false) or C++ (true) runtime
  - useNativeLoaders
```
@Deprecated
public java.lang.Boolean useNativeLoaders()
```
    Deprecated.
    
    use Java (false) or C++ (true) graph loader framework
  - useStringPool
```
@Deprecated
public java.lang.Boolean useStringPool()
```
    Deprecated.
    
    If true, PGX will store string properties in a pool in order to consume less memory on string properties

Class PgxConfig

Nested Class Summary

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

Method Summary

Methods inherited from class oracle.pgx.config.AbstractPgxConfig

Methods inherited from class oracle.pgx.config.AbstractConfig

Methods inherited from class java.lang.Object

Method Detail

equals

getAdminRequestCacheTimeout

getAllowedRemoteLoadingLocations

getAuthorization

getBackendFields

getBasicSchedulerConfig

getBfsIterateQueTaskSize

getBfsThresholdParentReadBased

getBfsThresholdReadBased

getBfsThresholdSingleThreaded

getCc

getCctraceOut

getCflags

getCharacterSet

getCniDiffFactorDefault

getCniSmallDefault

getCniStopRecursionDefault

getConfigFields

getDatasourceDirWhitelist

getDfsThresholdLarge

getEnterpriseSchedulerConfig

getEnterpriseSchedulerFlags

getFileLocations

getGraphAlgorithmLanguage

getGraphs

getGraphValidationLevel

getInPlaceUpdateConsistencyModel

getIntervalToPollMax

getJavaHomeDir

getLargeArrayThreshold

getLflags

getMaxActiveSessions

getMaxDistinctStringsPerPool

getMaxHttpClientRequestSize

getMaxOffHeapSize

getMaxQueueSizePerSession

getMaxSnapshotCount

getMemoryAllocator

getMemoryCleanupInterval

getMinArrayCompactionThreshold

getMinFetchIntervalSec

getMinUpdateIntervalSec

getMsBfsFrontierTypeStrategy

getNumSpinLocks

getNumWorkersAnalysis

getNumWorkersFastTrackAnalysis

getNumWorkersIo

getParallelism

getPathToGmCompiler

getPatternMatchingSemantic

getPatternMatchingSupernodeCacheThreshold

getPgxRealm

getPoolingFactor

getPreloadGraphs

getRandomGeneratorStrategy

getRandomSeed

getReleaseMemoryThreshold

getRevisitThreshold

getScheduler

getSessionIdleTimeoutSecs

getSessionTaskTimeoutSecs

getSmallTaskLength

getStringPoolingStrategy

getTaskLength

getTmpDir

getUdfConfigDirectory

getValues

getValuesWithoutDefaults

hasDefaultValue

isAllowIdleTimeoutOverwrite

isAllowLocalFilesystem