Skip to content

Entity and connections API#308

Merged
rsill-neo4j merged 10 commits into
7.xfrom
entity-api-vs-connections-api
Apr 29, 2026
Merged

Entity and connections API#308
rsill-neo4j merged 10 commits into
7.xfrom
entity-api-vs-connections-api

Conversation

@rsill-neo4j
Copy link
Copy Markdown
Contributor

No description provided.

== Distinction

The API split is mainly due to development-historic reasons.
The entity API came first and is simpler and more performant, while the connections API allows for relationship traversal, accessing relationship fields, aggregations and more.
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.

While this is partially true, I don't think it is too relevant for users the historic reasons.

Just stating the main differenceces should be enough: Entity API allows for simple traversal, whilst connectons API allow access to relationship proerties, more complex features (such aggregations) and it is Relay compatible

Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated

== Links

* xref:directives/schema-configuration/index.adoc[] - Configure your schema and limit field accessibility
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.

I think all these topics should have a full stop, maybe? And follow the same style

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

added suggestions

Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Co-authored-by: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com>
Co-authored-by: Richard Sill <156673635+rsill-neo4j@users.noreply.github.com>
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
@neo4j-docops-agent
Copy link
Copy Markdown
Collaborator

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

New pages:

Updated pages:

Comment thread modules/ROOT/pages/entity-and-connections-api.adoc Outdated
Comment thread modules/ROOT/pages/entity-and-connections-api.adoc
Co-authored-by: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com>
@rsill-neo4j rsill-neo4j merged commit 11ca0d6 into 7.x Apr 29, 2026
5 checks passed
@rsill-neo4j rsill-neo4j deleted the entity-api-vs-connections-api branch April 29, 2026 07:20
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