Package oracle.pgx.api

This package contains the main Java APIs.

Interface Summary

Interface	Description
EdgeBuilder<VID>	An edge builder for defining edges added with the GraphBuilderImpl.
EdgeModifier<VID>
EntryIterable<ID,K extends PgxEntity<ID>,V>	Marker interface for an iterable over map entries.
GraphBuilder<VID>
GraphChangeSet<VID>
GraphDelta	Represents a delta since the last synchronization operation
GraphSource	Type of a source where a graph can be loaded from
IdBuilder<I,T extends IdBuilder.WithTableName<I,T>>	Builder for ID values.
IdBuilder.WithTableName<I,T extends IdBuilder.WithTableName<I,T>>	Builder for ID values for a specific table.
MapIterable<K,V>	Marker interface for an iterable over map entries.
Operation	An operation is part of an execution plan for executing a PGQL query.
PgqlResultSet	Result set of a pattern matching query.
PgxPath.PathIterable<E>
PgxPreparedStatement
PgxResult	A result of a pattern matching query.
SessionContext	Contains information describing a PgxSession instance
Synchronizer	Synchronizes changes in an external data source with a PGX graph.
VertexBuilder<VID>	A vertex builder for defining vertices added with the GraphBuilderImpl.
VertexModifier<VID>

Class Summary

Class	Description
AlgorithmProgress	Represents Algorithm progress state
AllPaths<ID>	The paths from one source vertex to all other vertices.
Analyst	The Analyst gives access to all built-in algorithms of PGX.
BipartiteGraph	A bipartite PgxGraph.
CompiledProgram	A compiled Green-Marl program.
ComponentCollection<ID>
DataListener
DefaultFutureProgress
Destroyable	Sub-classes of Destroyable can be explicitly destroyed
EdgeCollection	A collection of edges.
EdgeLabel
EdgeProperty<V>	An edge property of a PgxGraph.
EdgeProviderMetaData	Meta information about an edge provider in a PgxGraph.
EdgeSequence	An ordered sequence of edges which may contain duplicates.
EdgeSet	An unordered set of edges (no duplicates).
ElasticityController	A helper class that is able is call the elasticity-related endpoints for PGX.D.
EntityProviderMetaData	Meta information about an entity provider in a PgxGraph.
FlashbackSynchronizer	Synchronizes a PGX graph with an Oracle Database using Flashback queries
FutureProgress	Represents the progress PgxFuture execution
GraphBuilderImpl<VID>	A graph builder for constructing a PgxGraph.
GraphChangeSetImpl<VID>
GraphEntityCollection<E extends PgxEntity<ID>,ID>	A collection of vertices/edges.
GraphLoadingProgress
GraphMetaData	Meta information about PgxGraph.
MatrixFactorizationModel<ID>	Object that holds the state for repeatedly returning estimated ratings.
MergingStrategyBuilder
MutationStrategyBuilder<B extends MutationStrategyBuilder<B>>
NamedArgumentAnalyst
Namespace	Represents a namespace for objects (e.g.
Partition<ID>	A vertex partition of a graph.
PartitionedIdBuilder	A builder for partitioned IDs for a specific graph.
PartitionedIdBuilder.WithTableName	Builder stage for partitioned IDs for a specific entity provider.
PartitionedIdBuilderFactory	Factory for creating PartitionedIdBuilder instances, which can be used to build PartitionedIds.
PgqlResultElement	Type and variable name information on a pattern matching result element.
Pgx	Main entry point for PGX applications.
PgxCollection<E,ID>	Superclass for Pgx collections.
PgxEdge	An edge of a PgxGraph.
PgxEntity<ID>	An abstraction of vertex and edge.
PgxFuture<T>	A PGX-specific extension of CompletableFuture
PgxGraph	This class is a reference to a graph on the server side: operations on objects of this class are executed on the server side onto the referenced graph.
PgxManagedObject	A PGX managed object.
PgxMap<K,V>	A map is a collection of key-value pairs.
PgxPath<ID>	A path from a source to a destination vertex in a PgxGraph.
PgxPath.PathIterator<E>	A read-only ListIterator with an additional PgxPath.PathIterator.reset() method to start over iteration.
PgxSession	A PGX session represents an active user connected to a ServerInstance.
PgxVect<E>	A vector.
PgxVertex<ID>	A vertex of a PgxGraph.
PickingStrategyBuilder
Property<ID,K extends PgxEntity<ID>,V>	A property of a PgxGraph.
PropertyMetaData	Meta information about a property of a vertex/edge provider in a PgxGraph.
ResultImpl	A result of a pattern matching query.
Scalar<V>	A scalar value.
ScalarCollection<E>	A collection of scalars.
ScalarSequence<E>	An ordered sequence of scalars which may contain duplicates.
ScalarSet<E>	An unordered set of scalars that does not contain duplicates.
ServerInstance	A PGX server instance.
Synchronizer.Builder<T extends Synchronizer>	Builder class for Synchronizer objects.
VertexCollection<ID>	A collection of vertices.
VertexLabels<ID>
VertexProperty<ID,V>	A vertex property of a PgxGraph.
VertexProviderMetaData	Meta information about a vertex provider in a PgxGraph.
VertexSequence<ID>	An ordered sequence of vertices which may contain duplicates.
VertexSet<ID>	An unordered set of vertices (no duplicates).

Enum Summary

Enum	Description
DefaultFutureProgress.State
FutureProgress.FutureProgressType
GmCompilerOptimization	A list of Green-Marl compiler optimizations
PgqlResultElement.Type	Type of a result element.
PgxGraph.Degree	The degree.
PgxGraph.Mode	The mutation mode.
PgxGraph.MultiEdges	The multi-edges behavior.
PgxGraph.SelfEdges	The self-edges behavior.
PgxGraph.SortOrder	The direction.
PgxGraph.TrivialVertices	The trivial vertices behavior.
PoolType	An enum for the different thread-pools available within PGX.

Exception Summary

Exception	Description
CompileException	An exception indicating a compilation error on PGX side
MalformedProgramException	An exception thrown upon malformed program submission
MalformedQueryException	An exception thrown upon malformed query submission
PgxPgqlToSqlException