Skip to content

Fix docs for aggregation default 3.x #148

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.

Sign up for GitHub

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 2 commits into from
May 27, 2024
Merged

Fix docs for aggregation default 3.x #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
decf733
Revert "Revert "removed an admonition box with doc changes which neve…
rsill-neo4j May 15, 2024
6dde83a
removed section on aggregation opt-in
rsill-neo4j May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions modules/ROOT/pages/guides/v4-migration/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,27 +559,6 @@ const neoSchema = new Neo4jGraphQL({
})
----

[[opt-in-aggregation]]
=== Opt-in Aggregation

Aggregation operations are no longer generated by default.
They can be enabled case by case using the directives xref::type-definitions/schema-configuration/type-configuration.adoc#_query[`@query`] and xref::type-definitions/schema-configuration/field-configuration.adoc#_relationship[`@relationship`].


You can enable the operation fields `actorsAggregate` and `actedInAggregate` like this:

[source, graphql, indent=0]
----
type Movie {
title: String!
}

type Actor @query(aggregate: true) {
name: String!
actedIn: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT, aggregate: true)
}
----

=== Session configuration

Session configuration is now available only in the context under the `sessionConfig` key.
Expand Down
6 changes: 0 additions & 6 deletions modules/ROOT/pages/type-definitions/schema-configuration/type-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,6 @@ This directive is used to limit the availability of query operations in the libr
directive @query(read: Boolean! = true, aggregate: Boolean! = false) on OBJECT | SCHEMA
----

[NOTE]
====
Aggregations will no longer be generated by default in the 4.0.0 version of the library.
See xref::guides/v4-migration/index.adoc#opt-in-aggregation[`Opt-in Aggregation`] for more information.
====

=== Usage

==== Disable _movies_ and _moviesConnection_ operations
Expand Down