GraphDatabaseService (Neo4j 3.5.36 API)

All Known Implementing Classes:

EmbeddedGraphDatabase, org.neo4j.kernel.impl.factory.GraphDatabaseFacade
```
public interface GraphDatabaseService
```
The main access point to a running Neo4j instance. The most common way to instantiate a GraphDatabaseService is as follows:
```
 GraphDatabaseService graphDb = new GraphDatabaseFactory().newEmbeddedDatabase( new File("var/graphDb") );
 // ... use Neo4j
 graphDb.shutdown();
 
```
GraphDatabaseService provides operations to create nodes, get nodes given an id and ultimately shutdown Neo4j.
Please note that all operations on the graph must be invoked in a transactional context. Failure to do so will result in a NotInTransactionException being thrown.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Transaction`	`beginTx()` Starts a new `transaction` and associates it with the current thread.
`Transaction`	`beginTx(long timeout, TimeUnit unit)` Starts a new `transaction` with custom timeout and associates it with the current thread.
`BidirectionalTraversalDescription`	`bidirectionalTraversalDescription()` Factory method for bidirectional traversal descriptions.
`Node`	`createNode()` Creates a new node.
`Node`	`createNode(Label... labels)` Creates a new node and adds the provided labels to it.
`Long`	`createNodeId()` Deprecated. This method will be removed in a future major release.
`Result`	`execute(String query)` Executes a query and returns an iterable that contains the result set.
`Result`	`execute(String query, long timeout, TimeUnit unit)` Executes a query and returns an iterable that contains the result set.
`Result`	`execute(String query, Map<String,Object> parameters)` Executes a query and returns an iterable that contains the result set.
`Result`	`execute(String query, Map<String,Object> parameters, long timeout, TimeUnit unit)` Executes a query and returns an iterable that contains the result set.
`Node`	`findNode(Label label, String key, Object value)` Equivalent to `findNodes(Label, String, Object)`, however it must find no more than one `node` or it will throw an exception.
`ResourceIterator<Node>`	`findNodes(Label label)` Returns all `nodes` with a specific `label`.
`default ResourceIterator<Node>`	`findNodes(Label label, Map<String,Object> propertyValues)` Returns all nodes having the label, and the wanted property values.
`ResourceIterator<Node>`	`findNodes(Label label, String key, Object value)` Returns all nodes having the label, and the wanted property value.
`default ResourceIterator<Node>`	`findNodes(Label label, String key1, Object value1, String key2, Object value2)` Returns all nodes having the label, and the wanted property values.
`default ResourceIterator<Node>`	`findNodes(Label label, String key1, Object value1, String key2, Object value2, String key3, Object value3)` Returns all nodes having the label, and the wanted property values.
`default ResourceIterator<Node>`	`findNodes(Label label, String key, String template, StringSearchMode searchMode)` Returns all nodes having a given label, and a property value of type String or Character matching the given value template and search mode.
`ResourceIterable<Label>`	`getAllLabels()` Returns all labels currently in the underlying store.
`ResourceIterable<Label>`	`getAllLabelsInUse()` Returns all labels currently in the underlying store.
`ResourceIterable<Node>`	`getAllNodes()` Returns all nodes in the graph.
`ResourceIterable<String>`	`getAllPropertyKeys()` Returns all property keys currently in the underlying store.
`ResourceIterable<Relationship>`	`getAllRelationships()` Returns all relationships in the graph.
`ResourceIterable<RelationshipType>`	`getAllRelationshipTypes()` Returns all relationship types currently in the underlying store.
`ResourceIterable<RelationshipType>`	`getAllRelationshipTypesInUse()` Returns all relationship types currently in the underlying store.
`Node`	`getNodeById(long id)` Looks up a node by id.
`Relationship`	`getRelationshipById(long id)` Looks up a relationship by id.
`IndexManager`	`index()` Deprecated. The `IndexManager` based indexes will be removed in the next major release. Please consider using schema indexes instead.
`boolean`	`isAvailable(long timeout)` Use this method to check if the database is currently in a usable state.
`KernelEventHandler`	`registerKernelEventHandler(KernelEventHandler handler)` Registers `handler` as a handler for kernel events which are generated from different places in the lifecycle of the kernel.
`<T> TransactionEventHandler<T>`	`registerTransactionEventHandler(TransactionEventHandler<T> handler)` Registers `handler` as a handler for transaction events which are generated from different places in the lifecycle of each transaction.
`Schema`	`schema()` Returns the `schema manager` where all things related to schema, for example constraints and indexing on `labels`.
`void`	`shutdown()` Shuts down Neo4j.
`TraversalDescription`	`traversalDescription()` Factory method for unidirectional traversal descriptions.
`KernelEventHandler`	`unregisterKernelEventHandler(KernelEventHandler handler)` Unregisters `handler` from the list of kernel event handlers.
`<T> TransactionEventHandler<T>`	`unregisterTransactionEventHandler(TransactionEventHandler<T> handler)` Unregisters `handler` from the list of transaction event handlers.

- Method Detail
  - createNode
```
Node createNode()
```
    Creates a new node.
    
    Returns:
    
    the created node.
  - createNodeId
```
@Deprecated
Long createNodeId()
```
    Deprecated. This method will be removed in a future major release.
    
    Creates a new node and returns it id. Please note: Neo4j reuses its internal ids when nodes and relationships are deleted, which means it's bad practice to refer to them this way. Instead, use application generated ids.
    
    Returns:
    
    the created nodes id.
  - createNode
```
Node createNode(Label... labels)
```
    Creates a new node and adds the provided labels to it.
    
    Parameters:
    
    labels - labels to add to the created node.
    
    Returns:
    
    the created node.
  - getNodeById
```
Node getNodeById(long id)
```
    Looks up a node by id. Please note: Neo4j reuses its internal ids when nodes and relationships are deleted, which means it's bad practice to refer to them this way. Instead, use application generated ids.
    
    Parameters:
    
    id - the id of the node
    
    Returns:
    
    the node with id id if found
    
    Throws:
    
    NotFoundException - if not found
  - getRelationshipById
```
Relationship getRelationshipById(long id)
```
    Looks up a relationship by id. Please note: Neo4j reuses its internal ids when nodes and relationships are deleted, which means it's bad practice to refer to them this way. Instead, use application generated ids.
    
    Parameters:
    
    id - the id of the relationship
    
    Returns:
    
    the relationship with id id if found
    
    Throws:
    
    NotFoundException - if not found
  - getAllNodes
```
ResourceIterable<Node> getAllNodes()
```
    Returns all nodes in the graph.
    
    Returns:
    
    all nodes in the graph.
  - getAllRelationships
```
ResourceIterable<Relationship> getAllRelationships()
```
    Returns all relationships in the graph.
    
    Returns:
    
    all relationships in the graph.
  - findNodes
```
ResourceIterator<Node> findNodes(Label label,
                                 String key,
                                 Object value)
```
    Returns all nodes having the label, and the wanted property value. If an online index is found, it will be used to look up the requested nodes.
    If no indexes exist for the label/property combination, the database will scan all labeled nodes looking for the property value.
    Note that equality for values do not follow the rules of Java. This means that the number 42 is equals to all other 42 numbers, regardless of whether they are encoded as Integer, Long, Float, Short, Byte or Double.
    Same rules follow Character and String - the Character 'A' is equal to the String 'A'.
    Finally - arrays also follow these rules. An int[] {1,2,3} is equal to a double[] {1.0, 2.0, 3.0}
    Please ensure that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    label - consider nodes with this label
    
    key - required property key
    
    value - required property value
    
    Returns:
    
    an iterator containing all matching nodes. See ResourceIterator for responsibilities.
  - findNodes
```
default ResourceIterator<Node> findNodes(Label label,
                                         String key1,
                                         Object value1,
                                         String key2,
                                         Object value2)
```
    Returns all nodes having the label, and the wanted property values. If an online index is found, it will be used to look up the requested nodes.
    If no indexes exist for the label with all provided properties, the database will scan all labeled nodes looking for matching nodes.
    Note that equality for values do not follow the rules of Java. This means that the number 42 is equals to all other 42 numbers, regardless of whether they are encoded as Integer, Long, Float, Short, Byte or Double.
    Same rules follow Character and String - the Character 'A' is equal to the String 'A'.
    Finally - arrays also follow these rules. An int[] {1,2,3} is equal to a double[] {1.0, 2.0, 3.0}
    Please ensure that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    label - consider nodes with this label
    
    key1 - required property key1
    
    value1 - required property value of key1
    
    key2 - required property key2
    
    value2 - required property value of key2
    
    Returns:
    
    an iterator containing all matching nodes. See ResourceIterator for responsibilities.
  - findNodes
```
default ResourceIterator<Node> findNodes(Label label,
                                         String key1,
                                         Object value1,
                                         String key2,
                                         Object value2,
                                         String key3,
                                         Object value3)
```
    Returns all nodes having the label, and the wanted property values. If an online index is found, it will be used to look up the requested nodes.
    If no indexes exist for the label with all provided properties, the database will scan all labeled nodes looking for matching nodes.
    Note that equality for values do not follow the rules of Java. This means that the number 42 is equals to all other 42 numbers, regardless of whether they are encoded as Integer, Long, Float, Short, Byte or Double.
    Same rules follow Character and String - the Character 'A' is equal to the String 'A'.
    Finally - arrays also follow these rules. An int[] {1,2,3} is equal to a double[] {1.0, 2.0, 3.0}
    Please ensure that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    label - consider nodes with this label
    
    key1 - required property key1
    
    value1 - required property value of key1
    
    key2 - required property key2
    
    value2 - required property value of key2
    
    key3 - required property key3
    
    value3 - required property value of key3
    
    Returns:
    
    an iterator containing all matching nodes. See ResourceIterator for responsibilities.
  - findNodes
```
default ResourceIterator<Node> findNodes(Label label,
                                         Map<String,Object> propertyValues)
```
    Returns all nodes having the label, and the wanted property values. If an online index is found, it will be used to look up the requested nodes.
    If no indexes exist for the label with all provided properties, the database will scan all labeled nodes looking for matching nodes.
    Note that equality for values do not follow the rules of Java. This means that the number 42 is equals to all other 42 numbers, regardless of whether they are encoded as Integer, Long, Float, Short, Byte or Double.
    Same rules follow Character and String - the Character 'A' is equal to the String 'A'.
    Finally - arrays also follow these rules. An int[] {1,2,3} is equal to a double[] {1.0, 2.0, 3.0}
    Please ensure that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    label - consider nodes with this label
    
    propertyValues - required property key-value combinations
    
    Returns:
    
    an iterator containing all matching nodes. See ResourceIterator for responsibilities.
  - findNodes
```
default ResourceIterator<Node> findNodes(Label label,
                                         String key,
                                         String template,
                                         StringSearchMode searchMode)
```
    Returns all nodes having a given label, and a property value of type String or Character matching the given value template and search mode.
    If an online index is found, it will be used to look up the requested nodes. If no indexes exist for the label/property combination, the database will scan all labeled nodes looking for matching property values.
    The search mode and value template are used to select nodes of interest. The search mode can be one of
    - EXACT: The value has to match the template exactly. This is the same behavior as findNode(Label, String, Object).
    - PREFIX: The value must have a prefix matching the template.
    - SUFFIX: The value must have a suffix matching the template.
    - CONTAINS: The value must contain the template. Only exact matches are supported.
    Note that in Neo4j the Character 'A' will be treated the same way as the String 'A'.
    Please ensure that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    Parameters:
    
    label - consider nodes with this label
    
    key - required property key
    
    template - required property value template
    
    searchMode - required property value template
    
    Returns:
    
    an iterator containing all matching nodes. See ResourceIterator for responsibilities.
  - findNode
```
Node findNode(Label label,
              String key,
              Object value)
```
    Equivalent to findNodes(Label, String, Object), however it must find no more than one node or it will throw an exception.
    
    Parameters:
    
    label - consider nodes with this label
    
    key - required property key
    
    value - required property value
    
    Returns:
    
    the matching node or null if none could be found
    
    Throws:
    
    MultipleFoundException - if more than one matching node is found
  - findNodes
```
ResourceIterator<Node> findNodes(Label label)
```
    Returns all nodes with a specific label. Please take care that the returned ResourceIterator is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    label - the Label to return nodes for.
    
    Returns:
    
    an iterator containing all nodes matching the label. See ResourceIterator for responsibilities.
  - getAllLabelsInUse
```
ResourceIterable<Label> getAllLabelsInUse()
```
    Returns all labels currently in the underlying store. Labels are added to the store the first time they are used. This method guarantees that it will return all labels currently in use. Please take care that the returned ResourceIterable is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Returns:
    
    all labels in the underlying store.
  - getAllRelationshipTypesInUse
```
ResourceIterable<RelationshipType> getAllRelationshipTypesInUse()
```
    Returns all relationship types currently in the underlying store. Relationship types are added to the underlying store the first time they are used in a successfully committed node.createRelationshipTo(...). This method guarantees that it will return all relationship types currently in use.
    
    Returns:
    
    all relationship types in the underlying store
  - getAllLabels
```
ResourceIterable<Label> getAllLabels()
```
    Returns all labels currently in the underlying store. Labels are added to the store the first time they are used. This method guarantees that it will return all labels currently in use. However, it may also return more than that (e.g. it can return "historic" labels that are no longer used). Please take care that the returned ResourceIterable is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Returns:
    
    all labels in the underlying store.
  - getAllRelationshipTypes
```
ResourceIterable<RelationshipType> getAllRelationshipTypes()
```
    Returns all relationship types currently in the underlying store. Relationship types are added to the underlying store the first time they are used in a successfully committed node.createRelationshipTo(...). Note that this method is guaranteed to return all known relationship types, but it does not guarantee that it won't return more than that (e.g. it can return "historic" relationship types that no longer have any relationships in the node space).
    
    Returns:
    
    all relationship types in the underlying store
  - getAllPropertyKeys
```
ResourceIterable<String> getAllPropertyKeys()
```
    Returns all property keys currently in the underlying store. This method guarantees that it will return all property keys currently in use. However, it may also return more than that (e.g. it can return "historic" labels that are no longer used). Please take care that the returned ResourceIterable is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Returns:
    
    all property keys in the underlying store.
  - isAvailable
```
boolean isAvailable(long timeout)
```
    Use this method to check if the database is currently in a usable state.
    
    Parameters:
    
    timeout - timeout (in milliseconds) to wait for the database to become available. If the database has been shut down false is returned immediately.
    
    Returns:
    
    the state of the database: true if it is available, otherwise false
  - shutdown
```
void shutdown()
```
    Shuts down Neo4j. After this method has been invoked, it's invalid to invoke any methods in the Neo4j API and all references to this instance of GraphDatabaseService should be discarded.
  - beginTx
```
Transaction beginTx()
```
    Starts a new transaction and associates it with the current thread.
    All database operations must be wrapped in a transaction.
    If you attempt to access the graph outside of a transaction, those operations will throw NotInTransactionException.
    Please ensure that any returned ResourceIterable is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Returns:
    
    a new transaction instance
  - beginTx
```
Transaction beginTx(long timeout,
                    TimeUnit unit)
```
    Starts a new transaction with custom timeout and associates it with the current thread. Timeout will be taken into account only when execution guard is enabled.
    All database operations must be wrapped in a transaction.
    If you attempt to access the graph outside of a transaction, those operations will throw NotInTransactionException.
    Please ensure that any returned ResourceIterable is closed correctly and as soon as possible inside your transaction to avoid potential blocking of write operations.
    
    Parameters:
    
    timeout - transaction timeout
    
    unit - time unit of timeout argument
    
    Returns:
    
    a new transaction instance
  - execute
```
Result execute(String query)
        throws QueryExecutionException
```
    Executes a query and returns an iterable that contains the result set. This method is the same as execute(String, java.util.Map) with an empty parameters-map.
    
    Parameters:
    
    query - The query to execute
    
    Returns:
    
    A Result that contains the result set.
    
    Throws:
    
    QueryExecutionException - If the Query contains errors
  - execute
```
Result execute(String query,
               long timeout,
               TimeUnit unit)
        throws QueryExecutionException
```
    Executes a query and returns an iterable that contains the result set. If query will not gonna be able to complete within specified timeout time interval it will be terminated. This method is the same as execute(String, java.util.Map) with an empty parameters-map.
    
    Parameters:
    
    query - The query to execute
    
    timeout - The maximum time interval within which query should be completed.
    
    unit - time unit of timeout argument
    
    Returns:
    
    A Result that contains the result set.
    
    Throws:
    
    QueryExecutionException - If the Query contains errors
  - execute
```
Result execute(String query,
               Map<String,Object> parameters)
        throws QueryExecutionException
```
    Executes a query and returns an iterable that contains the result set.
    
    Parameters:
    
    query - The query to execute
    
    parameters - Parameters for the query
    
    Returns:
    
    A Result that contains the result set
    
    Throws:
    
    QueryExecutionException - If the Query contains errors
  - execute
```
Result execute(String query,
               Map<String,Object> parameters,
               long timeout,
               TimeUnit unit)
        throws QueryExecutionException
```
    Executes a query and returns an iterable that contains the result set. If query will not gonna be able to complete within specified timeout time interval it will be terminated.
    
    Parameters:
    
    query - The query to execute
    
    parameters - Parameters for the query
    
    timeout - The maximum time interval within which query should be completed.
    
    unit - time unit of timeout argument
    
    Returns:
    
    A Result that contains the result set
    
    Throws:
    
    QueryExecutionException - If the Query contains errors
  - registerTransactionEventHandler
```
<T> TransactionEventHandler<T> registerTransactionEventHandler(TransactionEventHandler<T> handler)
```
    Registers handler as a handler for transaction events which are generated from different places in the lifecycle of each transaction. To guarantee that the handler gets all events properly it shouldn't be registered when the application is running (i.e. in the middle of one or more transactions). If the specified handler instance has already been registered this method will do nothing.
    
    Type Parameters:
    
    T - the type of state object used in the handler, see more documentation about it at TransactionEventHandler.
    
    Parameters:
    
    handler - the handler to receive events about different states in transaction lifecycles.
    
    Returns:
    
    the handler passed in as the argument.
  - unregisterTransactionEventHandler
```
<T> TransactionEventHandler<T> unregisterTransactionEventHandler(TransactionEventHandler<T> handler)
```
    Unregisters handler from the list of transaction event handlers. If handler hasn't been registered with registerTransactionEventHandler(TransactionEventHandler) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the handler will no longer receive any transaction events.
    
    Type Parameters:
    
    T - the type of state object used in the handler, see more documentation about it at TransactionEventHandler.
    
    Parameters:
    
    handler - the handler to receive events about different states in transaction lifecycles.
    
    Returns:
    
    the handler passed in as the argument.
    
    Throws:
    
    IllegalStateException - if handler wasn't registered prior to calling this method.
  - registerKernelEventHandler
```
KernelEventHandler registerKernelEventHandler(KernelEventHandler handler)
```
    Registers handler as a handler for kernel events which are generated from different places in the lifecycle of the kernel. To guarantee proper behavior the handler should be registered right after the graph database has been started. If the specified handler instance has already been registered this method will do nothing.
    
    Parameters:
    
    handler - the handler to receive events about different states in the kernel lifecycle.
    
    Returns:
    
    the handler passed in as the argument.
  - unregisterKernelEventHandler
```
KernelEventHandler unregisterKernelEventHandler(KernelEventHandler handler)
```
    Unregisters handler from the list of kernel event handlers. If handler hasn't been registered with registerKernelEventHandler(KernelEventHandler) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the handler will no longer receive any kernel events.
    
    Parameters:
    
    handler - the handler to receive events about different states in the kernel lifecycle.
    
    Returns:
    
    the handler passed in as the argument.
    
    Throws:
    
    IllegalStateException - if handler wasn't registered prior to calling this method.
  - schema
```
Schema schema()
```
    Returns the schema manager where all things related to schema, for example constraints and indexing on labels.
    
    Returns:
    
    the schema manager for this database.
  - index
```
@Deprecated
IndexManager index()
```
    Deprecated. The IndexManager based indexes will be removed in the next major release. Please consider using schema indexes instead.
    
    Returns the IndexManager paired with this graph database service and is the entry point for managing indexes coupled with this database.
    
    Returns:
    
    the IndexManager for this database.
  - traversalDescription
```
TraversalDescription traversalDescription()
```
    Factory method for unidirectional traversal descriptions.
    
    Returns:
    
    a new TraversalDescription
  - bidirectionalTraversalDescription
```
BidirectionalTraversalDescription bidirectionalTraversalDescription()
```
    Factory method for bidirectional traversal descriptions.
    
    Returns:
    
    a new BidirectionalTraversalDescription

Interface GraphDatabaseService

Method Summary

Method Detail

createNode

createNodeId

createNode

getNodeById

getRelationshipById

getAllNodes

getAllRelationships

findNodes

findNodes

findNodes

findNodes

findNodes

findNode

findNodes

getAllLabelsInUse

getAllRelationshipTypesInUse

getAllLabels

getAllRelationshipTypes

getAllPropertyKeys

isAvailable

shutdown

beginTx

beginTx

execute

execute

execute

execute

registerTransactionEventHandler

unregisterTransactionEventHandler

registerKernelEventHandler

unregisterKernelEventHandler

schema

index

traversalDescription

bidirectionalTraversalDescription