Skip to content

docs: entity prereqs #3208

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

Draft
shorgi wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: entity prereqs #3208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/source/schema-design/federated-schemas/entities/define-advanced-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ subtitle: Define and use compound keys, nested key fields, and more
description: Learn how to define compound keys, nested key fields, and multiple keys for the same entity in a federated GraphQL architecture.
---

<Note title="Prerequisite">

Understand how to [define a single key](/graphos/schema-design/federated-schemas/entities/intro#1-define-a-key) for an entity.

</Note>

Depending on your entities' fields and usage, you may need to use more advanced `@key`s.
For example, you may need to define a [compound `@key`](#compound-keys) if multiple fields are required to uniquely identify an entity.
If different subgraphs interact with different fields of an entity, you may need to define [multiple](#multiple-keys)&mdash;and sometimes [differing](#differing-keys-across-subgraphs)&mdash;`@key`s for the entity.
Expand Down
6 changes: 6 additions & 0 deletions docs/source/schema-design/federated-schemas/entities/migrate-fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ description: Learn how to safely move parts of one subgraph to another subgraph

import ProgressiveOverrideEnterprise from '../../../../shared/progressive-override-enterprise.mdx';

<Note title="Prerequisite">

Understand how to [define entity fields for a subgraph](/graphos/schema-design/federated-schemas/contribute-fields).

</Note>

As your supergraph grows, you might want to move parts of one subgraph to another subgraph.
For example, suppose your Payments subgraph defines a `Bill` entity:

Expand Down