Package org.neo4j.gds.compat

Class GdsGraphDatabaseAPI

  • All Implemented Interfaces:
    org.neo4j.graphdb.GraphDatabaseService, org.neo4j.kernel.internal.GraphDatabaseAPI
    public abstract class GdsGraphDatabaseAPI
extends java.lang.Object
implements org.neo4j.kernel.internal.GraphDatabaseAPI
    Compat wrapper around GraphDatabaseAPI. There are some differences in method signatures, but we don't use those. We can push the methods that are different into the compat implementation classes and have a shared implementation here.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.neo4j.kernel.internal.GraphDatabaseAPI api  
      protected org.neo4j.dbms.api.DatabaseManagementService dbms  

    • Constructor Summary

      Constructors 
      Constructor Description
      GdsGraphDatabaseAPI​(org.neo4j.dbms.api.DatabaseManagementService dbms)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type, org.neo4j.internal.kernel.api.security.LoginContext loginContext)  
      org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type, org.neo4j.internal.kernel.api.security.LoginContext loginContext, org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo clientInfo)  
      org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type, org.neo4j.internal.kernel.api.security.LoginContext loginContext, org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo clientInfo, long timeout, java.util.concurrent.TimeUnit unit)  
      org.neo4j.graphdb.Transaction beginTx()  
      org.neo4j.graphdb.Transaction beginTx​(long timeout, java.util.concurrent.TimeUnit unit)  
      org.neo4j.kernel.database.NamedDatabaseId databaseId()  
      org.neo4j.io.layout.DatabaseLayout databaseLayout()  
      java.lang.String databaseName()  
      abstract java.nio.file.Path dbHome​(java.nio.file.Path workingDir)  
      void executeTransactionally​(java.lang.String query)  
      void executeTransactionally​(java.lang.String query, java.util.Map<java.lang.String,​java.lang.Object> parameters)  
      <T> T executeTransactionally​(java.lang.String query, java.util.Map<java.lang.String,​java.lang.Object> parameters, org.neo4j.graphdb.ResultTransformer<T> resultTransformer)  
      <T> T executeTransactionally​(java.lang.String query, java.util.Map<java.lang.String,​java.lang.Object> parameters, org.neo4j.graphdb.ResultTransformer<T> resultTransformer, java.time.Duration timeout)  
      org.neo4j.common.DependencyResolver getDependencyResolver()  
      boolean isAvailable​(long timeout)  
      void shutdown()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.neo4j.kernel.internal.GraphDatabaseAPI

        dbmsInfo

    • Field Detail

      • api

        protected final org.neo4j.kernel.internal.GraphDatabaseAPI api

      • dbms

        protected final org.neo4j.dbms.api.DatabaseManagementService dbms

    • Constructor Detail

      • GdsGraphDatabaseAPI

        public GdsGraphDatabaseAPI​(org.neo4j.dbms.api.DatabaseManagementService dbms)

    • Method Detail

      • shutdown

        public void shutdown()

      • dbHome

        public abstract java.nio.file.Path dbHome​(java.nio.file.Path workingDir)

      • getDependencyResolver

        public org.neo4j.common.DependencyResolver getDependencyResolver()
        Specified by:
        getDependencyResolver in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • databaseLayout

        public org.neo4j.io.layout.DatabaseLayout databaseLayout()
        Specified by:
        databaseLayout in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • databaseId

        public org.neo4j.kernel.database.NamedDatabaseId databaseId()
        Specified by:
        databaseId in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • beginTransaction

        public org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type,
                                                                          org.neo4j.internal.kernel.api.security.LoginContext loginContext)
        Specified by:
        beginTransaction in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • beginTransaction

        public org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type,
                                                                          org.neo4j.internal.kernel.api.security.LoginContext loginContext,
                                                                          org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo clientInfo)
        Specified by:
        beginTransaction in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • beginTransaction

        public org.neo4j.kernel.impl.coreapi.InternalTransaction beginTransaction​(org.neo4j.kernel.api.KernelTransaction.Type type,
                                                                          org.neo4j.internal.kernel.api.security.LoginContext loginContext,
                                                                          org.neo4j.internal.kernel.api.connectioninfo.ClientConnectionInfo clientInfo,
                                                                          long timeout,
                                                                          java.util.concurrent.TimeUnit unit)
        Specified by:
        beginTransaction in interface org.neo4j.kernel.internal.GraphDatabaseAPI

      • isAvailable

        public boolean isAvailable​(long timeout)
        Specified by:
        isAvailable in interface org.neo4j.graphdb.GraphDatabaseService

      • beginTx

        public org.neo4j.graphdb.Transaction beginTx()
        Specified by:
        beginTx in interface org.neo4j.graphdb.GraphDatabaseService

      • beginTx

        public org.neo4j.graphdb.Transaction beginTx​(long timeout,
                                             java.util.concurrent.TimeUnit unit)
        Specified by:
        beginTx in interface org.neo4j.graphdb.GraphDatabaseService

      • executeTransactionally

        public void executeTransactionally​(java.lang.String query)
                            throws org.neo4j.graphdb.QueryExecutionException
        Specified by:
        executeTransactionally in interface org.neo4j.graphdb.GraphDatabaseService
        Throws:
        org.neo4j.graphdb.QueryExecutionException

      • executeTransactionally

        public void executeTransactionally​(java.lang.String query,
                                   java.util.Map<java.lang.String,​java.lang.Object> parameters)
                            throws org.neo4j.graphdb.QueryExecutionException
        Specified by:
        executeTransactionally in interface org.neo4j.graphdb.GraphDatabaseService
        Throws:
        org.neo4j.graphdb.QueryExecutionException

      • executeTransactionally

        public <T> T executeTransactionally​(java.lang.String query,
                                    java.util.Map<java.lang.String,​java.lang.Object> parameters,
                                    org.neo4j.graphdb.ResultTransformer<T> resultTransformer)
                             throws org.neo4j.graphdb.QueryExecutionException
        Specified by:
        executeTransactionally in interface org.neo4j.graphdb.GraphDatabaseService
        Throws:
        org.neo4j.graphdb.QueryExecutionException

      • executeTransactionally

        public <T> T executeTransactionally​(java.lang.String query,
                                    java.util.Map<java.lang.String,​java.lang.Object> parameters,
                                    org.neo4j.graphdb.ResultTransformer<T> resultTransformer,
                                    java.time.Duration timeout)
                             throws org.neo4j.graphdb.QueryExecutionException
        Specified by:
        executeTransactionally in interface org.neo4j.graphdb.GraphDatabaseService
        Throws:
        org.neo4j.graphdb.QueryExecutionException

      • databaseName

        public java.lang.String databaseName()
        Specified by:
        databaseName in interface org.neo4j.graphdb.GraphDatabaseService