golang/ent
1
0
Fork 0
mirror of https://github.com/ent/ent.git synced 2026-04-29 14:10:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: document the NodeType option for Node API (#817)

Browse Source
This commit is contained in:
Ariel Mashraki
2020-10-04 18:03:07 +03:00
committed by GitHub
parent cd0a79e821
commit f548d8aacc
1 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/md/graphql.md
View File

@@ -62,17 +62,27 @@ After running codegen, the following add-ons will be added to your project.
A new file named `ent/node.go` was created that implements the [Relay Node interface](https://relay.dev/docs/en/graphql-server-specification.html#object-identification).
In order to use the new generated `ent.Noder` interface in the [GraphQL resolver](https://gqlgen.com/reference/resolvers/),
add the `Node` method to the query resolver, and see the [configuration](#gql-configuration) section to understand
add the `Node` method to the query resolver, and look at the [configuration](#gql-configuration) section to understand
how to use it.
If you are using the [Universal IDs](migrate.md#universal-ids) option in the schema migration, the NodeType is derived
from the id value and can be used as follows:
```go
func (r *queryResolver) Node(ctx context.Context, id int) (ent.Noder, error) {
return r.client.Noder(ctx, id)
}
```
Note that schema migration must be configured with the [Universal IDs](migrate.md#universal-ids) option if you want
ent to resolve the "type from id" for you.
However, if you use a custom format for the global unique identifiers, you can control the NodeType as follows:
```go
func (r *queryResolver) Node(ctx context.Context, guid string) (ent.Noder, error) {
typ, id := parseGUID(guid)
return r.client.Noder(ctx, id, ent.WithNodeType(typ))
}
```
## GQL Configuration
@@ -297,4 +307,4 @@ func (mutationResolver) CreateTodo(ctx context.Context, todo TodoInput) (*ent.To
---
Please note that this documentation is under development. All code parts reside in [ent-contrib/entgql](https://github.com/facebookincubator/ent-contrib/tree/master/entgql),
and an example of a todo-app can be found in [ent-contrib/entql/todo](https://github.com/facebookincubator/ent-contrib/tree/master/entgql/internal/todo).
and an example of a todo-app can be found in [ent-contrib/entql/todo](https://github.com/facebookincubator/ent-contrib/tree/master/entgql/internal/todo).