Adds box.schema.user.enable and box.schema.user.disable methods #5123

AArdeev · 2025-05-21T14:43:41Z

2 new files ("user_enable.rst" and user_disable.rst") added to the box.schema submodule.
Files describe methods that activate and deactivate users.
References added to existing files ("box_schema.rst", "user_grant.rst", "user_revoke.rst")

…iption to Submodule box.schema 2 new files ("user_enable.rst" and user_disable.rst") added to the box.schema submodule. Files describe methods that activate and deactivate users. References added to existing files ("box_schema.rst", "user_grant.rst", "user_revoke.rst" Fixes #5122

tecl1s · 2025-05-21T19:02:34Z

doc/reference/reference_lua/box_schema/user_enable.rst

+
+.. function:: box.schema.user.enable(username)
+
+    Activate deactivated user. If :samp:`'{username}'` does not exist, it will be created. If :samp:`'{username}'` is already active, nothing changes.


Запуск box.schema.user.grant не создаёт пользователей. Вызов box.schema.user.enable сводится к запуску box.schema.user.grant с предустановленными параметрами. Передаваемый при этом параметр if_not_exists=true относится не к созданию пользователя, а к выводу/сокрытию ошибки повторной выдачи прав (ссылка).

box.schema.user.enable('not-exists') --- - error: User 'not-exists' is not found ...

Поправил

tecl1s · 2025-05-21T19:09:22Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+.. function:: box.schema.user.disable(username)
+
+    Deactivate a user. If :samp:`'{username}'` does not exist, an error is returned.


Под box.schema.user.disable вызывается box.schema.user.revoke с if_exists = true. В случае if_exists = true ошибка отсутствия отзываемых прав ~~не будет выведена~~ не произойдёт.

Поправил

tecl1s · 2025-05-21T19:20:48Z

doc/reference/reference_lua/box_schema/user_revoke.rst

В файле есть текст:

Должен существовать пользователь, должен существовать объект, но если задано {if_exists=true}, то ошибки не будет, если у пользователя нет прав.

Он звучит немного нескладно. Может быть подправить его как-то так:
Отсутствие объекта или пользователя приводит к ошибке. В случае отсутствия у пользователя прав на объект, ошибка не возникнет при {if_exists=true}.

Fixes #5123

tecl1s · 2025-05-22T09:35:40Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+    :param string username: the name of a user to be deactivated
+
+    :return: ``---``


Может быть по аналогии с добавленным для box.schema.user.enable добавить "(if failure)"?

Вот пример:

box.schema.user.disable('nope') --- - error: User 'nope' is not found ...

Да, добавлю конечно

Fixes #5123

Totktonada · 2025-05-22T12:59:40Z

doc/reference/reference_lua/box_schema/user_disable.rst

+    Initiates the :samp:`box.schema.user.revoke('{username}','usage,session','universe',nil,` :code:`{if_exists=true})`
+    (see section :ref:`box.schema.user.revoke <box_schema-user_revoke>`).


Please, explain the effect of this call. What does 'deactivated' mean?

You can use usage and session description from https://github.com/tarantool/tarantool/wiki/Privileges-and-Access-Control-explained#all-possible-combinations-of-object-type-and-permission

Totktonada · 2025-05-22T13:01:04Z

doc/reference/reference_lua/box_schema/user_disable.rst

+    Initiates the :samp:`box.schema.user.revoke('{username}','usage,session','universe',nil,` :code:`{if_exists=true})`
+    (see section :ref:`box.schema.user.revoke <box_schema-user_revoke>`).


Why the revoke call is splitted to two inline blocks?

Also, in my opinion it is long enough to make it a non-inline block of code.

Totktonada · 2025-05-22T13:06:56Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+    :param string username: the name of a user to be deactivated
+
+    :return: (if success) ``---``


--- is YAML document start marker and it is not really what the function returns.

The function returns nothing -- zero amount of values. just like the following function:

function nop() end

Tarantool admin console encodes return values in YAML with document start (---) and document end (...) markers:

tarantool> nop() --- ...

Please, describe Lua API in terms of Lua values. Here I would write that the function returns nothing.

Totktonada · 2025-05-22T13:08:36Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+    :return: (if success) ``---``
+
+             (if failure) ``error: User 'username' is not found``


This console output means that the given error is raised. It is different from returning {['error'] = <...>}. Please, clarify in some way that is consistent with other Lua API descriptions.

Totktonada · 2025-05-22T13:09:16Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+        ..  code-block:: lua
+
+            box.schema.user.disable (username)       


Trailing whitespaces are usually discouraged.

The same for enable.

Totktonada · 2025-05-22T13:09:46Z

doc/reference/reference_lua/box_schema/user_disable.rst

+
+        ..  code-block:: lua
+
+            box.schema.user.disable (username)       


Please, follow the usual Lua code style, here we write foo(), not foo ().

Totktonada · 2025-05-22T13:11:47Z

doc/reference/reference_lua/box_schema/user_disable.rst

+        ..  code-block:: lua
+
+            box.schema.user.disable (username)       
+            ---


This is not a return value. If we want to show a chunk of console session, let's add prompt (tarantool> ) and the document end marker (...). If we want to show a piece from a Lua file, let's remove this YAML artifact.

Totktonada · 2025-05-22T13:12:22Z

doc/reference/reference_lua/box_schema/user_disable.rst

+             (if failure) ``error: User 'username' is not found``
+
+
+    **Example:**


TBH, I don't see what this example adds to the given description. Is it really needed?

Totktonada · 2025-05-22T13:12:40Z

doc/reference/reference_lua/box_schema/user_enable.rst

Most of disable comments are applicable here too.

AArdeev requested review from Totktonada, veod32 and tecl1s May 21, 2025 14:43

AArdeev self-assigned this May 21, 2025

AArdeev added documentation Improvements or additions to documentation doc_gap labels May 21, 2025

github-actions bot temporarily deployed to branch-gh-5122-add-box-schema-user-methods May 21, 2025 14:45 Destroyed

Fix typo in page heading

f69a513

github-actions bot temporarily deployed to branch-gh-5122-add-box-schema-user-methods May 21, 2025 15:13 Destroyed

tecl1s suggested changes May 21, 2025

View reviewed changes

Updates description by comments

0c0e2c1

Fixes #5123

github-actions bot temporarily deployed to branch-gh-5122-add-box-schema-user-methods May 22, 2025 08:09 Destroyed

AArdeev requested a review from tecl1s May 22, 2025 09:34

tecl1s suggested changes May 22, 2025

View reviewed changes

Updates .._disable description by comments

7d55ae3

Fixes #5123

github-actions bot deployed to branch-gh-5122-add-box-schema-user-methods May 22, 2025 09:47 View deployment

AArdeev requested a review from tecl1s May 22, 2025 09:52

veod32 removed their request for review May 22, 2025 10:23

Totktonada reviewed May 22, 2025

View reviewed changes


		.. function:: box.schema.user.enable(username)

		Activate deactivated user. If :samp:`'{username}'` does not exist, it will be created. If :samp:`'{username}'` is already active, nothing changes.


		.. function:: box.schema.user.disable(username)

		Deactivate a user. If :samp:`'{username}'` does not exist, an error is returned.


		:param string username: the name of a user to be deactivated

		:return: ``---``

		Initiates the :samp:`box.schema.user.revoke('{username}','usage,session','universe',nil,` :code:`{if_exists=true})`
		(see section :ref:`box.schema.user.revoke <box_schema-user_revoke>`).


		:param string username: the name of a user to be deactivated

		:return: (if success) ``---``


		:return: (if success) ``---``

		(if failure) ``error: User 'username' is not found``

		(if failure) ``error: User 'username' is not found``


		Example:

Adds box.schema.user.enable and box.schema.user.disable methods #5123

Are you sure you want to change the base?

Adds box.schema.user.enable and box.schema.user.disable methods #5123

Uh oh!

Conversation

AArdeev commented May 21, 2025

Uh oh!

tecl1s May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tecl1s May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tecl1s May 21, 2025 •

edited

Loading

tecl1s May 21, 2025 •

edited

Loading