Skip to content

Commit

Permalink
Mention NewDriverWithContext does not exercise URI/credentials
Browse files Browse the repository at this point in the history
  • Loading branch information
fbiville committed May 2, 2023
1 parent df4a6c1 commit 4d3f387
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions neo4j/driver_with_context.go
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ type ResultTransformer[T any] interface {
// be called in order to establish a connection to a neo4j database. It requires a Bolt URI and authentication
// as parameters and can also take optional configuration function(s) as variadic parameters.
//
// No connectivity happens when NewDriverWithContext is called.
// Call DriverWithContext.VerifyConnectivity once the driver is created if you want to eagerly check that the provided
// URI and credentials are correct.
//
// In order to connect to a single instance database, you need to pass a URI with scheme 'bolt', 'bolt+s' or 'bolt+ssc'.
//
// driver, err = NewDriverWithContext("bolt://db.server:7687", BasicAuth(username, password))
Expand Down

0 comments on commit 4d3f387

Please # to comment.