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

[Doc] The user rights management doc is out of data #177

Closed
frank-zsy opened this issue Mar 23, 2023 · 3 comments
Closed

[Doc] The user rights management doc is out of data #177

frank-zsy opened this issue Mar 23, 2023 · 3 comments
Labels
doc Improvements or additions to documentation

Comments

@frank-zsy
Copy link

Describe the bug

In production env, we really need a user access management for our databases.

But in the User rights management doc, the functions are out of date right now and can not be used to setup user access rights correctly like:

  • modSpecifiedAccessLevel function does not exist anymore, the name of the function should be modRoleAccessLevel now, so there will be an error about unregistered standalone function if we call modSpecifiedAccessLevel in the Cypher.

I think we should keep the document identical with the code at our best to make sure users can setup the database properly by themselves.

@frank-zsy
Copy link
Author

Also, we should give some examples about how to use the functions since users may not understand how to properly set a Map param to functions like CALL dbms.security.modSpecifiedAccessLevel(role::STRING,access_level::MAP).

@knightast
Copy link
Contributor

A lot of efforts should be made to enhance doc, thanks for detailed suggestion.

Currently, all interface are tested in UT, you can also find the examples in UT (which should be put in doc).

@frank-zsy
Copy link
Author

I think I can help with the update of this doc and sync the function from UT to doc.

@qishipengqsp qishipengqsp added the doc Improvements or additions to documentation label Jan 4, 2024
This was referenced Apr 18, 2024
Closed
zhangwh807 added a commit to zhangwh807/tugraph-db that referenced this issue Apr 18, 2024
@zhangwh807 zhangwh807 mentioned this issue Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants