dart_neo4j 1.2.1

dart_neo4j: ^1.2.1 copied to clipboard

Allow for running long running queries (#4)

• Add optional timeout parameter to BoltConnection.run (and BoltConnection._sendMessage, with default set to 30 seconds for backward compatibility); the timeout is used on the pull message.
• Add optional timeout parameter to SessionConfiguration (defaults to 30 seconds) and use that timeout when running queries directly over the session.
• Use TransactionConfig.timeout when running queries over a transaction.
• Implement startQuery() methods in addition to the existing run() methods. The existing implementations of run() returns only after all records have been streamed from the server. startQuery() returns before the query has fully executing, allowing for early streaming of records by clients. The query has finished executing when [Result.done] and [Result.summary()] complete (they are based on the same future).

Thanks to d-markey for the contribution.

• Version bump for consistency with dart_neo4j ecosystem

• Version bump for consistency with dart_neo4j ecosystem

BREAKING CHANGES #

• Deprecated id Property: The numeric id property on Node, Relationship, and UnboundRelationship is now deprecated in favor of elementId
  • Use elementId (nullable) or elementIdOrThrow (non-nullable) for Neo4j 5.0+ compatibility
  • The old id property will continue to work but will emit deprecation warnings
  • See Neo4j documentation for migration guidance

New Features #

• Neo4j 5.0+ Element ID Support: Added full support for string-based element IDs
  • Node.elementId: Returns the element ID as a nullable String
  • Node.elementIdOrThrow: Returns the element ID or throws if not available
  • Relationship.elementId: Returns the relationship element ID as a nullable String
  • Relationship.elementIdOrThrow: Returns the relationship element ID or throws if not available
  • UnboundRelationship.elementId: Returns the relationship element ID as a nullable String
  • UnboundRelationship.elementIdOrThrow: Returns the relationship element ID or throws if not available
• Improved Equality Comparisons: Node and Relationship equality now prefers elementId when available, falling back to numeric id for backward compatibility
• Enhanced toString: Node, Relationship, and UnboundRelationship now include elementId in their string representations when available

Improvements #

• Future-Proof Design: Smooth migration path from numeric IDs to element IDs
• Backward Compatibility: Existing code using numeric IDs continues to work with deprecation warnings
• Comprehensive Test Coverage: Added extensive tests for element ID functionality

• Updated Dart SDK requirement to ^3.8.0
• Version bump for consistency with dart_neo4j ecosystem

• Fixed handling of multiple node returns in Cypher queries (RETURN a, b syntax)
• Improved Record.fromBolt to properly handle BoltNode, BoltRelationship, and BoltUnboundRelationship structures
• Enhanced BoltConnection to preserve Bolt structures in record data

• Updated license section in README to correctly reflect GPL-3.0 license

• Initial release of dart_neo4j package.