Module org.neo4j.driver
Package org.neo4j.driver.internal.async

Class InternalAsyncSession

java.lang.Object
org.neo4j.driver.internal.async.AsyncAbstractQueryRunner
org.neo4j.driver.internal.async.InternalAsyncSession
All Implemented Interfaces:
AsyncQueryRunner, AsyncSession, BaseSession
public class InternalAsyncSession extends AsyncAbstractQueryRunner implements AsyncSession

  • Constructor Details

  • Method Details

    • runAsync

      public CompletionStage<ResultCursor> runAsync(Query query)
      Description copied from interface: AsyncQueryRunner
      Run a query asynchronously and return a CompletionStage with a result cursor.

      Example

       
 Query query = new Query( "MATCH (n) WHERE n.name = $myNameParam RETURN n.age" );
 CompletionStage<ResultCursor> cursorStage = session.runAsync(query);
      It is not allowed to chain blocking operations on the returned CompletionStage. See class javadoc for more information.
      Specified by:
      runAsync in interface AsyncQueryRunner
      Parameters:
      query - a Neo4j query
      Returns:
      new CompletionStage that gets completed with a result cursor when query execution is successful. Stage can be completed exceptionally when error happens, e.g. connection can't be acquired from the pool.

    • runAsync

      public CompletionStage<ResultCursor> runAsync(String query, TransactionConfig config)
      Description copied from interface: AsyncSession
      Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.

      It is not allowed to chain blocking operations on the returned CompletionStage. See class javadoc in AsyncQueryRunner for more information.

      Specified by:
      runAsync in interface AsyncSession
      Parameters:
      query - text of a Neo4j query.
      config - configuration for the new transaction.
      Returns:
      new CompletionStage that gets completed with a result cursor when query execution is successful. Stage can be completed exceptionally when error happens, e.g. connection can't be acquired from the pool.

    • runAsync

      public CompletionStage<ResultCursor> runAsync(String query, Map<String,Object> parameters, TransactionConfig config)
      Description copied from interface: AsyncSession
      Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.

      This method takes a set of parameters that will be injected into the query by Neo4j. Using parameters is highly encouraged, it helps avoid dangerous cypher injection attacks and improves database performance as Neo4j can re-use query plans more often.

      This version of runAsync takes a Map of parameters. The values in the map must be values that can be converted to Neo4j types. See Values.parameters(Object...) for a list of allowed types.

      Example

       
 Map<String, Object> metadata = new HashMap<>();
 metadata.put("type", "update name");

 TransactionConfig config = TransactionConfig.builder()
                 .withTimeout(Duration.ofSeconds(3))
                 .withMetadata(metadata)
                 .build();

 Map<String, Object> parameters = new HashMap<String, Object>();
 parameters.put("myNameParam", "Bob");

 CompletionStage<ResultCursor> cursorStage = session.runAsync(
             "MATCH (n) WHERE n.name = $myNameParam RETURN (n)",
             parameters,
             config);
      It is not allowed to chain blocking operations on the returned CompletionStage. See class javadoc in AsyncQueryRunner for more information.
      Specified by:
      runAsync in interface AsyncSession
      Parameters:
      query - text of a Neo4j query.
      parameters - input data for the query.
      config - configuration for the new transaction.
      Returns:
      new CompletionStage that gets completed with a result cursor when query execution is successful. Stage can be completed exceptionally when error happens, e.g. connection can't be acquired from the pool.

    • runAsync

      public CompletionStage<ResultCursor> runAsync(Query query, TransactionConfig config)
      Description copied from interface: AsyncSession
      Run a query asynchronously in an auto-commit transaction with the specified configuration and return a CompletionStage with a result cursor.

      Example

       
 Map<String, Object> metadata = new HashMap<>();
 metadata.put("type", "update name");

 TransactionConfig config = TransactionConfig.builder()
                 .withTimeout(Duration.ofSeconds(3))
                 .withMetadata(metadata)
                 .build();

 Query query = new Query( "MATCH (n) WHERE n.name = $myNameParam RETURN n.age" );
 CompletionStage<ResultCursor> cursorStage = session.runAsync(query, config);
      It is not allowed to chain blocking operations on the returned CompletionStage. See class javadoc in AsyncQueryRunner for more information.
      Specified by:
      runAsync in interface AsyncSession
      Parameters:
      query - a Neo4j query.
      config - configuration for the new transaction.
      Returns:
      new CompletionStage that gets completed with a result cursor when query execution is successful. Stage can be completed exceptionally when error happens, e.g. connection can't be acquired from the pool.

    • closeAsync

      public CompletionStage<Void> closeAsync()
      Description copied from interface: AsyncSession
      Signal that you are done using this session. In the default driver usage, closing and accessing sessions is very low cost.

      This operation is asynchronous and returns a CompletionStage. Stage is completed when all outstanding queries in the session have completed, meaning any writes you performed are guaranteed to be durably stored. It might be completed exceptionally when there are unconsumed errors from previous queries or transactions.

      Specified by:
      closeAsync in interface AsyncSession
      Returns:
      a completion stage that represents the asynchronous close.

    • beginTransactionAsync

      public CompletionStage<AsyncTransaction> beginTransactionAsync()
      Description copied from interface: AsyncSession
      Begin a new unmanaged transaction. At most one transaction may exist in a session at any point in time. To maintain multiple concurrent transactions, use multiple concurrent sessions.

      This operation is asynchronous and returns a CompletionStage. This stage is completed with a new Transaction object when begin operation is successful. It is completed exceptionally if transaction can't be started.

      Returned stage can be completed by an IO thread which should never block. Otherwise IO operations on this and potentially other network connections might deadlock. Please do not chain blocking operations like CompletableFuture.get() on the returned stage. Consider using asynchronous calls throughout the chain or offloading blocking operation to a different Executor. This can be done using methods with "Async" suffix like CompletionStage.thenApplyAsync(Function) or CompletionStage.thenApplyAsync(Function, Executor).

      Specified by:
      beginTransactionAsync in interface AsyncSession
      Returns:
      a completion stage that represents the asynchronous begin of a transaction.

    • beginTransactionAsync

      public CompletionStage<AsyncTransaction> beginTransactionAsync(TransactionConfig config)
      Description copied from interface: AsyncSession
      Begin a new unmanaged transaction with the specified configuration. At most one transaction may exist in a session at any point in time. To maintain multiple concurrent transactions, use multiple concurrent sessions.

      This operation is asynchronous and returns a CompletionStage. This stage is completed with a new AsyncTransaction object when begin operation is successful. It is completed exceptionally if transaction can't be started.

      Returned stage can be completed by an IO thread which should never block. Otherwise IO operations on this and potentially other network connections might deadlock. Please do not chain blocking operations like CompletableFuture.get() on the returned stage. Consider using asynchronous calls throughout the chain or offloading blocking operation to a different Executor. This can be done using methods with "Async" suffix like CompletionStage.thenApplyAsync(Function) or CompletionStage.thenApplyAsync(Function, Executor).

      Specified by:
      beginTransactionAsync in interface AsyncSession
      Parameters:
      config - configuration for the new transaction.
      Returns:
      a completion stage that represents the asynchronous begin of a transaction.

    • executeReadAsync

      public <T> CompletionStage<T> executeReadAsync(AsyncTransactionCallback<CompletionStage<T>> callback, TransactionConfig config)
      Description copied from interface: AsyncSession
      Execute a unit of work as a single, managed transaction with read access mode and retry behaviour. The transaction allows for one or more statements to be run.

      The driver will attempt committing the transaction when the provided unit of work completes successfully. Any exception emitted by the unit of work will result in a rollback attempt and abortion of execution unless exception is considered to be valid for retry attempt by the driver.

      The provided unit of work should not return Result object as it won't be valid outside the scope of the transaction.

      It is prohibited to block the thread completing the returned CompletionStage. Please avoid blocking operations or hand processing over to a different thread.

      Specified by:
      executeReadAsync in interface AsyncSession
      Type Parameters:
      T - the return type of the given unit of work.
      Parameters:
      callback - the callback representing the unit of work.
      config - configuration for all transactions started to execute the unit of work.
      Returns:
      a completion stage that completes successfully with the result of the unit of work on success or completes exceptionally otherwise.

    • executeWriteAsync

      public <T> CompletionStage<T> executeWriteAsync(AsyncTransactionCallback<CompletionStage<T>> callback, TransactionConfig config)
      Description copied from interface: AsyncSession
      Execute a unit of work as a single, managed transaction with write access mode and retry behaviour. The transaction allows for one or more statements to be run.

      The driver will attempt committing the transaction when the provided unit of work completes successfully. Any exception emitted by the unit of work will result in a rollback attempt and abortion of execution unless exception is considered to be valid for retry attempt by the driver.

      The provided unit of work should not return Result object as it won't be valid outside the scope of the transaction.

      It is prohibited to block the thread completing the returned CompletionStage. Please avoid blocking operations or hand processing over to a different thread.

      Specified by:
      executeWriteAsync in interface AsyncSession
      Type Parameters:
      T - the return type of the given unit of work.
      Parameters:
      callback - the callback representing the unit of work.
      config - configuration for all transactions started to execute the unit of work.
      Returns:
      a completion stage that completes successfully with the result of the unit of work on success or completes exceptionally otherwise.

    • lastBookmarks

      public Set<Bookmark> lastBookmarks()
      Description copied from interface: AsyncSession
      Return a set of last bookmarks.

      When no new bookmark is received, the initial bookmarks are returned. This may happen when no work has been done using the session. Multivalued Bookmark instances will be mapped to distinct Bookmark instances. If no initial bookmarks have been provided, an empty set is returned.

      Specified by:
      lastBookmarks in interface AsyncSession
      Returns:
      the immutable set of last bookmarks.