Skip to content
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

chore: added cascade delete section for Has Many and Has One relation… #8187

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,29 @@ do {

</InlineFilter>

### Handling orphaned foreign keys on parent record deletion in "Has Many" relationship

<InlineFilter filters={["javascript", "angular", "react-native", "react", "nextjs", "vue"]}>

```ts
// Get the IDs of the related members.
const { data: teamWithMembers } = await client.models.Team.get(
{ id: teamId},
{ selectionSet: ["id", "members.*"] },
);

// Delete Team
await client.models.Team.delete({ id: teamWithMembers.id });

// Delete all members in parallel
await Promise.all(
teamWithMembers.members.map(member =>
client.models.Member.delete({ id: member.id })
));
```

</InlineFilter>

## Model a "one-to-one" relationship

Create a one-to-one relationship between two models using the `hasOne()` and `belongsTo()` methods. In the example below, a **Customer** has a **Cart** and a *Cart* belongs to a **Customer**.
Expand Down Expand Up @@ -794,6 +817,26 @@ val cart = Amplify.API.query(

</InlineFilter>

### Handling orphaned foreign keys on parent record deletion in "Has One" relationship

<InlineFilter filters={["javascript", "angular", "react-native", "react", "nextjs", "vue"]}>

```ts
// Get the customer with their associated cart
const { data: customerWithCart } = await client.models.Customer.get(
{ id: customerId },
{ selectionSet: ["id", "activeCart.*"] },
);

// Delete Cart if exists
await client.models.Cart.delete({ id: customerWithCart.activeCart.id });

// Delete the customer
await client.models.Customer.delete({ id: customerWithCart.id });
```

</InlineFilter>


## Model a "many-to-many" relationship
In order to create a many-to-many relationship between two models, you have to create a model that serves as a "join table". This "join table" should contain two one-to-many relationships between the two related entities. For example, to model a **Post** that has many **Tags** and a **Tag** has many **Posts**, you'll need to create a new **PostTag** model that represents the relationship between these two entities.
Expand Down
Loading