docs(Query): Update docs to note that only typed data can be deleted using `S * *`(Docs) #6657

aaroncarey · 2020-10-05T22:57:30Z

Customers are confused by what happens when they try to delete data that they haven't typed. This fix adds a note about this requirement and links to information on how customers can type their data.

Fixes GRAPHQL-669

This change is

Docs Preview:

Updated to fix typos

CLAassistant · 2020-10-05T22:57:35Z

All committers have signed the CLA.

…eleting data using a wildcard search Per Michael Compton, the limitation is not as severe as I thought with the initial draft.

aaroncarey · 2020-10-05T23:49:12Z

Here's the link directly to the page with the change on the preview site:

https://dgraph-76b6db82fc-99471.surge.sh/mutations/delete/

MichaelJCompton

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @aaroncarey, @bucanero, @danielmai, @MichaelJCompton, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 43 at r2 (raw file):

edges on that node and their corresponding definitions in the schema). 

**Note**: If the type information

Should this use this kind of note?

wiki/content/mutations/delete.md, line 44 at r2 (raw file):

**Note**: If the type information
for the node `S` is missing then the delete operation will not work. For more information on how to set the type

Let's explicitly call out that it's S * * mutations that need types (the S P * ones will still work).

So maybe we should make this note like "The S * * mutation pattern ..."

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 1 at r2 (raw file):

+++

What's this file?

Deleted a file generated by my text editor. Thank you to Michael for catching this!

aaroncarey · 2020-10-06T06:00:04Z

Let's explicitly call out that it's S * * mutations that need types (the S P * ones will still work).

So maybe we should make this note like "The S * * mutation pattern ..."

This is a great clarification, I will work it into the docs! Stay tuned for a new commit.

aaroncarey · 2020-10-06T06:00:46Z

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @aaroncarey, @bucanero, @danielmai, @MichaelJCompton, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 43 at r2 (raw file):
edges on that node and their corresponding definitions in the schema). 

**Note**: If the type information
Should this use this kind of note?

{{% notice "note" %}}

wiki/content/mutations/delete.md, line 44 at r2 (raw file):
**Note**: If the type information
for the node `S` is missing then the delete operation will not work. For more information on how to set the type
Let's explicitly call out that it's S * * mutations that need types (the S P * ones will still work).

So maybe we should make this note like "The S * * mutation pattern ..."

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 1 at r2 (raw file):
+++
What's this file?

Garbage from my text editor, now removed. Thanks!

MichelDiz

Reviewable status: 0 of 1 files reviewed, 7 unresolved discussions (waiting on @aaroncarey, @bucanero, @danielmai, @MichaelJCompton, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 9 at r3 (raw file):

removes predicates

I think triples suits better. As fundamentally the delete operation is removing 3 information from the DB.

wiki/content/mutations/delete.md, line 43 at r3 (raw file):

edges and any indexing for the removed data. The predicates to delete are
derived from the type information for that node (the value of the `dgraph.type`
edges on that node and their corresponding definitions in the schema). If the type information

why remove this?

wiki/content/mutations/delete.md, line 67 at r3 (raw file):

'wildcard delete'

“Star notation” also is fine.

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 1 at r2 (raw file):

Previously, MichaelJCompton (Michael Compton) wrote…

What's this file?

Yeah, this file is a bit odd. Feels like a copy of the delete.md.

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 11 at r3 (raw file):

A delete mutation, signified with the `delete` keyword, removes triples from the store. Note that you can only delete nodes if your data is typed using the `dgraph.type`predicate. For more imformation on setting the type of a node, see [Setting the type of a node](https://dgraph.io/docs/query-language/type-system/#setting-the-type-of-a-node).

For example, if the store contained the following:

add a space between the text and the code block.

bucanero

Reviewable status: 0 of 1 files reviewed, 8 unresolved discussions (waiting on @aaroncarey, @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 67 at r3 (raw file):

Previously, MichelDiz (Michel Diz) wrote…

'wildcard delete'
“Star notation” also is fine.

if you keep "wildcard delete", I'd suggest linking it to the previous heading. Something like:

Using a [wildcard delete](#wildcard-delete) star notation mentioned...

wiki/content/mutations/delete.md, line 9 at r4 (raw file):

signified

Just a suggestion, I'd go with "identified" instead of signified

Update to address remaining feedback on this PR.

aaroncarey

Reviewable status: 0 of 1 files reviewed, 8 unresolved discussions (waiting on @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 43 at r2 (raw file):

Previously, MichaelJCompton (Michael Compton) wrote…

Should this use this kind of note?

{{% notice "note" %}}

I moved this into a note, thanks!

wiki/content/mutations/delete.md, line 44 at r2 (raw file):

Previously, MichaelJCompton (Michael Compton) wrote…

Let's explicitly call out that it's S * * mutations that need types (the S P * ones will still work).

So maybe we should make this note like "The S * * mutation pattern ..."

Done. Lines 45-47 call this out.

wiki/content/mutations/delete.md, line 9 at r3 (raw file):

predicates

Thanks for raising this, I definitely want to use the right word, here. I'd like to settle on the most widely-understood term that works for our users. I don't see the term "triple" used this way in the latest GraphQL spec (http://spec.graphql.org/June2018/#sec-Language.Fields). That spec makes me wonder if "Block String" or "Object" isn't really the term we are looking for.

+++

After looking at this more closely, I'd like to avoid using the term "triple" here, as "predicate" or "field" seem to be the most widely-understood terms for the data contained within a node.

wiki/content/mutations/delete.md, line 43 at r3 (raw file):

Previously, MichelDiz (Michel Diz) wrote…

why remove this?

I reworked this material, nothing should be missing at this point

wiki/content/mutations/delete.md, line 67 at r3 (raw file):

Previously, bucanero (Damián Parrino) wrote…

if you keep "wildcard delete", I'd suggest linking it to the previous heading. Something like:
Using a [wildcard delete](#wildcard-delete) star notation mentioned...

Done.

wiki/content/mutations/delete.md, line 9 at r4 (raw file):

Previously, bucanero (Damián Parrino) wrote…

signified
Just a suggestion, I'd go with "identified" instead of signified

OK, done

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 1 at r2 (raw file):

Previously, MichelDiz (Michel Diz) wrote…

Yeah, this file is a bit odd. Feels like a copy of the delete.md.

Done.

wiki/content/mutations/delete.md.sb-e9c19abf-QiH8oo, line 11 at r3 (raw file):

Previously, MichelDiz (Michel Diz) wrote…

add a space between the text and the code block.

Done.

aaroncarey · 2020-10-12T20:34:16Z

https://dgraph-dc27d1337c-100924.surge.sh/mutations/delete/ Shows the current state of this document.

MichelDiz

Reviewable status: 0 of 1 files reviewed, 7 unresolved discussions (waiting on @aaroncarey, @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 9 at r3 (raw file):

Previously, aaroncarey (Aaron Carey) wrote…

predicates
Thanks for raising this, I definitely want to use the right word, here. I'd like to settle on the most widely-understood term that works for our users. I don't see the term "triple" used this way in the latest GraphQL spec (http://spec.graphql.org/June2018/#sec-Language.Fields). That spec makes me wonder if "Block String" or "Object" isn't really the term we are looking for.

+++

After looking at this more closely, I'd like to avoid using the term "triple" here, as "predicate" or "field" seem to be the most widely-understood terms for the data contained within a node.

I think you didn't understand. This docs isn't GraphQL related. DQL is a totally different thing, and we use terms that define what Dgraph is. As you can see https://dgraph.io/docs/mutations/triples/ https://dgraph.io/docs/deploy/dgraph-administration/#deleting-database triples is a common thing in Dgraph. There are more references. This term comes from RDF standard. And it is a fundamental thing in Dgraph.

When you delete something, you are fundamentally deleting 3 information on the DB. It is like KV, when you delete a value from a KV, you are the Key and the Value. Another example. When you delete a whole node in Dgraph. You are actually deleting all triples, not just the values.

"Predicate" is just the "name of the key". In Dgraph when you say you are deleting a predicate, it is understood that you did not delete other information.

Check this conversation a bit https://dgraphlabs.slack.com/archives/CSEFVTFQU/p1594243043106000?thread_ts=1594222913.084400&cid=CSEFVTFQU

Changed the reference to "triples" back to the correct terminology, updated related statements.

aaroncarey

Reviewable status: 0 of 1 files reviewed, 7 unresolved discussions (waiting on @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

wiki/content/mutations/delete.md, line 9 at r3 (raw file):

Previously, MichelDiz (Michel Diz) wrote…

I think you didn't understand. This docs isn't GraphQL related. DQL is a totally different thing, and we use terms that define what Dgraph is. As you can see https://dgraph.io/docs/mutations/triples/ https://dgraph.io/docs/deploy/dgraph-administration/#deleting-database triples is a common thing in Dgraph. There are more references. This term comes from RDF standard. And it is a fundamental thing in Dgraph.

When you delete something, you are fundamentally deleting 3 information on the DB. It is like KV, when you delete a value from a KV, you are the Key and the Value. Another example. When you delete a whole node in Dgraph. You are actually deleting all triples, not just the values.

"Predicate" is just the "name of the key". In Dgraph when you say you are deleting a predicate, it is understood that you did not delete other information.

Check this conversation a bit https://dgraphlabs.slack.com/archives/CSEFVTFQU/p1594243043106000?thread_ts=1594222913.084400&cid=CSEFVTFQU

Thanks for the clarification! I reviewed the links you provided and I have updated references back to "triple" where appropriate. Please take another look.

MichelDiz

Reviewed 1 of 1 files at r4, 1 of 1 files at r6.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

aaroncarey

I think I have all of your feedback addressed, let me know if I missed anything :)

bucanero

Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

aaroncarey

Doc updated per your feedback!

aaroncarey

Extra file deleted, now using a better markdown editor 👍

aaroncarey

Feedback addressed, thanks!

aaroncarey

Requested fixes implemented

codelingo

LGTM. 32 rules errored during the review.

codelingo

LGTM. 32 rules errored during the review.

Updated the text of the note on line 47 per feedback from Michael C.

typo fix

MichaelJCompton

Reviewable status: 0 of 1 files reviewed, 6 unresolved discussions (waiting on @bucanero, @danielmai, @MichaelJCompton, @MichelDiz, @pawanrawal, and @vvbalaji-dgraph)

codelingo

LGTM. 32 rules errored during the review.

codelingo

LGTM. 32 rules errored during the review.

Cherry-pick of fixes to this file from PR #6657

…an be deleted using `S * *` (#6798) Cherry-pick of fixes to this file from PR #6657 Fixes GRAPHQL-751

aaroncarey added 2 commits October 5, 2020 15:39

Update delete.md

551cf15

fix typo

a12bb44

Updated to fix typos

aaroncarey requested review from bucanero, pawanrawal and vvbalaji-dgraph October 5, 2020 22:57

aaroncarey requested review from danielmai and MichaelJCompton as code owners October 5, 2020 22:57

github-actions bot added the area/documentation Documentation related issues. label Oct 5, 2020

Update delete.md per feedback that the type restriction is only for d…

76b6db8

…eleting data using a wildcard search Per Michael Compton, the limitation is not as severe as I thought with the initial draft.

aaroncarey changed the title ~~docs(Query): Update docs to note that only typed data can be deleted (Docs)~~ docs(Query): Update docs to note that only typed data can be deleted using * (Docs) Oct 5, 2020

Address wildcard delete with a sub-section in the topic

8bcdfad

MichaelJCompton suggested changes Oct 6, 2020

View reviewed changes

aaroncarey requested a review from MichaelJCompton October 6, 2020 05:27

aaroncarey self-assigned this Oct 6, 2020

Delete delete.md.sb-e9c19abf-QiH8oo

55c93b8

Deleted a file generated by my text editor. Thank you to Michael for catching this!

MichelDiz suggested changes Oct 6, 2020

View reviewed changes

bucanero suggested changes Oct 7, 2020

View reviewed changes

Update delete.md

dc27d13

Update to address remaining feedback on this PR.

aaroncarey commented Oct 12, 2020

View reviewed changes

aaroncarey requested a review from bucanero October 12, 2020 20:34

MichelDiz suggested changes Oct 12, 2020

View reviewed changes

Update delete.md

134e226

Changed the reference to "triples" back to the correct terminology, updated related statements.

aaroncarey changed the title ~~docs(Query): Update docs to note that only typed data can be deleted using * (Docs)~~ docs(Query): Update docs to note that only typed data can be deleted using S * *(Docs) Oct 12, 2020

aaroncarey commented Oct 12, 2020

View reviewed changes

MichelDiz approved these changes Oct 12, 2020

View reviewed changes

aaroncarey commented Oct 12, 2020

View reviewed changes

bucanero approved these changes Oct 12, 2020

View reviewed changes

aaroncarey commented Oct 12, 2020

View reviewed changes

codelingo bot reviewed Oct 13, 2020

View reviewed changes

aaroncarey added 2 commits October 12, 2020 20:28

Update delete.md

92787a8

Updated the text of the note on line 47 per feedback from Michael C.

Update delete.md

1db8db5

typo fix

MichaelJCompton approved these changes Oct 13, 2020

View reviewed changes

aaroncarey merged commit e2fc874 into master Oct 13, 2020

aaroncarey deleted the delete-by-type branch October 13, 2020 03:36

codelingo bot reviewed Oct 13, 2020

View reviewed changes

aaroncarey added a commit that referenced this pull request Oct 23, 2020

Update delete.md

d87d822

Cherry-pick of fixes to this file from PR #6657

aaroncarey mentioned this pull request Oct 23, 2020

Cherry-pick (docs) v20.07: Update docs to note that only typed data can be deleted using S * * #6798

Merged

danielmai pushed a commit that referenced this pull request Oct 24, 2020

Cherry-pick (docs) v20.07: Update docs to note that only typed data c…

751e2ed

…an be deleted using `S * *` (#6798) Cherry-pick of fixes to this file from PR #6657 Fixes GRAPHQL-751

docs(Query): Update docs to note that only typed data can be deleted using S * *(Docs) #6657

docs(Query): Update docs to note that only typed data can be deleted using S * *(Docs) #6657

Uh oh!

Conversation

aaroncarey commented Oct 5, 2020 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Oct 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaroncarey commented Oct 5, 2020

Uh oh!

MichaelJCompton left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey commented Oct 6, 2020

Uh oh!

aaroncarey commented Oct 6, 2020

Uh oh!

MichelDiz left a comment

Choose a reason for hiding this comment

Uh oh!

bucanero left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey commented Oct 12, 2020

Uh oh!

MichelDiz left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

MichelDiz left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

bucanero left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

aaroncarey left a comment

Choose a reason for hiding this comment

Uh oh!

codelingo bot left a comment

Choose a reason for hiding this comment

Uh oh!

codelingo bot left a comment

Choose a reason for hiding this comment

Uh oh!

MichaelJCompton left a comment

Choose a reason for hiding this comment

Uh oh!

codelingo bot left a comment

Choose a reason for hiding this comment

Uh oh!

codelingo bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

docs(Query): Update docs to note that only typed data can be deleted using `S * *`(Docs) #6657

docs(Query): Update docs to note that only typed data can be deleted using `S * *`(Docs) #6657

aaroncarey commented Oct 5, 2020 •

edited by ghost

Loading

CLAassistant commented Oct 5, 2020 •

edited

Loading