Referential actions in the Prisma Schema Language #1947

pimeys · 2021-05-20T15:03:28Z

Supported actions: Cascade, Restrict, NoAction, SetNull and SetDefault.

Per-database validation, e.g. Restrict doesn't validate on SQL Server.

Defaults to:

onUpdate: Cascade on optional and Cascade on required relations.
onDelete: SetNull on optional and Restrict on required relations.

Required work

PSL
ME
IE
Language server should autocomplete only the allowed actions.
Query Engine should not emulate any of the actions if the database supports them.

Closes: prisma/prisma#2810
Closes: prisma/prisma#5782
Closes: prisma/prisma#4711

Supported actions: `Cascade`, `Restrict`, `NoAction`, `SetNull` and `SetDefault`. Per-database validation, e.g. `Restrict` doesn't validate on SQL Server. Defaults to: - `onUpdate`: `SetNull` on optional and `Cascade` on required relations. - `onDelete`: `SetNull` on optional and `Restrict` on required relations. Currently ALWAYS renders the actions on introspection, due to the database always has some action set.

Mark some places that require work.

introspection-engine/introspection-engine-tests/tests/commenting_out/mod.rs

Call it with starting prisma-fmt with subcommand referential actions. STDIN takes the data model and stdout lists all allowed actions.

pimeys · 2021-06-21T13:14:02Z

Note: "Currently ALWAYS renders the actions on introspection, due to the database always has some action set." Should not be the case if the introspected action matches the default.

We haven't been doing this for some weeks already. Updated the original comment to reflect the reality.

If even one underlying scalar field is required, the default referential action should not be `SetNull`.

tomhoule

Leaving a first small batch of comments. Still lots I haven't read, it's going to take some time.

introspection-engine/introspection-engine-tests/src/lib.rs

introspection-engine/introspection-engine-tests/src/test_api.rs

tomhoule · 2021-06-22T09:10:03Z

libs/datamodel/connectors/dml/src/datamodel.rs

@@ -117,7 +117,7 @@ impl Datamodel {
        let mut fields = vec![];
        for model in self.models() {
            for field in model.scalar_fields() {
-                if FieldType::Enum(enum_name.to_owned()) == field.field_type {
+                if field.field_type.is_enum(enum_name) {


libs/datamodel/connectors/dml/src/relation_info.rs

tomhoule · 2021-06-22T09:40:53Z

libs/datamodel/connectors/dml/src/relation_info.rs

 }

 /// Describes what happens when related nodes are deleted.
+#[repr(u8)]
+#[bitflags]


I find this weird — a given relation has a single referential action, so it should be a regular enum, right?

Or is that impl used to denote the set of available referential actions for a connector? I'll continue reading.

Your guess was right. We can set multiple of them in the connector.

I'm wondering if the extra dependency is pulling its weight, but it's fine for now.

libs/datamodel/connectors/dml/src/relation_info.rs

libs/datamodel/connectors/sql-datamodel-connector/src/mysql_datamodel_connector.rs

libs/datamodel/connectors/datamodel-connector/src/lib.rs

tomhoule

A few more comments. I'll continue reading.

tomhoule · 2021-06-22T12:54:08Z

migration-engine/connectors/sql-migration-connector/src/sql_schema_differ.rs

+        matches && same_on_delete_action && same_on_update_action
+    } else {
+        matches
+    }


libs/datamodel/core/src/lib.rs

tomhoule · 2021-06-22T13:02:15Z

libs/datamodel/core/tests/render_to_dmmf/files/general.json

@@ -600,7 +597,7 @@
          "relationName": "AToB",
          "relationFromFields": [],
          "relationToFields": [],
-          "relationOnDelete": "NONE",


Hmm interesting, so we are not returning this anymore in case of None? Could it break something typescript-side?

Asked from the ts team.

ping @millsp @williamluke4 @Jolg42 will we break some of your code?

We'll need to remove it from our typings and update some snapshots. All good on TS side.

@steebchen will also need to remove it from Go Client.
and @madebysid from Studio

Also, I see some projects also have it defined and will need to remove it, like Amplication.

I don't use this atm so no problem for me

I don't use it either, all good.

Actually, nothing to change in TS since the field is not removed but not always passed
https://github.com/prisma/prisma/blob/7ac84453f9e096fbe6652bc0a68e2a47e15ba344/src/packages/generator-helper/src/dmmf.ts#L84

Because it's an optional field typed to string.

tomhoule · 2021-06-22T13:05:45Z

libs/test-macros/src/lib.rs

+                    }
+                }
+
+                return Ok(());


tomhoule

One last batch of comments/questions, but I'm done reading. I think maybe @do4gr should look at the introspection tests if possible, but in general ✔️

tomhoule · 2021-06-22T14:41:37Z

libs/datamodel/connectors/datamodel-connector/src/lib.rs

@@ -193,7 +205,7 @@ pub enum ConnectorCapability {
 /// Contains all capabilities that the connector is able to serve.
 #[derive(Debug)]
 pub struct ConnectorCapabilities {
-    capabilities: Vec<ConnectorCapability>,
+    pub capabilities: Vec<ConnectorCapability>,


Does this need to be public? Didn't check but I think there is an accessor.

no it should not be public

ah, @dpetrick needs it, so will leave it as-is

tomhoule · 2021-06-22T14:51:17Z

libs/datamodel/connectors/dml/src/relation_info.rs

 }

 /// Describes what happens when related nodes are deleted.
+#[repr(u8)]
+#[bitflags]


I'm wondering if the extra dependency is pulling its weight, but it's fine for now.

tomhoule · 2021-06-22T14:53:38Z

migration-engine/migration-engine-tests/tests/migrations/relations.rs

+                .assert_referential_action_on_update(ForeignKeyAction::Cascade)
+        })
+    });
+}


tomhoule · 2021-06-22T14:58:38Z

libs/datamodel/core/tests/attributes/relations/referential_actions.rs

+        );
+
+        let message = format!(
+            "Invalid referential action: `{}`. Allowed values: (`Restrict`, `SetNull`)",


Is this to align with current QE behaviour? I don't really understand what the PlanetScale situation after this PR is going to be.

The planetscale should emulate the referential actions. If the mode is enabled. @dpetrick can decide which modes are enabled, but currently the emulation is WIP and not part of this PR.

libs/datamodel/core/src/transform/ast_to_dml/validate.rs

pimeys marked this pull request as draft May 20, 2021 15:03

pimeys force-pushed the referential-actions branch 9 times, most recently from 9c92ac3 to 8d46dca Compare May 25, 2021 17:14

pimeys force-pushed the referential-actions branch from 8d46dca to 9fccafd Compare May 28, 2021 11:35

pimeys mentioned this pull request Jun 2, 2021

Enable cascading delete behaviour with onDelete: CASCADE prisma/prisma#4711

Closed

pimeys force-pushed the referential-actions branch from 7483bc3 to 2def366 Compare June 2, 2021 15:50

pimeys added this to the 2.25.0 milestone Jun 2, 2021

pimeys marked this pull request as ready for review June 2, 2021 16:13

Do not render default referential actions

18ac766

pimeys force-pushed the referential-actions branch from 2def366 to 18ac766 Compare June 2, 2021 19:35

Remove legacy cascades.

feef5f3

Mark some places that require work.

janpio reviewed Jun 4, 2021

View reviewed changes

introspection-engine/introspection-engine-tests/tests/commenting_out/mod.rs Outdated Show resolved Hide resolved

Julius de Bruijn and others added 7 commits June 7, 2021 11:26

Emulated actions

d4b9fc0

First pass over the graph

efa606e

Merge branch 'referential-actions' into query-engine/referential_actions

28634ef

Experiments with deletion checks.

e6f8c48

Default virtual actions

1f3bc2c

Working db propagation.

9e6ea45

Add new prisma-fmt command referential-actions

a4032c5

Call it with starting prisma-fmt with subcommand referential actions. STDIN takes the data model and stdout lists all allowed actions.

pimeys force-pushed the referential-actions branch from 20f0881 to a4032c5 Compare June 7, 2021 17:52

pimeys mentioned this pull request Jun 8, 2021

feat: referential action completions prisma/language-tools#807

Merged

Julius de Bruijn added 2 commits June 21, 2021 14:57

Merge branch 'master' into referential-actions

0ba0965

IE/ME clippy

68badc9

Julius de Bruijn added 9 commits June 21, 2021 16:14

Do not patch barrel

357ce5c

More clippy

67a4939

Make legacy compound defaults work again

d526152

Set referential action for compounds correctly

7931c4c

If even one underlying scalar field is required, the default referential action should not be `SetNull`.

Merge branch 'master' into referential-actions

1926d49

Nyeh nyeh test fix

b5bd2f1

LAST BROKEN TESTS

d1b654c

LAST LAST BROKEN TESTS

ed65a0e

Merge branch 'master' into referential-actions

1cc068d

tomhoule reviewed Jun 22, 2021

View reviewed changes

Julius de Bruijn added 2 commits June 22, 2021 15:03

First round of review fixes

de24f6b

Rename variable

288f969

tomhoule reviewed Jun 22, 2021

View reviewed changes

Clone -> cloned

ea849b2

tomhoule reviewed Jun 22, 2021

View reviewed changes

Validation error if ref actions on both sides

de3b045

tomhoule approved these changes Jun 22, 2021

View reviewed changes

pimeys merged commit c1fcbb5 into master Jun 22, 2021

pimeys deleted the referential-actions branch June 22, 2021 16:37

Jolg42 mentioned this pull request Jun 23, 2021

fix(deps): update engines to v2.26.0-13.a9966aa784861dee7e6b2a90950874cbaf7b4984 prisma/prisma#7796

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Referential actions in the Prisma Schema Language #1947

Referential actions in the Prisma Schema Language #1947

pimeys commented May 20, 2021 •

edited

pimeys commented Jun 21, 2021

tomhoule left a comment

tomhoule Jun 22, 2021

tomhoule Jun 22, 2021

tomhoule Jun 22, 2021

pimeys Jun 22, 2021

tomhoule Jun 22, 2021

tomhoule left a comment

tomhoule Jun 22, 2021

tomhoule Jun 22, 2021

pimeys Jun 22, 2021

pimeys Jun 22, 2021

Jolg42 Jun 22, 2021

steebchen Jun 22, 2021

sdnts Jun 22, 2021

Jolg42 Jun 23, 2021

tomhoule Jun 22, 2021

tomhoule left a comment

tomhoule Jun 22, 2021

pimeys Jun 22, 2021

pimeys Jun 22, 2021

tomhoule Jun 22, 2021

tomhoule Jun 22, 2021

tomhoule Jun 22, 2021

pimeys Jun 22, 2021

Referential actions in the Prisma Schema Language #1947

Referential actions in the Prisma Schema Language #1947

Conversation

pimeys commented May 20, 2021 • edited

pimeys commented Jun 21, 2021

tomhoule left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomhoule left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomhoule left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pimeys commented May 20, 2021 •

edited