5.X Change Log

5.7.0

🔬 Experimental/Preview changes

• the Neo4j.Driver.Experimental namespace has been renamed to Neo4j.Driver.Preview. This will be a compile-time breaking change for any code using this namespace. No functionality has been changed.

⭐ New Features

• Introduce notification configuration, severity and category #691
• Introduce IDriver.TryVerifyConnectivityAsync #693 #See issue

5.6.0

No changes.

5.5.0

🔧 Fixes

• The IsRetriable property on exceptions is now public

🔬 Experimental changes

• The ExecutableQuery API has been added to the Experimental namespace (see here for more information)

5.4.0

🔧 Fixes

• Add documentation for SessionConfigBuilder.WithDatabase and SessionConfig.Database
• Exclude test code in snyk code analysis
• TestKit backend: exclude txMeta from Cypher types
• Add new exception types and change to explicitly identifying fast fail errors

5.3.0

🔬 Experimental bookmark manager changes:

• Remove database notions from bookmark manager.
• Fix Bookmark manager references outside of Neo4j.Driver.Experimental namespace.
• When replacing LastBookmark with LastBookmarks we accidentally removed the old property, not following the planned deprecation policy. It is now restored and marked as obsolete, and due for removal in 6.0 of the driver.
• Simplify creation of bookmark manager with default config.

5.2.0

🔬 Experimental change

• Fixed an issue bookmark manager experimental classes: correctly exposing WithBookmarkManager to use bookmark managers on session configuration(#654).

5.1.0

No changes.

5.0.0

No changes.

5.0.0 (Beta02)

final tidying for major release.

Nuget

⭐ New Features

• Introduce Experimental Bookmark Manager. (Not recommended for production use currently.) (#632)
  • Using Neo4j.Driver.Experimental.GraphDatabase.BookmarkManagerFactory users can create an IBookmarkManager.
  • IBookmarkManager can be passed to SessionConfigBuilder when creating a creating a session by using the Neo4j.Driver.Experimental.ExperimentalExtensions to add WithBookmarkManager to SessionConfigBuilder.
  • The Experimental methods will be finalized as:
    • Neo4j.Driver.Experimental.GraphDatabase.BookmarkManagerFactory -> Neo4j.Driver.GraphDatabase.BookmarkManagerFactory
    • Neo4j.Driver.Experimental.ExperimentalExtensions -> Neo4j.Driver.SessionConfigBuilder.

🔧 Fixes

• Transaction lifetimes. (#640)
  • ⚠️ remaining managed transactions have been deprecated and replaced, removing the ability to commit or rollback transactions inside the unit of work scope.
    • ISession.ReadTransaction -> ISession.ExecuteRead
    • ISession.WriteTransaction -> ISession.ExecuteWrite
    • IRxSession.ReadTransaction -> IRxSession.ExecuteRead
    • IRxSession.WriteTransaction -> IRxSession.ExecuteWrite

🧹 Clean-up

• Removal of 4.X Deprecations
  • Removal of IServerInfo.Version (#638)

5.0.0 (Beta01)

This release introduces full support for Neo4j 5.0 Servers.

Nuget

👏 .NET 6 Support

We now release for .NET 6.0 and .NET Standard 2.0.

• Support for DateOnly, TimeOnly types. (#616)

⭐ New Features

• Support for Bolt protocol version 5.0
  • ⚠️ Deprecate all IEntity integer ids replacing them with string ids:
    • IEntity.Id -> IEntity.ElementId
    • INode.Id -> INode.ElementId
    • IRelationship.Id -> IRelationship.ElementId
    • IRelationship.EndNodeId -> IRelationship.EndNodeElementId
    • IRelationship.StartNodeId -> IRelationship.StartNodeElementId
      (#573 #591 #600 #618)
  • Utc Encoding of ZonedDateTime (#630 #637)
• SSL Configuration(#585)
  • SSL certificate trust rules can be set on driver initialization using ConfigBuilder.WithCertificateTrustRule
    • CertificateTrustRule.TrustSystem
      • Will verify certificates against the system's Certificate Authority store.
    • CertificateTrustRule.TrustList
      • Users can specify a collection of X509Certificate2 or paths to load as trusted certificates.
    • CertificateTrustRule.TrustAny
      • Will trust any SSL Cert.
  • ⚠️ Users can not use both ConfigBuilder.WithCertificateTrustRule and +s/+ssc in the url scheme at the same time.
• Added Driver.GetServerInfoAsync. (#605)
  • Will verify connectivity and return a IServerInfo detailing server summary.
• Added CanBeRetried to Exception. (#613)
  • All errors from driver that can be resolved by retrying an operation will return true.
• Add IsOpen to Result cursors. (#610)
  • IsOpen will return if the underlying cursor is open to read records; Attempting to read from a closed cursor will throw a ResultConsumedException.
• Connection Acquisition Timeout (#588)
  • ConfigBuilder.WithConnectionAcquisitionTimeout allows users to set maximum wait time to get a connection from the pool or create a new connection on driver initialization.
  • ⚠️ default: 60 seconds

🔧 Fixes

• Transaction lifetimes. (#612)
  • ⚠️ Async managed transactions have been deprecated and replaced, removing the ability to commit or rollback transactions inside the unit of work scope.
    • IAsyncSession.ReadTransactionAsync -> IAsyncSession.ExecuteReadAsync
    • IAsyncSession.WriteTransactionAsync -> IAsyncSession.ExecuteWriteAsync
  • Attempting close a transaction after it has been closed will now throw a TransactionClosedException.
• Rename Bookmark to Bookmarks. (#609)
  • ⚠️ Due to a mix of language Bookmark and all references to bookmarks have been pluralized as it allows for multiple values.
  • Bookmark -> Bookmarks
  • Session.LastBookmark -> Session.LastBookmarks
  • SessionConfigBuilder.WithBookmarks(Bookmark[]) -> SessionConfigBuilder.WithBookmarks(Bookmarks[])
• Transaction timeout (#574)
  • TransactionConfigBuilder.WithTimeout now accepts Nullable<TimeSpan> for timeout.
    • ⚠️ null will use the server's default transaction timeout.
    • ⚠️ TimeSpan.Zero will remove timeout from transaction.
• No longer throwing when using APOC procedures in a profiled query. (#633)
• Discovery exceptions. (#594)
• Error message handling. (#592)

Full Changelog: https://github.com/neo4j/neo4j-dotnet-driver/compare/4.4.0...5.0.0-beta01