Interface Neo4jClient

@API(status=STABLE, since="6.0") public interface Neo4jClient
Definition of a modern Neo4j client.
Since:
6.0
Author:
Gerrit Meier, Michael J. Simons

  • Field Details

    • SUPPRESS_ID_DEPRECATIONS

      static final AtomicBoolean SUPPRESS_ID_DEPRECATIONS
      This is a public API introduced to turn the logging of the infamous warning back on. The query used a deprecated function: `id`.

    • cypherLog

      static final LogAccessor cypherLog
      All Cypher statements executed will be logged here.

    • log

      static final LogAccessor log
      Some methods of the Neo4jClient will be logged here.

  • Method Details

    • create

      static Neo4jClient create(org.neo4j.driver.Driver driver)

    • create

      static Neo4jClient create(org.neo4j.driver.Driver driver, DatabaseSelectionProvider databaseSelectionProvider)

    • with

      static Neo4jClient.Builder with(org.neo4j.driver.Driver driver)

    • verifyDatabaseName

      static @Nullable String verifyDatabaseName(@Nullable String databaseName)
      This is a utility method to verify and sanitize a database name.
      Parameters:
      databaseName - the database name to verify and sanitize
      Returns:
      a possibly trimmed name of the database
      Throws:
      IllegalArgumentException - when the database name is not allowed with the underlying driver.

    • getQueryRunner

      default org.neo4j.driver.QueryRunner getQueryRunner()
      Retrieves a query runner matching the plain Neo4j Java Driver api bound to Spring transactions.
      Returns:
      a managed query runner
      Since:
      6.2
      See Also:

    • getQueryRunner

      default org.neo4j.driver.QueryRunner getQueryRunner(DatabaseSelection databaseSelection)
      Retrieves a query runner matching the plain Neo4j Java Driver api bound to Spring transactions configured to use a specific database.
      Parameters:
      databaseSelection - the database to use
      Returns:
      a managed query runner
      Since:
      6.2
      See Also:

    • getQueryRunner

      org.neo4j.driver.QueryRunner getQueryRunner(DatabaseSelection databaseSelection, UserSelection asUser)
      Retrieves a query runner that will participate in ongoing Spring transactions (either in declarative (implicit via @Transactional) or in programmatically (explicit via transaction template) ones). This runner can be used with the Cypher-DSL for example. If the client cannot retrieve an ongoing Spring transaction, this runner will use auto-commit semantics.
      Parameters:
      databaseSelection - the target database
      asUser - as an impersonated user. Requires Neo4j 4.4 and Driver 4.4
      Returns:
      a managed query runner
      Since:
      6.2

    • query

      Neo4jClient.UnboundRunnableSpec query(String cypher)
      Entrypoint for creating a new Cypher query. Doesn't matter at this point whether it's a match, merge, create or removal of things.
      Parameters:
      cypher - the cypher code that shall be executed
      Returns:
      a runnable query specification

    • query

      Neo4jClient.UnboundRunnableSpec query(Supplier<String> cypherSupplier)
      Entrypoint for creating a new Cypher query based on a supplier. Doesn't matter at this point whether it's a match, merge, create or removal of things. The supplier can be an arbitrary Supplier that may provide a DSL for generating the Cypher statement.
      Parameters:
      cypherSupplier - a supplier of arbitrary Cypher code
      Returns:
      a runnable query specification

    • delegateTo

      <T> Neo4jClient.OngoingDelegation<T> delegateTo(Function<org.neo4j.driver.QueryRunner, Optional<T>> callback)
      Delegates interaction with the default database to the given callback.
      Type Parameters:
      T - the type of the result being produced
      Parameters:
      callback - a function receiving a statement runner for database interaction that can optionally return a result
      Returns:
      a single result object or an empty optional if the callback didn't produce a result

    • getDatabaseSelectionProvider

      @Nullable DatabaseSelectionProvider getDatabaseSelectionProvider()
      Returns the assigned database selection provider.
      Returns:
      the database selection provider - can be null