|
Neo4j Community | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface GraphDatabaseService
The main access point to a running Neo4j instance. The most common
implementation is the EmbeddedGraphDatabase class, which is used to
embed Neo4j in an application. Typically, you would create an
EmbeddedGraphDatabase instance as follows:
GraphDatabaseService graphDb = new EmbeddedGraphDatabase( "var/graphDb" );
// ... use Neo4j
graphDb.shutdown();
GraphDatabaseService provides operations to create
nodes, get nodes given an id, get the
reference node and ultimately shutdown Neo4j.
Please note that all operations that write to the graph must be invoked in a
transactional context. Failure to do so will result in a
NotInTransactionException being thrown.
| Method Summary | ||
|---|---|---|
Transaction |
beginTx()
Starts a new transaction and associates it with the current thread. |
|
Node |
createNode()
Creates a new node. |
|
Iterable<Node> |
getAllNodes()
Deprecated. this operation can be found in GlobalGraphOperations instead. |
|
Node |
getNodeById(long id)
Looks up a node by id. |
|
Node |
getReferenceNode()
Deprecated. The reference node concept is obsolete - indexes are the canonical way of getting hold of entry points in the graph. |
|
Relationship |
getRelationshipById(long id)
Looks up a relationship by id. |
|
Iterable<RelationshipType> |
getRelationshipTypes()
Deprecated. this operation can be found in GlobalGraphOperations instead. |
|
IndexManager |
index()
Returns the IndexManager paired with this graph database service
and is the entry point for managing indexes coupled with this database. |
|
KernelEventHandler |
registerKernelEventHandler(KernelEventHandler handler)
Registers handler as a handler for kernel events which
are generated from different places in the lifecycle of the kernel. |
|
|
registerTransactionEventHandler(TransactionEventHandler<T> handler)
Registers handler as a handler for transaction events which
are generated from different places in the lifecycle of each
transaction. |
|
void |
shutdown()
Shuts down Neo4j. |
|
KernelEventHandler |
unregisterKernelEventHandler(KernelEventHandler handler)
Unregisters handler from the list of kernel event handlers. |
|
|
unregisterTransactionEventHandler(TransactionEventHandler<T> handler)
Unregisters handler from the list of transaction event handlers. |
|
| Method Detail |
|---|
Node createNode()
Node getNodeById(long id)
id - the id of the node
id if found
NotFoundException - if not foundRelationship getRelationshipById(long id)
id - the id of the relationship
id if found
NotFoundException - if not found@Deprecated Node getReferenceNode()
NotFoundException - if unable to get the reference nodeIterable<Node> getAllNodes()
GlobalGraphOperations instead.
Iterable<RelationshipType> getRelationshipTypes()
GlobalGraphOperations instead.
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).
void shutdown()
Transaction beginTx()
<T> TransactionEventHandler<T> registerTransactionEventHandler(TransactionEventHandler<T> handler)
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.
T - the type of state object used in the handler, see more
documentation about it at TransactionEventHandler.handler - the handler to receive events about different states
in transaction lifecycles.
<T> TransactionEventHandler<T> unregisterTransactionEventHandler(TransactionEventHandler<T> handler)
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.
T - the type of state object used in the handler, see more
documentation about it at TransactionEventHandler.handler - the handler to receive events about different states
in transaction lifecycles.
IllegalStateException - if handler wasn't registered prior
to calling this method.KernelEventHandler registerKernelEventHandler(KernelEventHandler handler)
handler as a handler for kernel events which
are generated from different places in the lifecycle of the kernel.
To guarantee proper behaviour 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.
handler - the handler to receive events about different states
in the kernel lifecycle.
KernelEventHandler unregisterKernelEventHandler(KernelEventHandler handler)
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.
handler - the handler to receive events about different states
in the kernel lifecycle.
IllegalStateException - if handler wasn't registered prior
to calling this method.IndexManager index()
IndexManager paired with this graph database service
and is the entry point for managing indexes coupled with this database.
IndexManager for this database.
|
Neo4j Community | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||