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

@noconflict directives docs #4490

Open
wants to merge 3 commits into
base: master
from
Open

@noconflict directives docs #4490

wants to merge 3 commits into from

Conversation

@arijitAD
Copy link
Member

arijitAD commented Dec 31, 2019

Adds documentation for the @noconflict directive that was introduced in #4454.


This change is Reviewable

@arijitAD arijitAD requested review from campoy and prashant-shahi Dec 31, 2019
Copy link
Member

prashant-shahi left a comment

Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on @arijitAD, @campoy, @danielmai, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

### Noconflict directive

To use no conflict directive on a predicate, specify the `@noconflict` directive in the schema. It prevents conflict detection at the predicate level. This is an expermintal feature and not a recommended directive, but exists to help avoid conflicts for predicates which don't have high correctness requirements. This can cause data loss, especially when used for predicates with count index. 

100 chars+


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

You can specify the @noconflict directive in the schema to prevent conflict detection at the predicate level.

We are using Noconflict in the heading so we should either use the same terminology or @noconflict.
We can rephrase the sentence to avoid using no conflict.


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

This is an experimental feature. It is not a recommended directive but exists to help avoid conflicts for predicates which don't have high correctness requirements.

fixed typo, removed comma, and divided into two sentences


wiki/content/query-language/index.md, line 2179 at r1 (raw file):

@noconflict directive

@prashant-shahi prashant-shahi self-requested a review Dec 31, 2019
Copy link
Member Author

arijitAD left a comment

Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on @campoy, @danielmai, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

Previously, prashant-shahi (Prashant Shahi) wrote…

100 chars+

Done.


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

Previously, prashant-shahi (Prashant Shahi) wrote…

You can specify the @noconflict directive in the schema to prevent conflict detection at the predicate level.

We are using Noconflict in the heading so we should either use the same terminology or @noconflict.
We can rephrase the sentence to avoid using no conflict.

Done.


wiki/content/query-language/index.md, line 2177 at r1 (raw file):

Previously, prashant-shahi (Prashant Shahi) wrote…

This is an experimental feature. It is not a recommended directive but exists to help avoid conflicts for predicates which don't have high correctness requirements.

fixed typo, removed comma, and divided into two sentences

Done.


wiki/content/query-language/index.md, line 2179 at r1 (raw file):

Previously, prashant-shahi (Prashant Shahi) wrote…

@noconflict directive

Done.

Copy link
Member

prashant-shahi left a comment

:lgtm:

Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on @campoy, @danielmai, @MichaelJCompton, and @prashant-shahi)

@prashant-shahi prashant-shahi self-requested a review Jan 2, 2020
Copy link
Member

martinmr left a comment

a minor comment but otherwise it :lgtm:

Reviewed 1 of 1 files at r2.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @arijitAD, @campoy, @danielmai, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 2177 at r2 (raw file):

### Noconflict directive

To use Noconflict directive on a predicate, specify the `@noconflict` directive in the schema.

remove this sentence and start the next one with "The NoConflict directive prevents ...".

Right below you are repeating how to use this directive so I don't think this sentence is needed.

Copy link
Member

prashant-shahi left a comment

address the comments and :lgtm:

Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @arijitAD, @campoy, @danielmai, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 1936 at r2 (raw file):

IgnoreReflex directive

It would be nice to update this one as well to keep it consistent with the PascalCase styling with NoConflict.

@prashant-shahi prashant-shahi self-requested a review Jan 16, 2020
Copy link
Member

campoy left a comment

Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @arijitAD, @danielmai, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 2181 at r2 (raw file):

recommended directive but exists to help avoid conflicts for predicates that don't have high
correctness requirements. This can cause data loss, especially when used for predicates with count
index.

Could you give a concrete example of where this could be useful? Was this requested by the community?

arijitAD added 2 commits Dec 31, 2019
Adds documentation for the @noconflict directive that was introduced in #4454.
Copy link
Member Author

arijitAD left a comment

Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @campoy, @danielmai, @martinmr, @MichaelJCompton, and @prashant-shahi)


wiki/content/query-language/index.md, line 1936 at r2 (raw file):

Previously, prashant-shahi (Prashant Shahi) wrote…

IgnoreReflex directive

It would be nice to update this one as well to keep it consistent with the PascalCase styling with NoConflict.

Done.


wiki/content/query-language/index.md, line 2177 at r2 (raw file):

Previously, martinmr (Martin Martinez Rivera) wrote…

remove this sentence and start the next one with "The NoConflict directive prevents ...".

Right below you are repeating how to use this directive so I don't think this sentence is needed.

Done.


wiki/content/query-language/index.md, line 2181 at r2 (raw file):

Previously, campoy (Francesc Campoy) wrote…

Could you give a concrete example of where this could be useful? Was this requested by the community?

Yes, This was requested by the community. I have linked the issue to the fix.
#4079
This could help in the case when the user has some conflict detection logic at the client end and doesn't want Dgraph to do conflict detection or if the user is not concerned with index data correction and focus is on speed.

@arijitAD arijitAD force-pushed the arijitAD/noconflict-doc branch from f3022a8 to 9143a14 Jan 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.