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

java.lang.Object
- oracle.pgx.config.PgxConfigBuilder

@Generated(value={"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"})
public final class PgxConfigBuilder
extends java.lang.Object

Builder for PgxConfig.

Constructor Summary

Constructors
Constructor and Description
`PgxConfigBuilder()` Constructs an empty PgxConfigBuilder
`PgxConfigBuilder(java.util.Map<PgxConfig.Field,java.lang.Object> values)` Constructs a PgxConfigBuilder initialized with the values from the given map
`PgxConfigBuilder(PgxConfig config)` Constructs a PgxConfigBuilder initialized with the values from the given config
`PgxConfigBuilder(PgxConfigBuilder builder)` Constructs a PgxConfigBuilder initialized with the values from the given builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PgxConfig`	`build()` Builds the PgxConfig with a `parentPath` of `null`.
`PgxConfig`	`build(java.lang.String parentPath)` Builds the PgxConfig.
`static PgxConfig`	`buildPgxConfig(java.util.function.Consumer<PgxConfigBuilder> builderSetup)` Builds a `PgxConfig` in-place
`PgxConfigBuilder`	`clear()` Clears all values from the builder
`java.util.Map<PgxConfig.Field,java.lang.Object>`	`getValues()`
`PgxConfigBuilder`	`putAll(java.util.Map<PgxConfig.Field,java.lang.Object> values)` Puts all values from the given map into this builder.
`PgxConfigBuilder`	`putAll(PgxConfig config)` Puts all values from the given config into this builder
`PgxConfigBuilder`	`setAdminRequestCacheTimeout(int adminRequestCacheTimeout)` after how many seconds admin request results get removed from the cache.
`PgxConfigBuilder`	`setAllowedRemoteLoadingLocations(java.lang.String... allowedRemoteLoadingLocations)` (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.
`PgxConfigBuilder`	`setAllowIdleTimeoutOverwrite(boolean allowIdleTimeoutOverwrite)` if `true`, sessions can overwrite default idle timeout
`PgxConfigBuilder`	`setAllowOverrideSchedulingInformation(boolean allowOverrideSchedulingInformation)` if `true` allow all users to override scheduling information like task weight, task priority and number of threads
`PgxConfigBuilder`	`setAllowTaskTimeoutOverwrite(boolean allowTaskTimeoutOverwrite)` if `true`, sessions can overwrite default task timeout
`PgxConfigBuilder`	`setAllowUserAutoRefresh(boolean allowUserAutoRefresh)` if `true` users may enable auto refresh for graphs they load.
`PgxConfigBuilder`	`setAuthorization(java.lang.Object... authorization)` mapping of users and roles to resources and permissions for authorization
`PgxConfigBuilder`	`setAuthorizationSessionCreateAllowAll(boolean authorizationSessionCreateAllowAll)` if `true` allow all users to create a PGX session regardless of permissions granted to them
`PgxConfigBuilder`	`setBasicSchedulerConfig(BasicSchedulerConfig basicSchedulerConfig)` configuration parameters for the fork join pool backend
`PgxConfigBuilder`	`setBasicSchedulerConfig(java.util.function.Consumer<BasicSchedulerConfigBuilder> basicSchedulerConfigBuilderSetup)` Builds a BasicSchedulerConfig in-place.
`PgxConfigBuilder`	`setBfsIterateQueTaskSize(int bfsIterateQueTaskSize)` task size for BFS iterate QUE phase
`PgxConfigBuilder`	`setBfsThresholdParentReadBased(double bfsThresholdParentReadBased)` threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
`PgxConfigBuilder`	`setBfsThresholdReadBased(int bfsThresholdReadBased)` threshold of BFS traversal level items above which to switch to read-based visiting strategy
`PgxConfigBuilder`	`setBfsThresholdSingleThreaded(int bfsThresholdSingleThreaded)` until what number of BFS traversal level items vertices are visited single-threaded
`PgxConfigBuilder`	`setCharacterSet(java.lang.String characterSet)` standard charset to use throughout PGX, UTF-8 will be used as default.
`PgxConfigBuilder`	`setCniDiffFactorDefault(int cniDiffFactorDefault)` default diff factor value used in the common neighbor iterator implementations.
`PgxConfigBuilder`	`setCniSmallDefault(int cniSmallDefault)` default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
`PgxConfigBuilder`	`setCniStopRecursionDefault(int cniStopRecursionDefault)` default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
`PgxConfigBuilder`	`setDfsThresholdLarge(int dfsThresholdLarge)` 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.
`PgxConfigBuilder`	`setEnableCsrfTokenChecks(boolean enableCsrfTokenChecks)` if true, the PGX webapp will verify CSRF token cookie and request parameters sent by the client exist and match.
`PgxConfigBuilder`	`setEnableGmCompiler(boolean enableGmCompiler)` if `true`, enable dynamic compilation of Green-Marl code during runtime
`PgxConfigBuilder`	`setEnableGraphLoadingCache(boolean enableGraphLoadingCache)` if `true`, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
`PgxConfigBuilder`	`setEnableShutdownCleanupHook(boolean enableShutdownCleanupHook)` if `true` PGX will add a JVM shutdown hook that will automatically shutdown PGX at JVM shutdown.
`PgxConfigBuilder`	`setEnterpriseSchedulerConfig(java.util.function.Consumer<EnterpriseSchedulerConfigBuilder> enterpriseSchedulerConfigBuilderSetup)` Builds a EnterpriseSchedulerConfig in-place.
`PgxConfigBuilder`	`setEnterpriseSchedulerConfig(EnterpriseSchedulerConfig enterpriseSchedulerConfig)` configuration parameters for the enterprise scheduler
`PgxConfigBuilder`	`setEnterpriseSchedulerFlags(java.util.function.Consumer<EnterpriseSchedulerFlagsConfigBuilder> enterpriseSchedulerFlagsBuilderSetup)` Builds a EnterpriseSchedulerFlagsConfig in-place.
`PgxConfigBuilder`	`setEnterpriseSchedulerFlags(EnterpriseSchedulerFlagsConfig enterpriseSchedulerFlags)` [relevant for `enterprise_scheduler`] enterprise scheduler specific settings.
`PgxConfigBuilder`	`setExplicitSpinLocks(boolean explicitSpinLocks)` `true` means spin explicitly in a loop until lock becomes available.
`PgxConfigBuilder`	`setFileLocations(java.lang.Object... fileLocations)` the file-locations that can be used in the authorization-config
`PgxConfigBuilder`	`setGraphAlgorithmLanguage(Compiler graphAlgorithmLanguage)` Frontend compiler to use.
`PgxConfigBuilder`	`setGraphValidationLevel(GraphValidationLevel graphValidationLevel)` level of validation performed on newly loaded or created graphs
`PgxConfigBuilder`	`setIgnoreIncompatibleBackendOperations(boolean ignoreIncompatibleBackendOperations)` if `true` only log when encountering incompatible operations and configuration values in RTS or FJ pool.
`PgxConfigBuilder`	`setInitPgqlOnStartup(boolean initPgqlOnStartup)` if `true` PGQL is directly initialized on start-up of PGX.
`PgxConfigBuilder`	`setInPlaceUpdateConsistencyModel(UpdateConsistencyModel inPlaceUpdateConsistencyModel)` Consistency model used when in-place updates occur.
`PgxConfigBuilder`	`setIntervalToPollMax(int intervalToPollMax)` Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
`PgxConfigBuilder`	`setJavaHomeDir(java.lang.String javaHomeDir)` The path to Java's home directory.
`PgxConfigBuilder`	`setLargeArrayThreshold(int largeArrayThreshold)` threshold when the size of an array is too big to use a normal Java array.
`PgxConfigBuilder`	`setLaunchWatchdogs(boolean launchWatchdogs)` (for debugging) if `true`, additional watch-dog threads will be launched which monitor and log engine health stats
`PgxConfigBuilder`	`setMaxActiveSessions(int maxActiveSessions)` the maximum number of sessions allowed to be active at a time
`PgxConfigBuilder`	`setMaxDistinctStringsPerPool(int maxDistinctStringsPerPool)` [only relevant if `string_pooling_strategy` is `indexed`] amount of distinct strings per property after which to stop pooling.
`PgxConfigBuilder`	`setMaxHttpClientRequestSize(long maxHttpClientRequestSize)` maximum size in bytes of any http request sent to to the PGX server over the REST API.
`PgxConfigBuilder`	`setMaxOffHeapSize(int maxOffHeapSize)` maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
`PgxConfigBuilder`	`setMaxQueueSizePerSession(int maxQueueSizePerSession)` the maximum number of pending tasks allowed to be in the queue, per session.
`PgxConfigBuilder`	`setMaxSnapshotCount(int maxSnapshotCount)` Number of snapshots that may be loaded in the engine at the same time.
`PgxConfigBuilder`	`setMemoryAllocator(MemoryAllocationStrategy memoryAllocator)` which memory allocator to use
`PgxConfigBuilder`	`setMemoryCleanupInterval(int memoryCleanupInterval)` memory cleanup tick in seconds
`PgxConfigBuilder`	`setMinArrayCompactionThreshold(double minArrayCompactionThreshold)` [only relevant for graphs optimized for updates] minimum value that can be used for the array_compaction_threshold value in graph configuration.
`PgxConfigBuilder`	`setMinFetchIntervalSec(int minFetchIntervalSec)` (only relevant if the graph format supports delta updates) for delta-refresh, the lowest interval at which a graph source is queried for changes.
`PgxConfigBuilder`	`setMinUpdateIntervalSec(int minUpdateIntervalSec)` 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).
`PgxConfigBuilder`	`setMsBfsFrontierTypeStrategy(FrontierTypeStrategy msBfsFrontierTypeStrategy)` the type strategy to use for MS-BFS frontiers
`PgxConfigBuilder`	`setNumSpinLocks(int numSpinLocks)` how many spin locks each generated app will create at instantiation.
`PgxConfigBuilder`	`setParallelism(int parallelism)` number of worker threads to be used in thread pool.
`PgxConfigBuilder`	`setPatternMatchingSupernodeCacheThreshold(int patternMatchingSupernodeCacheThreshold)` minimum number of a node's neighbor to be a supernode.
`PgxConfigBuilder`	`setPgxRealm(java.util.function.Consumer<RealmConfigBuilder> pgxRealmBuilderSetup)` Builds a RealmConfig in-place.
`PgxConfigBuilder`	`setPgxRealm(RealmConfig pgxRealm)` configuration parameters for the realm
`PgxConfigBuilder`	`setPoolingFactor(double poolingFactor)` [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
`PgxConfigBuilder`	`setPreloadGraphs(java.lang.Object... preloadGraphs)` list of graph configs to be registered at start-up.
`PgxConfigBuilder`	`setRandomGeneratorStrategy(RandomGeneratorStrategy randomGeneratorStrategy)` method of generating random numbers in pgx
`PgxConfigBuilder`	`setRandomSeed(long randomSeed)` [relevant for `deterministic` random number generator only] seed for the deterministic random number generator used in pgx.
`PgxConfigBuilder`	`setReleaseMemoryThreshold(double releaseMemoryThreshold)` threshold percentage of used memory after which the engine starts freeing un-used graphs.
`PgxConfigBuilder`	`setRevisitThreshold(int revisitThreshold)` maximum number of matched results from a node to be cached
`PgxConfigBuilder`	`setScheduler(SchedulerStrategy scheduler)` which scheduler to use.
`PgxConfigBuilder`	`setSessionIdleTimeoutSecs(int sessionIdleTimeoutSecs)` timeout of idling sessions in seconds.
`PgxConfigBuilder`	`setSessionTaskTimeoutSecs(int sessionTaskTimeoutSecs)` timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds.
`PgxConfigBuilder`	`setSmallTaskLength(int smallTaskLength)` task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
`PgxConfigBuilder`	`setStrictMode(boolean strictMode)` if `true`, exceptions are thrown and logged with `ERROR` level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors.
`PgxConfigBuilder`	`setStringPoolingStrategy(StringPoolingStrategy stringPoolingStrategy)` [only relevant if `use_string_pool` is enabled] which string pooling strategy to use
`PgxConfigBuilder`	`setTaskLength(int taskLength)` default task length (only relevant for task-stealing strategies).
`PgxConfigBuilder`	`setTmpDir(java.lang.String tmpDir)` Use this path as temporary directory to store compilation artifacts and other temporary data.
`PgxConfigBuilder`	`setUdfConfigDirectory(java.lang.String udfConfigDirectory)` directory path containing udf config files
`PgxConfigBuilder`	`setUNSAFEAllowForeignSyntax(boolean uNSAFEAllowForeignSyntax)` (This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
`PgxConfigBuilder`	`setUseMemoryMapperForReadingPgb(boolean useMemoryMapperForReadingPgb)` if `true`, use memory mapped files for reading graphs in PGB format if possible; `false` always use s stream based implementation
`PgxConfigBuilder`	`setUseMemoryMapperForStoringPgb(boolean useMemoryMapperForStoringPgb)` if `true`, use memory mapped files for storing in PGB format if possible; if `false` always use a stream based implementation
`java.io.InputStream`	`toInputStream()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - PgxConfigBuilder
```
public PgxConfigBuilder()
```
    Constructs an empty PgxConfigBuilder
  - PgxConfigBuilder
```
public PgxConfigBuilder(java.util.Map<PgxConfig.Field,java.lang.Object> values)
```
    Constructs a PgxConfigBuilder initialized with the values from the given map
    
    Parameters:
    
    values - a map containing configuration values
  - PgxConfigBuilder
```
public PgxConfigBuilder(PgxConfig config)
```
    Constructs a PgxConfigBuilder initialized with the values from the given config
    
    Parameters:
    
    config - the configuration to take the values from
  - PgxConfigBuilder
```
public PgxConfigBuilder(PgxConfigBuilder builder)
```
    Constructs a PgxConfigBuilder initialized with the values from the given builder
    
    Parameters:
    
    builder - the builder to take the values from
- Method Detail
  - build
```
public PgxConfig build()
```
    Builds the PgxConfig with a parentPath of null.
    
    Returns:
    
    An instance of PgxConfig
    
    See Also:
    
    build(String)
  - build
```
public PgxConfig build(java.lang.String parentPath)
```
    Builds the PgxConfig.
    
    Parameters:
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    an instance of PgxConfig
  - buildPgxConfig
```
public static PgxConfig buildPgxConfig(java.util.function.Consumer<PgxConfigBuilder> builderSetup)
```
    Builds a PgxConfig in-place
    
    Parameters:
    
    builderSetup - a consumer to setup a newly created PgxConfig
  - clear
```
public PgxConfigBuilder clear()
```
    Clears all values from the builder
  - getValues
```
public java.util.Map<PgxConfig.Field,java.lang.Object> getValues()
```
    Returns:
    
    the raw config values
  - putAll
```
public PgxConfigBuilder putAll(java.util.Map<PgxConfig.Field,java.lang.Object> values)
```
    Puts all values from the given map into this builder.
    
    Parameters:
    
    values - the values to put in the builder
  - putAll
```
public PgxConfigBuilder putAll(PgxConfig config)
```
    Puts all values from the given config into this builder
    
    Parameters:
    
    config - the config to take the values from
  - setAdminRequestCacheTimeout
```
public PgxConfigBuilder setAdminRequestCacheTimeout(int adminRequestCacheTimeout)
```
    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.
  - setAllowedRemoteLoadingLocations
```
public PgxConfigBuilder setAllowedRemoteLoadingLocations(java.lang.String... allowedRemoteLoadingLocations)
```
    (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
    
    Parameters:
    
    allowedRemoteLoadingLocations - use "https", "ftps", "s3", "hdfs" for specific locations, or "*" to allow loading from all remote locations.
  - setAllowIdleTimeoutOverwrite
```
public PgxConfigBuilder setAllowIdleTimeoutOverwrite(boolean allowIdleTimeoutOverwrite)
```
    if true, sessions can overwrite default idle timeout
  - setAllowOverrideSchedulingInformation
```
public PgxConfigBuilder setAllowOverrideSchedulingInformation(boolean allowOverrideSchedulingInformation)
```
    if true allow all users to override scheduling information like task weight, task priority and number of threads
  - setAllowTaskTimeoutOverwrite
```
public PgxConfigBuilder setAllowTaskTimeoutOverwrite(boolean allowTaskTimeoutOverwrite)
```
    if true, sessions can overwrite default task timeout
  - setAllowUserAutoRefresh
```
public PgxConfigBuilder setAllowUserAutoRefresh(boolean allowUserAutoRefresh)
```
    if true users may enable auto refresh for graphs they load. If false only graphs mentioned in preload_graphs can have auto refresh enabled
  - setAuthorization
```
public PgxConfigBuilder setAuthorization(java.lang.Object... authorization)
```
    mapping of users and roles to resources and permissions for authorization
    
    Parameters:
    
    authorization - mapping resource to permissions
  - setAuthorizationSessionCreateAllowAll
```
public PgxConfigBuilder setAuthorizationSessionCreateAllowAll(boolean authorizationSessionCreateAllowAll)
```
    if true allow all users to create a PGX session regardless of permissions granted to them
  - setBasicSchedulerConfig
```
public PgxConfigBuilder setBasicSchedulerConfig(BasicSchedulerConfig basicSchedulerConfig)
```
    configuration parameters for the fork join pool backend
  - setBasicSchedulerConfig
```
public PgxConfigBuilder setBasicSchedulerConfig(java.util.function.Consumer<BasicSchedulerConfigBuilder> basicSchedulerConfigBuilderSetup)
```
    Builds a BasicSchedulerConfig in-place. configuration parameters for the fork join pool backend
    
    Parameters:
    
    basicSchedulerConfigBuilderSetup - a consumer to setup a newly created BasicSchedulerConfigBuilder
    
    See Also:
    
    BasicSchedulerConfigBuilder
  - setBfsIterateQueTaskSize
```
public PgxConfigBuilder setBfsIterateQueTaskSize(int bfsIterateQueTaskSize)
```
    task size for BFS iterate QUE phase
  - setBfsThresholdParentReadBased
```
public PgxConfigBuilder setBfsThresholdParentReadBased(double bfsThresholdParentReadBased)
```
    threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
  - setBfsThresholdReadBased
```
public PgxConfigBuilder setBfsThresholdReadBased(int bfsThresholdReadBased)
```
    threshold of BFS traversal level items above which to switch to read-based visiting strategy
  - setBfsThresholdSingleThreaded
```
public PgxConfigBuilder setBfsThresholdSingleThreaded(int bfsThresholdSingleThreaded)
```
    until what number of BFS traversal level items vertices are visited single-threaded
  - setCharacterSet
```
public PgxConfigBuilder setCharacterSet(java.lang.String characterSet)
```
    standard charset to use throughout PGX, UTF-8 will be used as default. Note: Some formats may not be compatible.
  - setCniDiffFactorDefault
```
public PgxConfigBuilder setCniDiffFactorDefault(int cniDiffFactorDefault)
```
    default diff factor value used in the common neighbor iterator implementations.
  - setCniSmallDefault
```
public PgxConfigBuilder setCniSmallDefault(int cniSmallDefault)
```
    default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
  - setCniStopRecursionDefault
```
public PgxConfigBuilder setCniStopRecursionDefault(int cniStopRecursionDefault)
```
    default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
  - setDfsThresholdLarge
```
public PgxConfigBuilder setDfsThresholdLarge(int dfsThresholdLarge)
```
    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.
  - setEnableCsrfTokenChecks
```
public PgxConfigBuilder setEnableCsrfTokenChecks(boolean enableCsrfTokenChecks)
```
    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.
  - setEnableGmCompiler
```
public PgxConfigBuilder setEnableGmCompiler(boolean enableGmCompiler)
```
    if true, enable dynamic compilation of Green-Marl code during runtime
  - setEnableGraphLoadingCache
```
public PgxConfigBuilder setEnableGraphLoadingCache(boolean enableGraphLoadingCache)
```
    if true, activate the graph loading cache that will accelerate loading of graphs that were previously loaded (can only be disabled in embedded mode)
  - setEnableShutdownCleanupHook
```
public PgxConfigBuilder setEnableShutdownCleanupHook(boolean enableShutdownCleanupHook)
```
    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.
  - setEnterpriseSchedulerConfig
```
public PgxConfigBuilder setEnterpriseSchedulerConfig(java.util.function.Consumer<EnterpriseSchedulerConfigBuilder> enterpriseSchedulerConfigBuilderSetup)
```
    Builds a EnterpriseSchedulerConfig in-place. configuration parameters for the enterprise scheduler
    
    Parameters:
    
    enterpriseSchedulerConfigBuilderSetup - a consumer to setup a newly created EnterpriseSchedulerConfigBuilder
    
    See Also:
    
    EnterpriseSchedulerConfigBuilder
  - setEnterpriseSchedulerConfig
```
public PgxConfigBuilder setEnterpriseSchedulerConfig(EnterpriseSchedulerConfig enterpriseSchedulerConfig)
```
    configuration parameters for the enterprise scheduler
  - setEnterpriseSchedulerFlags
```
public PgxConfigBuilder setEnterpriseSchedulerFlags(java.util.function.Consumer<EnterpriseSchedulerFlagsConfigBuilder> enterpriseSchedulerFlagsBuilderSetup)
```
    Builds a EnterpriseSchedulerFlagsConfig in-place. [relevant for enterprise_scheduler] enterprise scheduler specific settings.
    
    Parameters:
    
    enterpriseSchedulerFlagsBuilderSetup - a consumer to setup a newly created EnterpriseSchedulerFlagsConfigBuilder
    
    See Also:
    
    EnterpriseSchedulerFlagsConfigBuilder
  - setEnterpriseSchedulerFlags
```
public PgxConfigBuilder setEnterpriseSchedulerFlags(EnterpriseSchedulerFlagsConfig enterpriseSchedulerFlags)
```
    [relevant for enterprise_scheduler] enterprise scheduler specific settings.
  - setExplicitSpinLocks
```
public PgxConfigBuilder setExplicitSpinLocks(boolean explicitSpinLocks)
```
    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.
  - setFileLocations
```
public PgxConfigBuilder setFileLocations(java.lang.Object... fileLocations)
```
    the file-locations that can be used in the authorization-config
    
    Parameters:
    
    fileLocations - definition of a file-location
  - setGraphAlgorithmLanguage
```
public PgxConfigBuilder setGraphAlgorithmLanguage(Compiler graphAlgorithmLanguage)
```
    Frontend compiler to use.
  - setGraphValidationLevel
```
public PgxConfigBuilder setGraphValidationLevel(GraphValidationLevel graphValidationLevel)
```
    level of validation performed on newly loaded or created graphs
  - setIgnoreIncompatibleBackendOperations
```
public PgxConfigBuilder setIgnoreIncompatibleBackendOperations(boolean ignoreIncompatibleBackendOperations)
```
    if true only log when encountering incompatible operations and configuration values in RTS or FJ pool. If false throw exceptions
  - setInitPgqlOnStartup
```
public PgxConfigBuilder setInitPgqlOnStartup(boolean initPgqlOnStartup)
```
    if true PGQL is directly initialized on start-up of PGX. Otherwise, it is initialized during the first use of PGQL.
  - setInPlaceUpdateConsistencyModel
```
public PgxConfigBuilder setInPlaceUpdateConsistencyModel(UpdateConsistencyModel inPlaceUpdateConsistencyModel)
```
    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.
  - setIntervalToPollMax
```
public PgxConfigBuilder setIntervalToPollMax(int intervalToPollMax)
```
    Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
  - setJavaHomeDir
```
public PgxConfigBuilder setJavaHomeDir(java.lang.String javaHomeDir)
```
    The path to Java's home directory. If set to <system-java-home-dir>, use the java.home system property.
  - setLargeArrayThreshold
```
public PgxConfigBuilder setLargeArrayThreshold(int largeArrayThreshold)
```
    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)
  - setLaunchWatchdogs
```
public PgxConfigBuilder setLaunchWatchdogs(boolean launchWatchdogs)
```
    (for debugging) if true, additional watch-dog threads will be launched which monitor and log engine health stats
  - setMaxActiveSessions
```
public PgxConfigBuilder setMaxActiveSessions(int maxActiveSessions)
```
    the maximum number of sessions allowed to be active at a time
  - setMaxDistinctStringsPerPool
```
public PgxConfigBuilder setMaxDistinctStringsPerPool(int maxDistinctStringsPerPool)
```
    [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
  - setMaxHttpClientRequestSize
```
public PgxConfigBuilder setMaxHttpClientRequestSize(long maxHttpClientRequestSize)
```
    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.
  - setMaxOffHeapSize
```
public PgxConfigBuilder setMaxOffHeapSize(int maxOffHeapSize)
```
    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.
  - setMaxQueueSizePerSession
```
public PgxConfigBuilder setMaxQueueSizePerSession(int maxQueueSizePerSession)
```
    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.
  - setMaxSnapshotCount
```
public PgxConfigBuilder setMaxSnapshotCount(int maxSnapshotCount)
```
    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.
  - setMemoryAllocator
```
public PgxConfigBuilder setMemoryAllocator(MemoryAllocationStrategy memoryAllocator)
```
    which memory allocator to use
  - setMemoryCleanupInterval
```
public PgxConfigBuilder setMemoryCleanupInterval(int memoryCleanupInterval)
```
    memory cleanup tick in seconds
  - setMinArrayCompactionThreshold
```
public PgxConfigBuilder setMinArrayCompactionThreshold(double minArrayCompactionThreshold)
```
    [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
  - setMinFetchIntervalSec
```
public PgxConfigBuilder setMinFetchIntervalSec(int minFetchIntervalSec)
```
    (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.
  - setMinUpdateIntervalSec
```
public PgxConfigBuilder setMinUpdateIntervalSec(int minUpdateIntervalSec)
```
    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.
  - setMsBfsFrontierTypeStrategy
```
public PgxConfigBuilder setMsBfsFrontierTypeStrategy(FrontierTypeStrategy msBfsFrontierTypeStrategy)
```
    the type strategy to use for MS-BFS frontiers
  - setNumSpinLocks
```
public PgxConfigBuilder setNumSpinLocks(int numSpinLocks)
```
    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)
  - setParallelism
```
public PgxConfigBuilder setParallelism(int 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.
  - setPatternMatchingSupernodeCacheThreshold
```
public PgxConfigBuilder setPatternMatchingSupernodeCacheThreshold(int patternMatchingSupernodeCacheThreshold)
```
    minimum number of a node's neighbor to be a supernode. This is for pattern matching engine.
  - setPgxRealm
```
public PgxConfigBuilder setPgxRealm(java.util.function.Consumer<RealmConfigBuilder> pgxRealmBuilderSetup)
```
    Builds a RealmConfig in-place. configuration parameters for the realm
    
    Parameters:
    
    pgxRealmBuilderSetup - a consumer to setup a newly created RealmConfigBuilder
    
    See Also:
    
    RealmConfigBuilder
  - setPgxRealm
```
public PgxConfigBuilder setPgxRealm(RealmConfig pgxRealm)
```
    configuration parameters for the realm
  - setPoolingFactor
```
public PgxConfigBuilder setPoolingFactor(double poolingFactor)
```
    [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
  - setPreloadGraphs
```
public PgxConfigBuilder setPreloadGraphs(java.lang.Object... preloadGraphs)
```
    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.
    
    Parameters:
    
    preloadGraphs - configuration parameters for the preloaded graph
  - setRandomGeneratorStrategy
```
public PgxConfigBuilder setRandomGeneratorStrategy(RandomGeneratorStrategy randomGeneratorStrategy)
```
    method of generating random numbers in pgx
  - setRandomSeed
```
public PgxConfigBuilder setRandomSeed(long randomSeed)
```
    [relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx. The default is -24466691093057031
  - setReleaseMemoryThreshold
```
public PgxConfigBuilder setReleaseMemoryThreshold(double releaseMemoryThreshold)
```
    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.
  - setRevisitThreshold
```
public PgxConfigBuilder setRevisitThreshold(int revisitThreshold)
```
    maximum number of matched results from a node to be cached
  - setScheduler
```
public PgxConfigBuilder setScheduler(SchedulerStrategy 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
  - setSessionIdleTimeoutSecs
```
public PgxConfigBuilder setSessionIdleTimeoutSecs(int sessionIdleTimeoutSecs)
```
    timeout of idling sessions in seconds. Set to zero for infinity/no timeout
  - setSessionTaskTimeoutSecs
```
public PgxConfigBuilder setSessionTaskTimeoutSecs(int sessionTaskTimeoutSecs)
```
    timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds. Set to zero for infinity/no timeout
  - setSmallTaskLength
```
public PgxConfigBuilder setSmallTaskLength(int smallTaskLength)
```
    task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
  - setStrictMode
```
public PgxConfigBuilder setStrictMode(boolean strictMode)
```
    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.
  - setStringPoolingStrategy
```
public PgxConfigBuilder setStringPoolingStrategy(StringPoolingStrategy stringPoolingStrategy)
```
    [only relevant if use_string_pool is enabled] which string pooling strategy to use
  - setTaskLength
```
public PgxConfigBuilder setTaskLength(int taskLength)
```
    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
  - setTmpDir
```
public PgxConfigBuilder setTmpDir(java.lang.String tmpDir)
```
    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)
  - setUdfConfigDirectory
```
public PgxConfigBuilder setUdfConfigDirectory(java.lang.String udfConfigDirectory)
```
    directory path containing udf config files
  - setUNSAFEAllowForeignSyntax
```
public PgxConfigBuilder setUNSAFEAllowForeignSyntax(boolean uNSAFEAllowForeignSyntax)
```
    (This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
  - setUseMemoryMapperForReadingPgb
```
public PgxConfigBuilder setUseMemoryMapperForReadingPgb(boolean useMemoryMapperForReadingPgb)
```
    if true, use memory mapped files for reading graphs in PGB format if possible; false always use s stream based implementation
  - setUseMemoryMapperForStoringPgb
```
public PgxConfigBuilder setUseMemoryMapperForStoringPgb(boolean useMemoryMapperForStoringPgb)
```
    if true, use memory mapped files for storing in PGB format if possible; if false always use a stream based implementation
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    Returns:
    
    an InputStream representing the config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PgxConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PgxConfigBuilder

PgxConfigBuilder

PgxConfigBuilder

PgxConfigBuilder

Method Detail

build

build

buildPgxConfig

clear

getValues

putAll

putAll

setAdminRequestCacheTimeout

setAllowedRemoteLoadingLocations

setAllowIdleTimeoutOverwrite

setAllowOverrideSchedulingInformation

setAllowTaskTimeoutOverwrite

setAllowUserAutoRefresh

setAuthorization

setAuthorizationSessionCreateAllowAll

setBasicSchedulerConfig

setBasicSchedulerConfig

setBfsIterateQueTaskSize

setBfsThresholdParentReadBased

setBfsThresholdReadBased

setBfsThresholdSingleThreaded

setCharacterSet

setCniDiffFactorDefault

setCniSmallDefault

setCniStopRecursionDefault

setDfsThresholdLarge

setEnableCsrfTokenChecks

setEnableGmCompiler

setEnableGraphLoadingCache

setEnableShutdownCleanupHook

setEnterpriseSchedulerConfig

setEnterpriseSchedulerConfig

setEnterpriseSchedulerFlags

setEnterpriseSchedulerFlags

setExplicitSpinLocks

setFileLocations

setGraphAlgorithmLanguage

setGraphValidationLevel

setIgnoreIncompatibleBackendOperations

setInitPgqlOnStartup

setInPlaceUpdateConsistencyModel

setIntervalToPollMax

setJavaHomeDir

setLargeArrayThreshold

setLaunchWatchdogs

setMaxActiveSessions

setMaxDistinctStringsPerPool

setMaxHttpClientRequestSize

setMaxOffHeapSize

setMaxQueueSizePerSession

setMaxSnapshotCount

setMemoryAllocator

setMemoryCleanupInterval

setMinArrayCompactionThreshold

setMinFetchIntervalSec

setMinUpdateIntervalSec

setMsBfsFrontierTypeStrategy

setNumSpinLocks

setParallelism

setPatternMatchingSupernodeCacheThreshold

setPgxRealm

setPgxRealm

setPoolingFactor

setPreloadGraphs

setRandomGeneratorStrategy

setRandomSeed

setReleaseMemoryThreshold

setRevisitThreshold

setScheduler

setSessionIdleTimeoutSecs