Skip to content

Clarify the order of changes in CDC #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 20, 2025
Merged

Clarify the order of changes in CDC #73

merged 5 commits into from
Jan 20, 2025

Conversation

nvitucci
Copy link
Contributor

No description provided.

* Node deletions
* Relationship deletions

Note that the order of changes in the output is **not guaranteed** to match exactly the order of changes occurring in the transaction.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd put this as leading sentence for the section (without Note that), as the listed ordering is a further explanation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think of this as a clarification instead, since the section is about the order within the output rather than in the transaction, but I'm fine either way. I'm including the change.


Note that the order of changes in the output is **not guaranteed** to match exactly the order of changes occurring in the transaction.

CDC tracks logical changes only; therefore, if two or more changes cancel each other (for example, a `DELETE` following a `CREATE` on the same node), none is included in the change stream.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CDC tracks logical changes only; therefore, if two or more changes cancel each other (for example, a `DELETE` following a `CREATE` on the same node), none is included in the change stream.
CDC tracks logical changes only: if two or more changes cancel each other out (for example, a `DELETE` following a `CREATE` on the same node), none is included in the change stream.

Also, is logical the right term here? It may be and I just don't know it; otherwise, something like effective could be more descriptive.

Copy link
Contributor Author

@nvitucci nvitucci Jan 20, 2025

Choose a reason for hiding this comment

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

Good catch for the missing out.

I think logical is the right term here, as opposed to physical (see also the question on the forum that sparked this update), both commonly used in database-related topics. If we want to make it less technical (if slightly more ambiguous), we could use actual.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(Or remove it altogether.)

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think actual makes it more ambiguous; if anything, I think logical vs physical is ambiguous. What's the physical change? Is it the bits being altered in the file containing the changed entity? Is it a struct field being rewritten? Or is, as Rory says in that topic, the creation of a whole graph entity? That's much more ambiguous to me, and so is logical.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's go with actual then.

@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@nvitucci nvitucci merged commit 464d92a into dev Jan 20, 2025
5 checks passed
@nvitucci nvitucci deleted the clarify-change-order branch January 20, 2025 14:13
nvitucci added a commit that referenced this pull request Jan 22, 2025
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.

3 participants