Skip to content

Add UUID packstream type - #86

Open
gjmwoods wants to merge 7 commits into
neo4j:mainfrom
gjmwoods:uuid
Open

gjmwoods wants to merge 7 commits into
neo4j:mainfrom
gjmwoods:uuid

Conversation

@gjmwoods

@gjmwoods gjmwoods commented Jul 2, 2026

Copy link
Copy Markdown

No description provided.


[[data-type-uuid]]
=== `UUID`
label:new[Introduced in bolt 6.1]

@robsdedude robsdedude Jul 2, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it'd make more sense to conceptualize this as PackStream version 2 and note somewhere that Bolt < 6.1 uses PackStream v1 while Bolt ≥ 6.1 uses PackStream v2. There already is a headline reading "Version 1" on this page.

Good places to mention which PackStream version belongs to which bolt version:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe version 1.1, would also be reasonable as this change is additive (if we go with 1.1 some driver ADRs and file names in drivers might need updating).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we actually need to version packstream at all? Is it relevant to client devs, or is Bolt 6.1 enough?

E0 55 0E 84 00 E2 9B 41 D4 A7 16 44 66 55 44 00 00
```

==== Unsupported Bolt Versions

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and the following sub-sections feel out of place. I agree that documenting this is a good idea, but maybe it should be in a separate place. Vector types also have similar fallbacks, but those are undocumented.

It's also not really a protocol spec, is it? It's an implementation detail of neo4j. Other bolt-aware servers might want to choose to reply with FAILURE instead for instance.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took this out since you're right its odd that it's here. I will card up a separate one to think about where the best place is since I do think its useful

@stefano-ottolenghi

Copy link
Copy Markdown
Contributor

@gjmwoods Please don't break sentences with newlines. The practice in docs is to use newlines for new sentences (i.e. after a full stop), regardless of their length.

@gjmwoods

Copy link
Copy Markdown
Author

Apologies in the delay in progressing this PR. I'm waiting for Rouven to get back so we can have a more synchronous discussion on the best way to surface the UUID in the docs that makes sense.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We must not forget to also update

  • bolt-compatibility.adoc
  • message.adocmessage.adoc to mention that starting with bolt 6.1 UUID is supported / PackStream v2/v1.1 is being used.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@robsdedude robsdedude left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving comments from today's discussion meeting.

Comment thread modules/ROOT/pages/packstream/index.adoc Outdated
Comment thread modules/ROOT/pages/packstream/index.adoc
Comment thread modules/ROOT/pages/packstream/index.adoc
Comment thread modules/ROOT/pages/packstream/index.adoc Outdated
Co-authored-by: Stefano <stefano.ottolenghi@neo4j.com>
Comment thread modules/ROOT/pages/packstream/index.adoc Outdated
Co-authored-by: Robsdedude <dev@rouvenbauer.de>
@neo4j-docops-agent

Copy link
Copy Markdown
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-bolt-86.surge.sh

Updated pages:

@stefano-ottolenghi

Copy link
Copy Markdown
Contributor

@robsdedude i think we're all good here, safe to merge?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants