Skip to content

Conversation

@ali-ince
Copy link
Contributor

This PR adds information about SHOW SETTING privileges.

@ali-ince ali-ince added team-cypher-operations Cypher operations should review this 5.6 labels Feb 23, 2023
@neo-technology-commit-status-publisher
Copy link
Collaborator

Looks like you've updated the documentation!

Check out your changes at https://neo4j-docs-cypher-440.surge.sh

@Hunterness Hunterness self-assigned this Feb 23, 2023
@ali-ince
Copy link
Contributor Author

@ali-ince ali-ince marked this pull request as ready for review February 23, 2023 12:26
Copy link
Collaborator

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed the main documentation for the command yet but you can get some comments in the meantime (as I'll continue tomorrow with the review)

Copy link
Contributor

@l-heemann l-heemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions

Copy link
Collaborator

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some missed things:

  • Execution plan is missing (the operators.adoc and operator-summary.adoc files)
  • Not sure if the built-in roles section have any lists of capabilities that needs updating, but it should be checked and if yes, updated
  • The DBMS privilege images (hierarchy and general syntax outline) needs to be updated (the original currently live in google docs and are then saved as svg files that we update in the docs repo)

ali-ince and others added 2 commits February 24, 2023 13:46
Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
@ali-ince
Copy link
Contributor Author

Some missed things:

* [x]  Execution plan is missing (the `operators.adoc` and `operator-summary.adoc` files)

* [x]  Not sure if the built-in roles section have any lists of capabilities that needs updating, but it should be checked and if yes, updated

* [x]  The DBMS privilege images (hierarchy and general syntax outline) needs to be updated (the original currently live in [google docs](https://drive.google.com/drive/folders/1eudiSV5aOddRt8O06IUEfLdGCn43WWQx?usp=sharing) and are then saved as svg files that we update in the docs repo)

no changes to built-in roles as we have implicitly included the SHOW SETTINGS * inside ALL DBMS PRIVILEGES.

Copy link
Contributor

@l-heemann l-heemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider if we want to re-use the name-globbing node in privileges_grand_and_deny_syntax_dbms_privileges.

Annoying that the edges now overlap as well, but I couldn't get them to behave either so...

Copy link
Collaborator

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments on the images:

  • privileges_hierarchy_dbms.svg: The SHOW SETTINGS should not have the *. Yes that is technically which version is included but we don't have that level detail in the image (compare with EXECUTE)
  • privileges_grant_and_deny_syntax_dbms_privileges.svg: I agree with Lasse's reuse of globbing box comment. I'm also annoyed at the crossing lines so I might take a stab at them as well

Edit: I've updated the images in the drive folder for both of these, now they just need to be updated on the PR as well

@Hunterness
Copy link
Collaborator

Question for the docs team: Is there any reason to have the png images n the repo? as far as I'm aware we're using the svg versions in the text? (I also though the png ones had been removed when the svg ones were introduced?)

ali-ince and others added 2 commits February 27, 2023 11:06
Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
@ali-ince ali-ince requested a review from Hunterness February 27, 2023 11:15
Copy link
Collaborator

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now :)

Copy link
Collaborator

@JPryce-Aklundh JPryce-Aklundh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @ali-ince !
I have a few suggestions and comments. Also, I was thinking maybe we should include a note on the clauses page explaining that this replaces dbms.listConfig and that, unlike dbms.listConfig, this is something Aura users can use?

ali-ince and others added 3 commits February 27, 2023 14:11
Co-authored-by: Jens Pryce-Åklundh <112686610+JPryce-Aklundh@users.noreply.github.com>
Co-authored-by: Jens Pryce-Åklundh <112686610+JPryce-Aklundh@users.noreply.github.com>
@ali-ince
Copy link
Contributor Author

i

Also, I was thinking maybe we should include a note on the clauses page explaining that this replaces dbms.listConfig and that, unlike dbms.listConfig, this is something Aura users can use?

We initially had a similar note, but then decided to remove it since we don't actually remove or deprecate dbms.listConfig.

@JPryce-Aklundh
Copy link
Collaborator

@ali-ince @Hunterness - sorry I did not see your comment re .png images, and no, we should not keep the png files in the repo, but use .svg files instead.

Copy link
Collaborator

@JPryce-Aklundh JPryce-Aklundh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @ali-ince!
I missed this in my first review, but would it be possible to change the images to .svg?
With regard to Aura, I may add something to this page at a later date then explaining that, while dbms.listConfig is not deprecated/removed, SHOW SETTINGS is something Aura users can use.

@Hunterness
Copy link
Collaborator

Hunterness commented Feb 28, 2023

sorry I did not see your comment re .png images, and no, we should not keep the png files in the repo, but use .svg files instead.

I was wondering since Ali updated existing png files, I guess they have been accidentally moved over in some cherry-pick 🤷 (we have to be careful with those as we add new things to the images when introducing new rbac features and don't want those to be cherry-picked back nor removed in a forward cherry-pick)

I missed this in my first review, but would it be possible to change the images to .svg?

They are, for some reason we have both in the repo (see above point) but I'm pretty sure it's the svg ones that are used in the includes

@JPryce-Aklundh
Copy link
Collaborator

I just checked, and you are correct, @Hunterness - it is the .svg images that are used in the includes. @ali-ince, please disregard my previous comment about changing the image formats.

@Hunterness
Copy link
Collaborator

please disregard my previous comment about changing the image formats.

Might be a good idea to remove the png files as they are unused though?

Comment on lines 2108 to 2109
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the original sentence here was very explicit that the examples might only use procedures but the rules also applied to functions and settings but I feel like it's less explicit now 🤔 I haven't found a good way to make it better though :(

Comment on lines 2108 to 2109
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a tricky one, @Hunterness, @ali-ince
How about this (together with my suggestions for lines 2121-2122)

Suggested change
Given the list of procedures named as follows, the consecutive examples show valid name-globbing patterns that can be applied to them.
The same rules apply to user-defined functions and settings.
Given the following list of procedures:

Comment on lines +2119 to +2120
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `your.exampleProcedure`
* `your.exampleProcedure`
The following examples demonstrate how procedures with valid name-globbing patterns can be used in queries.
Note that the same rules apply to user-defined functions and settings.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about switching them? Have this first, then the comment on given these procedures (and then maybe an additional comment to clarify where the examples start?) As the procedure list is more set-up to the examples it feels like we should have clarified why we only look at procedures before it

Copy link
Contributor Author

@ali-ince ali-ince Feb 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I find Jens' approach a bit more clear, but suggest we slightly change the last block;

The following examples demonstrate how name-globbing patterns can be used in queries.
Note that the same rules apply to user-defined functions and settings.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any difference between your block and his?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, copy-paste error. fixed it now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still want to mention something about the examples only using procedures?

@ali-ince
Copy link
Contributor Author

ali-ince commented Mar 3, 2023

@Hunterness @JPryce-Aklundh I've pushed another version for the remaining point that mentions procedures. If you both are happy with it, I'd like to merge these group of PRs for SHOW SETTINGS.

@JPryce-Aklundh
Copy link
Collaborator

It looks good to me 👍

@JPryce-Aklundh JPryce-Aklundh merged commit b2249a1 into neo4j:dev Mar 6, 2023
@JPryce-Aklundh JPryce-Aklundh deleted the dev-show-settings branch March 6, 2023 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.6 team-cypher-operations Cypher operations should review this

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants