DATAGRAPH-909 - Bolt driver dependencies documented.

This commit is contained in:
Luanne Misquitta
2016-09-16 16:25:26 +04:00
parent b15270159c
commit 6c1f93a03d
5 changed files with 19 additions and 6 deletions

View File

@@ -58,7 +58,7 @@ It supports:
* automatic mapping annotated domain entities for nodes and relationships
* interface based repositories with provided, derived, and annotated finder methods
* transaction control
* multi-transport (embedded, http, [bolt])
* multi-transport (HTTP, Embedded, Bolt)
* exception translation
* integration into Spring Data REST
* works well within Spring Boot
@@ -124,7 +124,7 @@ public class MyConfiguration extends Neo4jConfiguration {
----
Spring Data Neo4j 4.1 provides support for connecting to Neo4j using different drivers.
HTTP and Embedded drivers are available.
HTTP, Embedded and Bolt drivers are available.
Spring Data Neo4j will attempt to auto-configure itself using a file called `ogm.properties`, which it expects to find on the classpath.
.ogm.properties

View File

@@ -5,7 +5,7 @@ Michael Hunger; Oliver Gierke; Vince Bickers; Adam George; Luanne Misquitta; Mic
:revnumber: {version}
:revdate: {localdate}
Spring Data Neo4j Version 4.1 (April 2016)
Spring Data Neo4j Version 4.1.3 (Sept. 2016)
(C) 2010-2016 Graph Aware Ltd - Neo Technology, Inc. - Pivotal Software, Inc.

View File

@@ -3,7 +3,7 @@
[[reference_neo4j-server]]
= Neo4j Server
Neo4j is not only available in embedded mode. It can also be installed and run as a stand-alone server accessible via a HTTP API.
Neo4j is not only available in embedded mode. It can also be installed and run as a stand-alone server accessible via an HTTP API or the Bolt binary protocol.
Developers can integrate Spring Data Neo4j into the Neo4j server infrastructure in two ways: as a server extension, or remotely via the HTTP API.
Spring Data Neo4j was historically built around the Neo4j embedded Java APIs, but are not optimized for remote usage.

View File

@@ -15,7 +15,7 @@ For version 4.0, Spring Data Neo4j was rewritten from scratch to natively suppor
It uses Cypher, the Neo4j query language, and the HTTP protocol to communicate with the database.
It's therefore worth noting that there *will be backward compatibility issues* when migrating to version 4.x, so be sure to check the <<migration,Migration Guide>> to avoid any unwanted surprises.
Version 4.1 introduces support for connecting to an embedded instance of Neo4j.
Version 4.1 introduces support for connecting to an embedded instance of Neo4j, and support for connecting to a remote instance via the binary Bolt protocol.
For integration of Neo4j and other languages, please see http://neo4j.com/developer/language-guides/[Language Guides].

View File

@@ -31,6 +31,13 @@ If you want to use the embedded driver in your production application, you must
<artifactId>neo4j-ogm-embedded-driver</artifactId>
<version>{ogm-version}</version>
</dependency>
<!-- add this dependency if you want to use the Bolt driver -->
<dependency>
<groupId>org.neo4j</groupId>
<artifactId>neo4j-ogm-bolt-driver</artifactId>
<version>{ogm-version}</version>
</dependency>
----
.Gradle dependencies
@@ -40,6 +47,8 @@ dependencies {
compile 'org.springframework.data:spring-data-neo4j:{version}'
# add this dependency if you want to use the embedded driver
compile 'org.neo4j:neo4j-ogm-embedded-driver:{ogm-version}'
# add this dependency if you want to use the Bolt driver
compile 'org.neo4j:neo4j-ogm-bolt-driver:{version}'
}
----
@@ -49,6 +58,9 @@ dependencies {
<dependency org="org.springframework.data" name="spring-data-neo4j" rev="{version}"/>
<!-- add this dependency if you want to use the embedded driver -->
<dependency org="org.neo4j" name="neo4j-ogm-embedded-driver" rev="{ogm-version}"/>
<!-- add this dependency if you want to use the Bolt driver -->
<dependency org="org.neo4j" name="neo4j-ogm-bolt-driver" rev="{version}"/>
----
== Spring configuration
@@ -96,6 +108,7 @@ The following drivers are available.
- Http driver
- Embedded driver
- Bolt driver
By default, SDN 4.1 will try to configure the driver from a file `ogm.properties`, which it expects to find on the classpath.
In many cases you won't want to, or will not be able to provide configuration information via a properties file.
@@ -147,7 +160,7 @@ public SessionFactory getSessionFactory() {
_Note: Please see the section below describing the different ways you can pass credentials to the Http Driver_
=== Configuring the Bolt Driver
==== Configuring the Bolt Driver
The Bolt Driver connects to and communicates with a Neo4j server via the binary Bolt protocol. If your application is running in client-server mode, you must use either the HTTP or Bolt driver.