Uses of Class
oracle.pgx.config.PgxConfigBuilder

Packages that use PgxConfigBuilder

Package	Description
oracle.pgx.config	This package contains all configuration-related classes of PGX.

Uses of PgxConfigBuilder in oracle.pgx.config

Methods in oracle.pgx.config that return PgxConfigBuilder

Modifier and Type	Method and Description
PgxConfigBuilder	PgxConfigBuilder.clear() Clears all values from the builder
PgxConfigBuilder	PgxConfigBuilder.putAll(java.util.Map<PgxConfig.Field,java.lang.Object> values) Puts all values from the given map into this builder.
PgxConfigBuilder	PgxConfigBuilder.putAll(PgxConfig config) Puts all values from the given config into this builder
PgxConfigBuilder	PgxConfigBuilder.setAdminRequestCacheTimeout(int adminRequestCacheTimeout) after how many seconds admin request results get removed from the cache.
PgxConfigBuilder	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	PgxConfigBuilder.setAllowIdleTimeoutOverwrite(boolean allowIdleTimeoutOverwrite) if true, sessions can overwrite default idle timeout
PgxConfigBuilder	PgxConfigBuilder.setAllowOverrideSchedulingInformation(boolean allowOverrideSchedulingInformation) if true allow all users to override scheduling information like task weight, task priority and number of threads
PgxConfigBuilder	PgxConfigBuilder.setAllowTaskTimeoutOverwrite(boolean allowTaskTimeoutOverwrite) if true, sessions can overwrite default task timeout
PgxConfigBuilder	PgxConfigBuilder.setAllowUserAutoRefresh(boolean allowUserAutoRefresh) if true users may enable auto refresh for graphs they load.
PgxConfigBuilder	PgxConfigBuilder.setAuthorization(java.util.List<?> authorization) mapping of users and roles to resources and permissions for authorization
PgxConfigBuilder	PgxConfigBuilder.setAuthorization(java.lang.Object... authorization) mapping of users and roles to resources and permissions for authorization
PgxConfigBuilder	PgxConfigBuilder.setAuthorizationSessionCreateAllowAll(boolean authorizationSessionCreateAllowAll) if true allow all users to create a PGX session regardless of permissions granted to them
PgxConfigBuilder	PgxConfigBuilder.setBackendWrapper(java.lang.String backendWrapper) Only for internal use.
PgxConfigBuilder	PgxConfigBuilder.setBasicSchedulerConfig(BasicSchedulerConfig basicSchedulerConfig) configuration parameters for the fork join pool backend
PgxConfigBuilder	PgxConfigBuilder.setBasicSchedulerConfig(java.util.function.Consumer<BasicSchedulerConfigBuilder> basicSchedulerConfigBuilderSetup) Builds a BasicSchedulerConfig in-place.
PgxConfigBuilder	PgxConfigBuilder.setBfsIterateQueTaskSize(int bfsIterateQueTaskSize) task size for BFS iterate QUE phase
PgxConfigBuilder	PgxConfigBuilder.setBfsThresholdParentReadBased(double bfsThresholdParentReadBased) threshold of BFS traversal level items above which to switch to parent-read-based visiting strategy
PgxConfigBuilder	PgxConfigBuilder.setBfsThresholdReadBased(int bfsThresholdReadBased) threshold of BFS traversal level items above which to switch to read-based visiting strategy
PgxConfigBuilder	PgxConfigBuilder.setBfsThresholdSingleThreaded(int bfsThresholdSingleThreaded) until what number of BFS traversal level items vertices are visited single-threaded
PgxConfigBuilder	PgxConfigBuilder.setBuiltinsPath(java.lang.String builtinsPath) Path to the builtin algorithms directory.
PgxConfigBuilder	PgxConfigBuilder.setCharacterSet(java.lang.String characterSet) standard charset to use throughout PGX, UTF-8 will be used as default.
PgxConfigBuilder	PgxConfigBuilder.setCniDiffFactorDefault(int cniDiffFactorDefault) default diff factor value used in the common neighbor iterator implementations.
PgxConfigBuilder	PgxConfigBuilder.setCniSmallDefault(int cniSmallDefault) default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
PgxConfigBuilder	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	PgxConfigBuilder.setCommonLogConfigure(java.lang.String commonLogConfigure) Path to a log configuration in Log4j2 (version 2) syntax.
PgxConfigBuilder	PgxConfigBuilder.setDataMemoryLimits(java.util.function.Consumer<DataMemoryLimitsConfigBuilder> dataMemoryLimitsBuilderSetup) Builds a DataMemoryLimitsConfig in-place.
PgxConfigBuilder	PgxConfigBuilder.setDataMemoryLimits(DataMemoryLimitsConfig dataMemoryLimits) memory limits configuration parameters
PgxConfigBuilder	PgxConfigBuilder.setDebugServer(java.lang.String debugServer) Hostname of the debug server.
PgxConfigBuilder	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	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	PgxConfigBuilder.setEnableGmCompiler(boolean enableGmCompiler) if true, enable dynamic compilation of Green-Marl code during runtime
PgxConfigBuilder	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	PgxConfigBuilder.setEnableMemoryLimitsChecks(boolean enableMemoryLimitsChecks) if true, PGX will enforce the configured memory limits
PgxConfigBuilder	PgxConfigBuilder.setEnableSecureHandshake(boolean enableSecureHandshake) if true PGX will use TLS-PSK to establish RPC channels between remote backend processes in the cluster
PgxConfigBuilder	PgxConfigBuilder.setEnableShutdownCleanupHook(boolean enableShutdownCleanupHook) if true PGX will add a JVM shutdown hook that will automatically shutdown PGX at JVM shutdown.
PgxConfigBuilder	PgxConfigBuilder.setEnterpriseSchedulerConfig(java.util.function.Consumer<EnterpriseSchedulerConfigBuilder> enterpriseSchedulerConfigBuilderSetup) Builds a EnterpriseSchedulerConfig in-place.
PgxConfigBuilder	PgxConfigBuilder.setEnterpriseSchedulerConfig(EnterpriseSchedulerConfig enterpriseSchedulerConfig) configuration parameters for the enterprise scheduler
PgxConfigBuilder	PgxConfigBuilder.setEnterpriseSchedulerFlags(java.util.function.Consumer<EnterpriseSchedulerFlagsConfigBuilder> enterpriseSchedulerFlagsBuilderSetup) Builds a EnterpriseSchedulerFlagsConfig in-place.
PgxConfigBuilder	PgxConfigBuilder.setEnterpriseSchedulerFlags(EnterpriseSchedulerFlagsConfig enterpriseSchedulerFlags) [relevant for enterprise_scheduler] enterprise scheduler specific settings.
PgxConfigBuilder	PgxConfigBuilder.setExecutablePath(java.lang.String executablePath) Path to the PGX.D executable.
PgxConfigBuilder	PgxConfigBuilder.setExistingHostnames(java.lang.String... existingHostnames) A list of names or IP addresses of hosts that are already part of an existing PGX.D cluster.
PgxConfigBuilder	PgxConfigBuilder.setExplicitSpinLocks(boolean explicitSpinLocks) true means spin explicitly in a loop until lock becomes available.
PgxConfigBuilder	PgxConfigBuilder.setFileLocations(java.util.List<?> fileLocations) the file-locations that can be used in the authorization-config
PgxConfigBuilder	PgxConfigBuilder.setFileLocations(java.lang.Object... fileLocations) the file-locations that can be used in the authorization-config
PgxConfigBuilder	PgxConfigBuilder.setGhostMaxNodeCounts(int ghostMaxNodeCounts) The maximum number of ghost vertices for each graph.
PgxConfigBuilder	PgxConfigBuilder.setGhostMinNeighbors(int ghostMinNeighbors) The minimum number of neighbors a vertex must have in order to be made a ghost (which is a vertex replicated on every machine).
PgxConfigBuilder	PgxConfigBuilder.setGraphAlgorithmLanguage(Compiler graphAlgorithmLanguage) Frontend compiler to use.
PgxConfigBuilder	PgxConfigBuilder.setGraphValidationLevel(GraphValidationLevel graphValidationLevel) level of validation performed on newly loaded or created graphs
PgxConfigBuilder	PgxConfigBuilder.setHandshakePort(int handshakePort) a TCP port which will be used for handshaking of distributed backend processes.
PgxConfigBuilder	PgxConfigBuilder.setHostnames(java.lang.String... hostnames) A list of names or IP addresses of hosts which should be involved in initial bootstrapping of a PGX.D cluster.
PgxConfigBuilder	PgxConfigBuilder.setIfEthernet(java.lang.String ifEthernet) IP network interface, used to initialize the network transport layer when using IP (Internet Protocol).
PgxConfigBuilder	PgxConfigBuilder.setIfInfiniband(java.lang.String ifInfiniband) InfiniBand network interface, used to initialize the network transport layer when using InfiniBand.
PgxConfigBuilder	PgxConfigBuilder.setIgnoreIncompatibleBackendOperations(boolean ignoreIncompatibleBackendOperations) if true only log when encountering incompatible operations and configuration values in RTS or FJ pool.
PgxConfigBuilder	PgxConfigBuilder.setInitPgqlOnStartup(boolean initPgqlOnStartup) if true PGQL is directly initialized on start-up of PGX.
PgxConfigBuilder	PgxConfigBuilder.setInPlaceUpdateConsistencyModel(UpdateConsistencyModel inPlaceUpdateConsistencyModel) Consistency model used when in-place updates occur.
PgxConfigBuilder	PgxConfigBuilder.setInstanceName(java.lang.String instanceName) Instance name sent as label to debug server.
PgxConfigBuilder	PgxConfigBuilder.setIntervalToPollMax(int intervalToPollMax) Exponential backoff upper bound (in ms) to which -once reached, the job status polling interval is fixed
PgxConfigBuilder	PgxConfigBuilder.setJavaClassPath(java.lang.String javaClassPath) Path to required java libraries.
PgxConfigBuilder	PgxConfigBuilder.setJavaHomeDir(java.lang.String javaHomeDir) The path to Java's home directory.
PgxConfigBuilder	PgxConfigBuilder.setLargeArrayThreshold(int largeArrayThreshold) threshold when the size of an array is too big to use a normal Java array.
PgxConfigBuilder	PgxConfigBuilder.setLargeBufCount(int largeBufCount) Number of large buffers populated in the pool.
PgxConfigBuilder	PgxConfigBuilder.setLargeBufSizeKb(int largeBufSizeKb) Size in kB of the large buffers.
PgxConfigBuilder	PgxConfigBuilder.setLaunchWatchdogs(boolean launchWatchdogs) (for debugging) if true, additional watch-dog threads will be launched which monitor and log engine health stats
PgxConfigBuilder	PgxConfigBuilder.setLogConfigure(java.lang.String logConfigure) Path to a log configuration in Log4j (version 1) syntax.
PgxConfigBuilder	PgxConfigBuilder.setLogStdRedirect(java.lang.String logStdRedirect) Path to a log file into which the standard output streams (stdout, stderr) of PGX.D backend should be redirected.
PgxConfigBuilder	PgxConfigBuilder.setMaxActiveSessions(int maxActiveSessions) the maximum number of sessions allowed to be active at a time
PgxConfigBuilder	PgxConfigBuilder.setMaxDistinctStringsPerPool(int maxDistinctStringsPerPool) [only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling.
PgxConfigBuilder	PgxConfigBuilder.setMaxHttpClientRequestSize(long maxHttpClientRequestSize) maximum size in bytes of any http request sent to to the PGX server over the REST API.
PgxConfigBuilder	PgxConfigBuilder.setMaxOffHeapSize(int maxOffHeapSize) maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
PgxConfigBuilder	PgxConfigBuilder.setMaxQueueSizePerSession(int maxQueueSizePerSession) the maximum number of pending tasks allowed to be in the queue, per session.
PgxConfigBuilder	PgxConfigBuilder.setMaxSnapshotCount(int maxSnapshotCount) Number of snapshots that may be loaded in the engine at the same time.
PgxConfigBuilder	PgxConfigBuilder.setMemoryAllocator(MemoryAllocationStrategy memoryAllocator) which memory allocator to use
PgxConfigBuilder	PgxConfigBuilder.setMemoryCleanupInterval(int memoryCleanupInterval) memory cleanup tick in seconds
PgxConfigBuilder	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	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	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	PgxConfigBuilder.setMsBfsFrontierTypeStrategy(FrontierTypeStrategy msBfsFrontierTypeStrategy) the type strategy to use for MS-BFS frontiers
PgxConfigBuilder	PgxConfigBuilder.setNumSpinLocks(int numSpinLocks) how many spin locks each generated app will create at instantiation.
PgxConfigBuilder	PgxConfigBuilder.setParallelism(int parallelism) number of worker threads to be used in thread pool.
PgxConfigBuilder	PgxConfigBuilder.setPartitioningIgnoreGhostnodes(boolean partitioningIgnoreGhostnodes) If set to true, the partitioning strategy will ignore the ghost nodes.
PgxConfigBuilder	PgxConfigBuilder.setPartitioningShuffleVertices(boolean partitioningShuffleVertices) If set to true, the vertices of the graph will be randomly shuffled among machines before partitioning.
PgxConfigBuilder	PgxConfigBuilder.setPartitioningStrategy(java.lang.String partitioningStrategy) Partitioning strategy of the vertices of the graph.
PgxConfigBuilder	PgxConfigBuilder.setPatternMatchingSupernodeCacheThreshold(int patternMatchingSupernodeCacheThreshold) minimum number of a node's neighbor to be a supernode.
PgxConfigBuilder	PgxConfigBuilder.setPgxRealm(java.util.function.Consumer<RealmConfigBuilder> pgxRealmBuilderSetup) Builds a RealmConfig in-place.
PgxConfigBuilder	PgxConfigBuilder.setPgxRealm(RealmConfig pgxRealm) configuration parameters for the realm
PgxConfigBuilder	PgxConfigBuilder.setPgxServerBaseUrl(java.lang.String pgxServerBaseUrl) should be used when deploying pgx server behind a load balancer to make clients before 21.3 backward compatible, the value should be set to the load balancer address
PgxConfigBuilder	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	PgxConfigBuilder.setPreloadGraphs(java.util.List<?> preloadGraphs) list of graph configs to be registered at start-up.
PgxConfigBuilder	PgxConfigBuilder.setPreloadGraphs(java.lang.Object... preloadGraphs) list of graph configs to be registered at start-up.
PgxConfigBuilder	PgxConfigBuilder.setProcId(int procId) Internal unique machine identifier in the cluster.
PgxConfigBuilder	PgxConfigBuilder.setRandomGeneratorStrategy(RandomGeneratorStrategy randomGeneratorStrategy) method of generating random numbers in pgx
PgxConfigBuilder	PgxConfigBuilder.setRandomSeed(long randomSeed) [relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx.
PgxConfigBuilder	PgxConfigBuilder.setReadinessMemoryUsageRatio(double readinessMemoryUsageRatio) memory limit ratio that should be considered to detect if PGX server is ready, used by isReady API, default value is 1.0
PgxConfigBuilder	PgxConfigBuilder.setReleaseMemoryThreshold(double releaseMemoryThreshold) threshold percentage of used memory after which the engine starts freeing un-used graphs.
PgxConfigBuilder	PgxConfigBuilder.setResourceMonitor(int resourceMonitor) Frequency at which to send resource statistics to the debug server, in ms.
PgxConfigBuilder	PgxConfigBuilder.setRevisitThreshold(int revisitThreshold) maximum number of matched results from a node to be cached
PgxConfigBuilder	PgxConfigBuilder.setRunningMemoryUsageRatio(double runningMemoryUsageRatio) memory limit ratio that should be considered to detect if PGX server is running, used by isRunning API default value is 1.0
PgxConfigBuilder	PgxConfigBuilder.setScheduler(SchedulerStrategy scheduler) which scheduler to use.
PgxConfigBuilder	PgxConfigBuilder.setSecureHandshakeSecretFile(java.lang.String secureHandshakeSecretFile) the file path of the secret in pkcs12 format.
PgxConfigBuilder	PgxConfigBuilder.setSessionIdleTimeoutSecs(int sessionIdleTimeoutSecs) timeout of idling sessions in seconds.
PgxConfigBuilder	PgxConfigBuilder.setSessionTaskTimeoutSecs(int sessionTaskTimeoutSecs) timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds.
PgxConfigBuilder	PgxConfigBuilder.setSmallTaskLength(int smallTaskLength) task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
PgxConfigBuilder	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	PgxConfigBuilder.setStringPoolingStrategy(StringPoolingStrategy stringPoolingStrategy) which string pooling strategy to use
PgxConfigBuilder	PgxConfigBuilder.setTaskLength(int taskLength) default task length (only relevant for task-stealing strategies).
PgxConfigBuilder	PgxConfigBuilder.setTmpDir(java.lang.String tmpDir) Use this path as temporary directory to store compilation artifacts and other temporary data.
PgxConfigBuilder	PgxConfigBuilder.setUdfConfigDirectory(java.lang.String udfConfigDirectory) directory path containing udf config files
PgxConfigBuilder	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	PgxConfigBuilder.setUseIndexForReachabilityQueries(ReachabilityIndexCreationMode useIndexForReachabilityQueries) create index for reachability queries
PgxConfigBuilder	PgxConfigBuilder.setUseInfiniband(boolean useInfiniband) If set to true, InfiniBand will be used.
PgxConfigBuilder	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	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

Method parameters in oracle.pgx.config with type arguments of type PgxConfigBuilder

Modifier and Type	Method and Description
static PgxConfig	PgxConfigBuilder.buildPgxConfig(java.util.function.Consumer<PgxConfigBuilder> builderSetup) Builds a PgxConfig in-place

Constructors in oracle.pgx.config with parameters of type PgxConfigBuilder

Constructor and Description
PgxConfigBuilder(PgxConfigBuilder builder) Constructs a PgxConfigBuilder initialized with the values from the given builder