PgxSession (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.2.0 (E62127

java.lang.Object
- oracle.pgx.api.internal.ApiObject
- - oracle.pgx.api.Destroyable
  - - oracle.pgx.api.PgxManagedObject
    - - oracle.pgx.api.PgxSession

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class PgxSession
extends PgxManagedObject
```
A PGX session represents an active user connected to a ServerInstance. Every session gets a workspace assigned on the server, which can be used to read graph data, create transient data or custom algorithms for the sake of graph analysis. Once a session gets destroyed, all data in the session workspace gets freed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PgxFuture<oracle.pgx.api.CompiledProgram>`	`compileProgramCodeAsync(java.lang.String code)` Compiles a Green-Marl program for parallel execution with all optimizations enabled.
`PgxFuture<oracle.pgx.api.CompiledProgram>`	`compileProgramCodeAsync(java.lang.String code, boolean overwrite)` Compiles a Green-Marl program for parallel execution with all optimizations enabled.
`PgxFuture<oracle.pgx.api.CompiledProgram>`	`compileProgramCodeAsync(java.lang.String code, boolean overwrite, boolean parallel, java.util.List<oracle.pgx.api.GmCompilerOptimization> disabledOptimizations, boolean verbose)` Compiles a Green-Marl program.
`Analyst`	`createAnalyst()` Creates a new analyst.
`PgxFuture<GraphConfig>`	`describeGraphAsync(oracle.pgx.loaders.location.GraphLocation location)` Describes the graph contained in a given graph location
`GraphConfig`	`describeGraphFile(java.lang.String path)` Blocking version of `describeGraphFileAsync(String)`.
`GraphConfig`	`describeGraphFile(java.lang.String path, Format format)` Blocking version of `describeGraphFileAsync(String, Format)`.
`PgxFuture<GraphConfig>`	`describeGraphFileAsync(java.lang.String path)` Describes the graph contained in the file at the given path.
`PgxFuture<GraphConfig>`	`describeGraphFileAsync(java.lang.String path, Format format)` Describes the graph contained in the file at the given path.
`GraphConfig`	`describeGraphFiles(java.util.List<java.lang.String> filePaths)` Blocking version of `describeGraphFilesAsync(List)`.
`GraphConfig`	`describeGraphFiles(java.util.List<java.lang.String> filePaths, Format format)` Blocking version of `describeGraphFilesAsync(List, Format)`.
`java.util.Set<java.lang.String>`	`getAvailableCompiledProgramIds()` Blocking version of `getAvailableCompiledProgramIdsAsync()`.
`PgxFuture<java.util.Set<java.lang.String>>`	`getAvailableCompiledProgramIdsAsync()` Gets the set of available compiled program IDs.
`java.util.Deque<GraphMetaData>`	`getAvailableSnapshots(GraphConfig config)` Blocking version of `getAvailableSnapshotsAsync(GraphConfig)`.
`java.util.Deque<GraphMetaData>`	`getAvailableSnapshots(PgxGraph snapshot)` Blocking version of `getAvailableSnapshotsAsync(PgxGraph)`.
`PgxFuture<java.util.Deque<GraphMetaData>>`	`getAvailableSnapshotsAsync(GraphConfig config)` Gets a list of available in-memory snapshots of a graph described by a graph configuration.
`PgxFuture<java.util.Deque<GraphMetaData>>`	`getAvailableSnapshotsAsync(PgxGraph snapshot)` Gets a list of available in-memory snapshots of a given snapshot.
`oracle.pgx.api.CompiledProgram`	`getCompiledProgram(java.lang.String id)` Blocking version of `getCompiledProgramAsync(String)`.
`PgxFuture<oracle.pgx.api.CompiledProgram>`	`getCompiledProgramAsync(java.lang.String id)` Gets a compiled program by ID.
`ExecutionEnvironment`	`getExecutionEnvironment()` Gets the execution environment for this session.
`java.lang.String`	`getId()` Gets the session ID.
`java.lang.Long`	`getIdleTimeout()` Gets the idle timeout of this session.
`java.lang.String`	`getName()` Alias for `getId()`
`PatternMatchingSemantic`	`getPatternMatchingSemantic()`
`PgqlResultSet`	`getPgqlResultSet(java.lang.String id)` Blocking version of `getPgqlResultSetAsync(String)`.
`PgxFuture<PgqlResultSet>`	`getPgqlResultSetAsync(java.lang.String id)` Gets a PGQL result set by ID.
`ServerInstance`	`getServerInstance()` Gets the server instance.
`java.lang.String`	`getSource()` Gets the source.
`java.lang.Long`	`getTaskTimeout()` Gets the task timeout of this session.
`GraphBuilder<java.lang.Integer>`	`newGraphBuilder()` Creates a graph builder with integer vertex IDs
`<ID extends java.lang.Comparable<ID>> GraphBuilder<ID>`	`newGraphBuilder(IdType idType)` Creates a graph builder with the given vertex ID type
`PgxGraph`	`readGraphAsOf(GraphConfig config, GraphMetaData metaData)` Blocking version of `readGraphAsOfAsync(GraphConfig, GraphMetaData)`.
`PgxGraph`	`readGraphAsOf(GraphConfig config, GraphMetaData metaData, java.lang.String newGraphName)` Blocking version of `readGraphAsOfAsync(GraphConfig, GraphMetaData, String)`.
`PgxGraph`	`readGraphAsOf(GraphConfig config, long creationTimestamp)` Blocking version of `readGraphAsOfAsync(GraphConfig, long)`.
`PgxGraph`	`readGraphAsOf(GraphConfig config, long creationTimestamp, java.lang.String newGraphName)` Blocking version of `readGraphAsOfAsync(GraphConfig, long, String)`.
`PgxFuture<PgxGraph>`	`readGraphAsOfAsync(GraphConfig config, GraphMetaData metaData)` Reads a graph and its properties of a specific version (metaData) into memory.
`PgxFuture<PgxGraph>`	`readGraphAsOfAsync(GraphConfig config, GraphMetaData metaData, java.lang.String newGraphName)` Reads a graph and its properties of a specific version (metaData) into memory.
`PgxFuture<PgxGraph>`	`readGraphAsOfAsync(GraphConfig config, long creationTimestamp)` Reads a graph and its properties of a specific version (creationTimestamp) into memory.
`PgxFuture<PgxGraph>`	`readGraphAsOfAsync(GraphConfig config, long creationTimestamp, java.lang.String newGraphName)` Reads a graph and its properties of a specific version (creationTimestamp) into memory.
`PgxGraph`	`readGraphFile(java.lang.String path)` Blocking version of `readGraphFileAsync(String)`.
`PgxGraph`	`readGraphFile(java.lang.String path, Format format)` Blocking version of `readGraphFileAsync(String, Format)`.
`PgxGraph`	`readGraphFile(java.lang.String path, Format format, java.lang.String newGraphName)` Blocking version of `readGraphFileAsync(String, Format, String)`.
`PgxGraph`	`readGraphFile(java.lang.String path, java.lang.String newGraphName)` Blocking version of `readGraphFileAsync(String, String)`.
`PgxFuture<PgxGraph>`	`readGraphFileAsync(java.lang.String path)` Loads the graph contained in the file at the given path.
`PgxFuture<PgxGraph>`	`readGraphFileAsync(java.lang.String path, Format format)` Loads the graph contained in the file at the given path.
`PgxFuture<PgxGraph>`	`readGraphFileAsync(java.lang.String path, Format format, java.lang.String newGraphName)` Loads the graph contained in the files at the given path.
`PgxFuture<PgxGraph>`	`readGraphFileAsync(java.lang.String path, java.lang.String newGraphName)` Loads the graph contained in the file at the given path.
`PgxFuture<PgxGraph>`	`readGraphFilesAsync(java.util.List<java.lang.String> filePaths, Format format, java.lang.String newGraphName)` Loads the graph contained in the files at the given paths.
`PgxGraph`	`readGraphWithProperties(GraphConfig config)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig)`.
`PgxGraph`	`readGraphWithProperties(GraphConfig config, boolean updateIfNotFresh)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig, boolean)`.
`PgxGraph`	`readGraphWithProperties(GraphConfig config, boolean updateIfNotFresh, java.lang.String newGraphName)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig, boolean, String)`.
`PgxGraph`	`readGraphWithProperties(GraphConfig config, long maxAge, java.util.concurrent.TimeUnit maxAgeTimeUnit)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit)`.
`PgxGraph`	`readGraphWithProperties(GraphConfig config, long maxAge, java.util.concurrent.TimeUnit maxAgeTimeUnit, boolean blockIfFull, java.lang.String newGraphName)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit, boolean, String)`.
`PgxGraph`	`readGraphWithProperties(GraphConfig config, java.lang.String newGraphName)` Blocking version of `readGraphWithPropertiesAsync(GraphConfig, String)`.
`PgxGraph`	`readGraphWithProperties(java.lang.String path)` Blocking version of `readGraphWithPropertiesAsync(String)`.
`PgxGraph`	`readGraphWithProperties(java.lang.String path, java.lang.String newGraphName)` Blocking version of `readGraphWithPropertiesAsync(String, String)`.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config, boolean updateIfNotFresh)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config, boolean updateIfNotFresh, java.lang.String newGraphName)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config, long maxAge, java.util.concurrent.TimeUnit maxAgeTimeUnit)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config, long maxAge, java.util.concurrent.TimeUnit maxAgeTimeUnit, boolean blockIfFull, java.lang.String newGraphName)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(GraphConfig config, java.lang.String newGraphName)` Reads a graph and its properties, specified a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(java.lang.String path)` Reads a graph and its properties, specified by a path to a graph config, into memory.
`PgxFuture<PgxGraph>`	`readGraphWithPropertiesAsync(java.lang.String path, java.lang.String newGraphName)` Reads a graph and its properties, specified by a path to a graph config, into memory.
`void`	`setPatternMatchingSemantic(PatternMatchingSemantic patternMatchingSemantic)` Set the pattern matching semantic of the session.
`void`	`setSnapshot(PgxGraph graph, GraphMetaData metaData)` Blocking version of `setSnapshotAsync(PgxGraph, GraphMetaData)`.
`void`	`setSnapshot(PgxGraph graph, GraphMetaData metaData, boolean forceDeleteProperties)` Blocking version of `setSnapshotAsync(PgxGraph, GraphMetaData, boolean)`.
`void`	`setSnapshot(PgxGraph graph, long creationTimestamp)` Blocking version of `setSnapshotAsync(PgxGraph, long)`.
`void`	`setSnapshot(PgxGraph graph, long creationTimestamp, boolean forceDeleteProperties)` Blocking version of `setSnapshotAsync(PgxGraph, long, boolean)`.
`PgxFuture<java.lang.Void>`	`setSnapshotAsync(PgxGraph graph, GraphMetaData metaData)` Sets a graph to a specific snapshot.
`PgxFuture<java.lang.Void>`	`setSnapshotAsync(PgxGraph graph, GraphMetaData metaData, boolean forceDeleteTransientProperties)` Sets a graph to a specific snapshot.
`PgxFuture<java.lang.Void>`	`setSnapshotAsync(PgxGraph graph, long creationTimestamp)` Sets a graph to a specific snapshot.
`PgxFuture<java.lang.Void>`	`setSnapshotAsync(PgxGraph graph, long creationTimestamp, boolean forceDeleteTransientProperties)` Sets a graph to a specific snapshot.
`java.lang.String`	`toString()`

Methods inherited from class oracle.pgx.api.PgxManagedObject
equals, hashCode

Methods inherited from class oracle.pgx.api.Destroyable
close, destroy, destroyAsync

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

- Method Detail
  - compileProgramCodeAsync
```
public PgxFuture<oracle.pgx.api.CompiledProgram> compileProgramCodeAsync(java.lang.String code)
```
    Compiles a Green-Marl program for parallel execution with all optimizations enabled.
    
    Parameters:
    
    code - the Green-Marl code to compile
  - compileProgramCodeAsync
```
public PgxFuture<oracle.pgx.api.CompiledProgram> compileProgramCodeAsync(java.lang.String code,
                                                                         boolean overwrite)
```
    Compiles a Green-Marl program for parallel execution with all optimizations enabled.
    
    Parameters:
    
    code - the Green-Marl code to compile
    
    overwrite - if the procedure in the given code already exists, overwrite if true, throw an exception otherwise
  - compileProgramCodeAsync
```
public PgxFuture<oracle.pgx.api.CompiledProgram> compileProgramCodeAsync(java.lang.String code,
                                                                         boolean overwrite,
                                                                         boolean parallel,
                                                                         java.util.List<oracle.pgx.api.GmCompilerOptimization> disabledOptimizations,
                                                                         boolean verbose)
```
    Compiles a Green-Marl program.
    
    Parameters:
    
    code - the Green-Marl code to compile
    
    parallel - if false, the compiled program will be optimized for sequential execution
    
    disabledOptimizations - list of compiler optimizations to disable
    
    verbose - if true, the compiler will output compilation stages
  - createAnalyst
```
public Analyst createAnalyst()
```
    Creates a new analyst. The Analyst gives access to all built-in algorithms.
    
    Returns:
    
    the analyst
  - describeGraphAsync
```
public PgxFuture<GraphConfig> describeGraphAsync(oracle.pgx.loaders.location.GraphLocation location)
```
    Describes the graph contained in a given graph location
    PGX will try to detect the graph configuration. If the configuration cannot be determined or if the graph format does not match the given format, the future is completed exceptionally.
    
    Parameters:
    
    location - the graph location
    
    Returns:
    
    configuration which can be used to load the graph
  - describeGraphFile
```
public GraphConfig describeGraphFile(java.lang.String path)
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException
```
    Blocking version of describeGraphFileAsync(String). Calls describeGraphFileAsync(String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - describeGraphFile
```
public GraphConfig describeGraphFile(java.lang.String path,
                                     Format format)
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException
```
    Blocking version of describeGraphFileAsync(String, Format). Calls describeGraphFileAsync(String, Format) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - describeGraphFileAsync
```
public PgxFuture<GraphConfig> describeGraphFileAsync(java.lang.String path)
```
    Describes the graph contained in the file at the given path.
    PGX will try to detect the file format and the graph configuration. If the format or the configuration cannot be determined, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    Returns:
    
    configuration which can be used to load the graph
  - describeGraphFileAsync
```
public PgxFuture<GraphConfig> describeGraphFileAsync(java.lang.String path,
                                                     Format format)
```
    Describes the graph contained in the file at the given path.
    PGX will try to detect the graph configuration. If the configuration cannot be determined or if the file format does not match the given format, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    format - file format
    
    Returns:
    
    configuration which can be used to load the graph
  - describeGraphFiles
```
public GraphConfig describeGraphFiles(java.util.List<java.lang.String> filePaths)
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException
```
    Blocking version of describeGraphFilesAsync(List). Calls describeGraphFilesAsync(List) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - describeGraphFiles
```
public GraphConfig describeGraphFiles(java.util.List<java.lang.String> filePaths,
                                      Format format)
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException
```
    Blocking version of describeGraphFilesAsync(List, Format). Calls describeGraphFilesAsync(List, Format) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getAvailableCompiledProgramIds
```
public java.util.Set<java.lang.String> getAvailableCompiledProgramIds()
                                                               throws java.util.concurrent.ExecutionException,
                                                                      java.lang.InterruptedException
```
    Blocking version of getAvailableCompiledProgramIdsAsync(). Calls getAvailableCompiledProgramIdsAsync() and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getAvailableCompiledProgramIdsAsync
```
public PgxFuture<java.util.Set<java.lang.String>> getAvailableCompiledProgramIdsAsync()
```
    Gets the set of available compiled program IDs.
    
    Returns:
    
    the set of available compiled program IDs.
  - getAvailableSnapshots
```
public java.util.Deque<GraphMetaData> getAvailableSnapshots(GraphConfig config)
                                                     throws java.lang.InterruptedException,
                                                            java.util.concurrent.ExecutionException
```
    Blocking version of getAvailableSnapshotsAsync(GraphConfig). Calls getAvailableSnapshotsAsync(GraphConfig) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getAvailableSnapshots
```
public java.util.Deque<GraphMetaData> getAvailableSnapshots(PgxGraph snapshot)
                                                     throws java.lang.InterruptedException,
                                                            java.util.concurrent.ExecutionException
```
    Blocking version of getAvailableSnapshotsAsync(PgxGraph). Calls getAvailableSnapshotsAsync(PgxGraph) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getAvailableSnapshotsAsync
```
public PgxFuture<java.util.Deque<GraphMetaData>> getAvailableSnapshotsAsync(GraphConfig config)
```
    Gets a list of available in-memory snapshots of a graph described by a graph configuration. Note that only persistent graphs (graphs with a graph config pointing to a data source) might have more than one in-memory snapshot. If the given graph name is a transient (private, session-bound) graph, this method will return a list with the given graph as only element. See PgxGraph.isTransient().
    
    Returns:
    
    A list of graph meta data objects, each belonging to a snapshot of the given graph currently loaded into memory. The list is descending ordered by the GraphMetaData.getCreationTimestamp() value (milliseconds since Jan 1st 1970) - the timestamp when the snapshot was created.
  - getAvailableSnapshotsAsync
```
public PgxFuture<java.util.Deque<GraphMetaData>> getAvailableSnapshotsAsync(PgxGraph snapshot)
```
    Gets a list of available in-memory snapshots of a given snapshot. Note that only persistent graphs (graphs with a graph config pointing to a data source) might have more than one in-memory snapshot. If the given graph name is a transient (private, session-bound) graph, this method will return a list with the given graph as only element. See PgxGraph.isTransient().
    
    Returns:
    
    A list of graph meta data objects, each belonging to a snapshot of the given graph currently loaded into memory. The list is descending ordered by the GraphMetaData.getCreationTimestamp() value (milliseconds since Jan 1st 1970) - the timestamp when the snapshot was created.
  - getCompiledProgram
```
public oracle.pgx.api.CompiledProgram getCompiledProgram(java.lang.String id)
                                                  throws java.util.concurrent.ExecutionException,
                                                         java.lang.InterruptedException
```
    Blocking version of getCompiledProgramAsync(String). Calls getCompiledProgramAsync(String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getCompiledProgramAsync
```
public PgxFuture<oracle.pgx.api.CompiledProgram> getCompiledProgramAsync(java.lang.String id)
```
    Gets a compiled program by ID.
    
    Parameters:
    
    id - the ID of the compiled program
    
    Returns:
    
    the compiled program.
  - getExecutionEnvironment
```
public ExecutionEnvironment getExecutionEnvironment()
```
    Gets the execution environment for this session. The ExecutionException gives access to detailed scheduling configuration
    
    Returns:
    
    the execution environment
  - getId
```
public java.lang.String getId()
```
    Gets the session ID.
    
    Returns:
    
    the Session ID
  - getIdleTimeout
```
public java.lang.Long getIdleTimeout()
```
    Gets the idle timeout of this session. A value of null indicates this session uses the default session idle timeout as specified by the PGX instance.
    
    Returns:
    
    the idle timeout in seconds. May be null.
  - getName
```
public java.lang.String getName()
```
    Alias for getId()
    
    Specified by:
    
    getName in class PgxManagedObject
    
    Returns:
    
    name of this session
  - getPatternMatchingSemantic
```
public PatternMatchingSemantic getPatternMatchingSemantic()
```
    Returns:
    
    the current pattern matching semantic. If the return value is null, the current session respects the pattern matching configuration of the engine.
  - getPgqlResultSet
```
public PgqlResultSet getPgqlResultSet(java.lang.String id)
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException
```
    Blocking version of getPgqlResultSetAsync(String). Calls getPgqlResultSetAsync(String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - getPgqlResultSetAsync
```
public PgxFuture<PgqlResultSet> getPgqlResultSetAsync(java.lang.String id)
```
    Gets a PGQL result set by ID.
    
    Parameters:
    
    id - the PGQL result set ID
    
    Returns:
    
    the requested PGQL result set or NULL if no such result set exists for this session
  - getServerInstance
```
public ServerInstance getServerInstance()
```
    Gets the server instance.
    
    Returns:
    
    the server instance.
  - getSource
```
public java.lang.String getSource()
```
    Gets the source.
    
    Returns:
    
    the source
  - getTaskTimeout
```
public java.lang.Long getTaskTimeout()
```
    Gets the task timeout of this session. A value of null indicates this session uses the default session task timeout as specified by the PGX instance.
    
    Returns:
    
    the task timeout in seconds. May be null.
  - newGraphBuilder
```
public GraphBuilder<java.lang.Integer> newGraphBuilder()
```
    Creates a graph builder with integer vertex IDs
    
    Returns:
    
    an empty graph builder instance
    
    See Also:
    
    newGraphBuilder(IdType)
  - newGraphBuilder
```
public <ID extends java.lang.Comparable<ID>> GraphBuilder<ID> newGraphBuilder(IdType idType)
```
    Creates a graph builder with the given vertex ID type
    
    Type Parameters:
    
    ID - the type of the vertex ID
    
    Parameters:
    
    idType - the vertex ID type
    
    Returns:
    
    an empty graph builder instance
  - readGraphAsOf
```
public PgxGraph readGraphAsOf(GraphConfig config,
                              GraphMetaData metaData)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphAsOfAsync(GraphConfig, GraphMetaData). Calls readGraphAsOfAsync(GraphConfig, GraphMetaData) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphAsOf
```
public PgxGraph readGraphAsOf(GraphConfig config,
                              GraphMetaData metaData,
                              java.lang.String newGraphName)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphAsOfAsync(GraphConfig, GraphMetaData, String). Calls readGraphAsOfAsync(GraphConfig, GraphMetaData, String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphAsOf
```
public PgxGraph readGraphAsOf(GraphConfig config,
                              long creationTimestamp)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphAsOfAsync(GraphConfig, long). Calls readGraphAsOfAsync(GraphConfig, long) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphAsOf
```
public PgxGraph readGraphAsOf(GraphConfig config,
                              long creationTimestamp,
                              java.lang.String newGraphName)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphAsOfAsync(GraphConfig, long, String). Calls readGraphAsOfAsync(GraphConfig, long, String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphAsOfAsync
```
public PgxFuture<PgxGraph> readGraphAsOfAsync(GraphConfig config,
                                              GraphMetaData metaData)
```
    Reads a graph and its properties of a specific version (metaData) into memory.
    
    Parameters:
    
    config - the graph config
    
    metaData - the metaData object returned by (GraphConfig) identifying the version to be checked out
    
    See Also:
    
    getAvailableSnapshotsAsync(GraphConfig), setSnapshotAsync(PgxGraph, GraphMetaData)
  - readGraphAsOfAsync
```
public PgxFuture<PgxGraph> readGraphAsOfAsync(GraphConfig config,
                                              GraphMetaData metaData,
                                              java.lang.String newGraphName)
```
    Reads a graph and its properties of a specific version (metaData) into memory.
    
    Parameters:
    
    config - the graph config
    
    metaData - the metaData object returned by (GraphConfig) identifying the version to be checked out
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    See Also:
    
    getAvailableSnapshotsAsync(GraphConfig), setSnapshotAsync(PgxGraph, GraphMetaData)
  - readGraphAsOfAsync
```
public PgxFuture<PgxGraph> readGraphAsOfAsync(GraphConfig config,
                                              long creationTimestamp)
```
    Reads a graph and its properties of a specific version (creationTimestamp) into memory. The creationTimestamp must be a valid version of the graph. To check available versions of a graph use getAvailableSnapshotsAsync(GraphConfig)
    
    Parameters:
    
    config - the graph config
    
    creationTimestamp - the creation timestamp (milliseconds since jan 1st 1970) identifying the version to be checked out
    
    See Also:
    
    getAvailableSnapshotsAsync(GraphConfig), setSnapshotAsync(PgxGraph, long)
  - readGraphAsOfAsync
```
public PgxFuture<PgxGraph> readGraphAsOfAsync(GraphConfig config,
                                              long creationTimestamp,
                                              java.lang.String newGraphName)
```
    Reads a graph and its properties of a specific version (creationTimestamp) into memory. The creationTimestamp must be a valid version of the graph. To check available versions of a graph use getAvailableSnapshotsAsync(GraphConfig)
    
    Parameters:
    
    config - the graph config
    
    creationTimestamp - the creation timestamp (milliseconds since jan 1st 1970) identifying the version to be checked out
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    See Also:
    
    getAvailableSnapshotsAsync(GraphConfig), setSnapshotAsync(PgxGraph, long)
  - readGraphFile
```
public PgxGraph readGraphFile(java.lang.String path)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphFileAsync(String). Calls readGraphFileAsync(String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphFile
```
public PgxGraph readGraphFile(java.lang.String path,
                              Format format)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphFileAsync(String, Format). Calls readGraphFileAsync(String, Format) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphFile
```
public PgxGraph readGraphFile(java.lang.String path,
                              Format format,
                              java.lang.String newGraphName)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphFileAsync(String, Format, String). Calls readGraphFileAsync(String, Format, String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphFile
```
public PgxGraph readGraphFile(java.lang.String path,
                              java.lang.String newGraphName)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException
```
    Blocking version of readGraphFileAsync(String, String). Calls readGraphFileAsync(String, String) and waits for the returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphFileAsync
```
public PgxFuture<PgxGraph> readGraphFileAsync(java.lang.String path)
```
    Loads the graph contained in the file at the given path.
    PGX will try to detect the file format and the graph configuration. If the format or the configuration cannot be determined, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    Returns:
    
    graph at the given location
    
    See Also:
    
    describeGraphFileAsync(String)
  - readGraphFileAsync
```
public PgxFuture<PgxGraph> readGraphFileAsync(java.lang.String path,
                                              Format format)
```
    Loads the graph contained in the file at the given path.
    PGX will try to detect the graph configuration. If the configuration cannot be determined or if the file format does not match the given format, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    format - file format
    
    Returns:
    
    graph at the given location
    
    See Also:
    
    describeGraphFileAsync(String, Format)
  - readGraphFileAsync
```
public PgxFuture<PgxGraph> readGraphFileAsync(java.lang.String path,
                                              Format format,
                                              java.lang.String newGraphName)
```
    Loads the graph contained in the files at the given path.
    PGX will try to detect the graph configuration. If the configuration cannot be determined or if the file format does not match the given format, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    format - file format
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    Returns:
    
    graph at the given location
    
    See Also:
    
    describeGraphFilesAsync(String, String, Format)
  - readGraphFileAsync
```
public PgxFuture<PgxGraph> readGraphFileAsync(java.lang.String path,
                                              java.lang.String newGraphName)
```
    Loads the graph contained in the file at the given path.
    PGX will try to detect the file format and the graph configuration. If the format or the configuration cannot be determined, the future is completed exceptionally.
    
    Parameters:
    
    path - graph file path
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    Returns:
    
    graph at the given location
    
    See Also:
    
    describeGraphFileAsync(String)
  - readGraphFilesAsync
```
public PgxFuture<PgxGraph> readGraphFilesAsync(java.util.List<java.lang.String> filePaths,
                                               Format format,
                                               java.lang.String newGraphName)
```
    Loads the graph contained in the files at the given paths.
    PGX will try to detect the graph configuration. If the configuration cannot be determined or if the file format does not match the given format, the future is completed exceptionally.
    
    Parameters:
    
    filePaths - paths to the graph files
    
    format - file format
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    Returns:
    
    graph at the given location
    
    See Also:
    
    describeGraphFilesAsync(List, Format)
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config)
                                 throws java.util.concurrent.ExecutionException,
                                        java.lang.InterruptedException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig). Calls readGraphWithPropertiesAsync(GraphConfig) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config,
                                        boolean updateIfNotFresh)
                                 throws java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig, boolean). Calls readGraphWithPropertiesAsync(GraphConfig, boolean) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config,
                                        boolean updateIfNotFresh,
                                        java.lang.String newGraphName)
                                 throws java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig, boolean, String). Calls readGraphWithPropertiesAsync(GraphConfig, boolean, String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config,
                                        long maxAge,
                                        java.util.concurrent.TimeUnit maxAgeTimeUnit)
                                 throws java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit). Calls readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config,
                                        long maxAge,
                                        java.util.concurrent.TimeUnit maxAgeTimeUnit,
                                        boolean blockIfFull,
                                        java.lang.String newGraphName)
                                 throws java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit, boolean, String). Calls readGraphWithPropertiesAsync(GraphConfig, long, TimeUnit, boolean, String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(GraphConfig config,
                                        java.lang.String newGraphName)
                                 throws java.util.concurrent.ExecutionException,
                                        java.lang.InterruptedException
```
    Blocking version of readGraphWithPropertiesAsync(GraphConfig, String). Calls readGraphWithPropertiesAsync(GraphConfig, String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(java.lang.String path)
                                 throws java.util.concurrent.ExecutionException,
                                        java.lang.InterruptedException
```
    Blocking version of readGraphWithPropertiesAsync(String). Calls readGraphWithPropertiesAsync(String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithProperties
```
public PgxGraph readGraphWithProperties(java.lang.String path,
                                        java.lang.String newGraphName)
                                 throws java.util.concurrent.ExecutionException,
                                        java.lang.InterruptedException
```
    Blocking version of readGraphWithPropertiesAsync(String, String). Calls readGraphWithPropertiesAsync(String, String) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config,
                                                        boolean updateIfNotFresh)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
    
    updateIfNotFresh - if another snapshot of the given graph already exists and this flag is true, a new snapshot will be loaded into memory in case that existing snapshot is not fresh (according to PgxGraph.isFresh()). If no other snapshot of that graph exists, this flag has no effect.
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config,
                                                        boolean updateIfNotFresh,
                                                        java.lang.String newGraphName)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
    
    updateIfNotFresh - if another snapshot of the given graph already exists and this flag is true, a new snapshot will be loaded into memory in case that existing snapshot is not fresh (according to PgxGraph.isFresh()). If no other snapshot of that graph exists, this flag has no effect.
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config,
                                                        long maxAge,
                                                        java.util.concurrent.TimeUnit maxAgeTimeUnit)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
    
    maxAge - if another snapshot of the given graph already exists, the age of the latest existing snapshot will be compared to the given maxAge. If the latest snapshot is in the given range, it will be returned, otherwise a new snapshot will be created.
    
    maxAgeTimeUnit - the time unit of the maxAge parameter
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config,
                                                        long maxAge,
                                                        java.util.concurrent.TimeUnit maxAgeTimeUnit,
                                                        boolean blockIfFull,
                                                        java.lang.String newGraphName)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
    
    maxAge - if another snapshot of the given graph already exists, the age of the latest existing snapshot will be compared to the given maxAge. If the latest snapshot is in the given range, it will be returned, otherwise a new snapshot will be created.
    
    maxAgeTimeUnit - the time unit of the maxAge parameter
    
    blockIfFull - if true and a new snapshot needs to be created but no more snapshots are allowed by the server configuration, the returned future will not complete until space becomes available. If full and this flage is false, the returned future will complete exceptionally instead.
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(GraphConfig config,
                                                        java.lang.String newGraphName)
```
    Reads a graph and its properties, specified a graph config, into memory.
    
    Parameters:
    
    config - the graph config
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(java.lang.String path)
```
    Reads a graph and its properties, specified by a path to a graph config, into memory.
    
    Parameters:
    
    path - a path to a graph config, e.g. 'hdfs:/path/to/config.json' or 'http://myserver.com/my-config.json'
    
    See Also:
    
    Path syntax documentation
  - readGraphWithPropertiesAsync
```
public PgxFuture<PgxGraph> readGraphWithPropertiesAsync(java.lang.String path,
                                                        java.lang.String newGraphName)
```
    Reads a graph and its properties, specified by a path to a graph config, into memory.
    
    Parameters:
    
    path - a path to a graph config, e.g. 'hdfs:/path/to/config.json' or 'http://myserver.com/my-config.json'
    
    newGraphName - how the graph should be named. If null, a name will be generated. If a graph with that name already exists, the returned future will complete exceptionally.
    
    See Also:
    
    Path syntax documentation
  - setPatternMatchingSemantic
```
public void setPatternMatchingSemantic(PatternMatchingSemantic patternMatchingSemantic)
```
    Set the pattern matching semantic of the session.
    
    Parameters:
    
    patternMatchingSemantic - pattern matching semantic. If null is passed, the session respects the pattern matching semantic of the engine.
  - setSnapshot
```
public void setSnapshot(PgxGraph graph,
                        GraphMetaData metaData)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException
```
    Blocking version of setSnapshotAsync(PgxGraph, GraphMetaData). Calls setSnapshotAsync(PgxGraph, GraphMetaData) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - setSnapshot
```
public void setSnapshot(PgxGraph graph,
                        GraphMetaData metaData,
                        boolean forceDeleteProperties)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException
```
    Blocking version of setSnapshotAsync(PgxGraph, GraphMetaData, boolean). Calls setSnapshotAsync(PgxGraph, GraphMetaData, boolean) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - setSnapshot
```
public void setSnapshot(PgxGraph graph,
                        long creationTimestamp)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException
```
    Blocking version of setSnapshotAsync(PgxGraph, long). Calls setSnapshotAsync(PgxGraph, long) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - setSnapshot
```
public void setSnapshot(PgxGraph graph,
                        long creationTimestamp,
                        boolean forceDeleteProperties)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException
```
    Blocking version of setSnapshotAsync(PgxGraph, long, boolean). Calls setSnapshotAsync(PgxGraph, long, boolean) and waits for returned PgxFuture to complete.
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.
    
    java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.
  - setSnapshotAsync
```
public PgxFuture<java.lang.Void> setSnapshotAsync(PgxGraph graph,
                                                  GraphMetaData metaData)
```
    Sets a graph to a specific snapshot. You can use this method to jump back and forth in time between various snapshots of the same graph. If successful, the given graph will point to the requested snapshot after the returned future completes.
    
    Parameters:
    
    graph - the graph to be checked out to a different version. Note that transient properties cannot be checked out to a different graph version. If the given graph contains any transient properties, the returned future will complete exceptionally with an UnsupportedOperationException set as cause. You can use setSnapshotAsync(PgxGraph, long, boolean) to force a checkout on a graph with transient properties.
    
    metaData - the metaData object returned by getAvailableSnapshotsAsync(GraphConfig) identifying the version to be checked out
  - setSnapshotAsync
```
public PgxFuture<java.lang.Void> setSnapshotAsync(PgxGraph graph,
                                                  GraphMetaData metaData,
                                                  boolean forceDeleteTransientProperties)
```
    Sets a graph to a specific snapshot. You can use this method to jump back and forth in time between various snapshots of the same graph. If successful, the given graph will point to the requested snapshot after the returned future completes.
    
    Parameters:
    
    graph - the graph to be checked out to a different snapshot version
    
    metaData - the metaData object returned by (GraphConfig) identifying the version to be checked out
    
    forceDeleteTransientProperties - Graphs with transient properties cannot be checked out to a different version. If this flag is set to true, the checked out graph will no longer contain any transient properties. If false, the returned future will complete exceptionally with an UnsupportedOperationException as its cause.
  - setSnapshotAsync
```
public PgxFuture<java.lang.Void> setSnapshotAsync(PgxGraph graph,
                                                  long creationTimestamp)
```
    Sets a graph to a specific snapshot. You can use this method to jump back and forth in time between various snapshots of the same graph. If successful, the given graph will point to the requested snapshot after the returned future completes.
    
    Parameters:
    
    graph - the graph to be checked out to a different version. Note that transient properties cannot be checked out to a different graph version. If the given graph contains any transient properties, the returned future will complete exceptionally with an UnsupportedOperationException set as cause. You can use setSnapshotAsync(PgxGraph, long, boolean) to force a checkout on a graph with transient properties.
    
    creationTimestamp - the creation timestamp (milliseconds since Jan 1st 1970) identifying the version to be checked out
  - setSnapshotAsync
```
public PgxFuture<java.lang.Void> setSnapshotAsync(PgxGraph graph,
                                                  long creationTimestamp,
                                                  boolean forceDeleteTransientProperties)
```
    Sets a graph to a specific snapshot. You can use this method to jump back and forth in time between various snapshots of the same graph. If successful, the given graph will point to the requested snapshot after the returned future completes.
    
    Parameters:
    
    graph - the graph to be checked out to a different snapshot version
    
    creationTimestamp - the creation timestamp (milliseconds since Jan 1st 1970) identifying the version to be checked out
    
    forceDeleteTransientProperties - Graphs with transient properties cannot be checked out to a different version. If this flag is set to true, the checked out graph will no longer contain any transient properties. If false, the returned future will complete exceptionally with an UnsupportedOperationException as its cause.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PgxSession

Method Summary

Methods inherited from class oracle.pgx.api.PgxManagedObject

Methods inherited from class oracle.pgx.api.Destroyable

Methods inherited from class java.lang.Object

Method Detail

compileProgramCodeAsync

compileProgramCodeAsync

compileProgramCodeAsync

createAnalyst

describeGraphAsync

describeGraphFile

describeGraphFile

describeGraphFileAsync

describeGraphFileAsync

describeGraphFiles

describeGraphFiles

getAvailableCompiledProgramIds

getAvailableCompiledProgramIdsAsync

getAvailableSnapshots

getAvailableSnapshots

getAvailableSnapshotsAsync

getAvailableSnapshotsAsync

getCompiledProgram

getCompiledProgramAsync

getExecutionEnvironment

getId

getIdleTimeout

getName

getPatternMatchingSemantic

getPgqlResultSet

getPgqlResultSetAsync

getServerInstance

getSource

getTaskTimeout

newGraphBuilder

newGraphBuilder

readGraphAsOf

readGraphAsOf

readGraphAsOf

readGraphAsOf

readGraphAsOfAsync

readGraphAsOfAsync

readGraphAsOfAsync

readGraphAsOfAsync

readGraphFile

readGraphFile

readGraphFile

readGraphFile

readGraphFileAsync

readGraphFileAsync

readGraphFileAsync

readGraphFileAsync

readGraphFilesAsync

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithProperties

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

readGraphWithPropertiesAsync

setPatternMatchingSemantic

setSnapshot

setSnapshot

setSnapshot

setSnapshot

setSnapshotAsync

setSnapshotAsync

setSnapshotAsync

setSnapshotAsync

toString