Skip to content

Commit 8d88bbc

Browse files
committed
Update README
1 parent 627e9d1 commit 8d88bbc

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,21 @@ A database driver for Neo4j 3.0.0+.
55
Resources to get you started:
66

77
- Detailed docs _Not available yet_
8-
- [Sample small project using the driver](https://github.com/neo4j-examples/movies-javascript-bolt)
9-
- [Sample application using the driver](https://github.com/neo4j-examples/neo4j-movies-template)
108
- [Neo4j Manual](https://neo4j.com/docs/)
119
- [Neo4j Refcard](https://neo4j.com/docs/cypher-refcard/current/)
1210

1311
## What's New
1412

1513
- Introduces a brand new reactive API (built on top of RxJS) available with 4.0 version server, which includes reactive protocol improvements.
1614
- Session instances can now be acquired against a specific database against a multi-database server, which is available with 4.0 version server.
15+
- A new `driver.verifyConnectivity()` method is introduced for connectivity verification purposes.
1716

1817
## Breaking Changes
1918

2019
- Driver API is moved from `neo4j.v1` to `neo4j` namespace.
21-
- `driver#session()` method now makes use of object destructuring rather than positional arguments.
20+
- `driver#session()` method now makes use of object destructuring rather than positional arguments (see [Acquiring a Session](#acquiring-a-session) for examples).
2221
- `session#close()` now returns a `Promise` and no more accepts a callback function argument.
23-
- `driver.onError` callback is removed and errors should be monitored on related code paths (i.e. through `Promise#catch`, etc.).
22+
- `driver.onError` and `driver.onCompleted` callbacks are completely removed. Errors should be monitored on related code paths (i.e. through `Promise#catch`, etc.).
2423
- `bolt+routing` scheme is now renamed to `neo4j`. `neo4j` scheme is designed to work work with all possible 4.0 server deployments, but `bolt` scheme is still available for explicit single instance connections.
2524

2625
## Including the Driver
@@ -99,7 +98,7 @@ driver.close()
9998
// Create a driver instance, for the user neo4j with password neo4j.
10099
// It should be enough to have a single driver per database per application.
101100
var driver = neo4j.driver(
102-
'bolt://localhost',
101+
'neo4j://localhost',
103102
neo4j.auth.basic('neo4j', 'neo4j')
104103
)
105104

@@ -249,7 +248,7 @@ rxSession
249248
// retries on network fluctuations and transient errors. Maximum retry time is
250249
// configured on the driver level and is 30 seconds by default:
251250
// Applies both to standard and reactive sessions.
252-
neo4j.driver('bolt://localhost', neo4j.auth.basic('neo4j', 'neo4j'), {
251+
neo4j.driver('neo4j://localhost', neo4j.auth.basic('neo4j', 'neo4j'), {
253252
maxTransactionRetryTime: 30000
254253
})
255254
```
@@ -476,7 +475,7 @@ To enable potentially lossy integer values use the driver's configuration object
476475

477476
```javascript
478477
var driver = neo4j.driver(
479-
'bolt://localhost',
478+
'neo4j://localhost',
480479
neo4j.auth.basic('neo4j', 'neo4j'),
481480
{ disableLosslessIntegers: true }
482481
)

0 commit comments

Comments
 (0)