Skip to content

Add description of vshard.enable/disable #3019

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

Closed
wants to merge 1 commit into from
Closed

Add description of vshard.enable/disable #3019

wants to merge 1 commit into from

Conversation

Serpentian
Copy link
Contributor

  • Add description of the automatic and manual router API's
    enabling/disabling

Resolves #3012

* Add description of the automatic and manual router API's
  enabling/disabling

Resolves #3012
Copy link
Contributor

@patiencedaur patiencedaur left a comment

Choose a reason for hiding this comment

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

Thanks for the patch! Most of my suggestions are language-related.
I haven't looked at the changes on the staging website yet because the deployment is currently broken. If it's okay with you, I'll take another look at the PR after the deployment is fixed.

Comment on lines +780 to +784
.. NOTE::

``vshard.router.enable()`` cannot be used for enabling the router
API which was automatically disabled due to running configuration
process.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. NOTE::
``vshard.router.enable()`` cannot be used for enabling the router
API which was automatically disabled due to running configuration
process.
.. note::
``vshard.router.enable()`` cannot be used for enabling a router
API that was automatically disabled due to a running configuration
process.
  1. We use .. note:: now: https://www.tarantool.io/en/doc/latest/contributing/docs/markup/admonitions/
  2. A running configuration process is router.cfg(), right? Let's mention this.

Comment on lines +790 to +796
Manually restrict access to the router API. Disabling makes all
its methods, excluding :ref:`vshard.router.cfg() <router_api-cfg>`,
:ref:`vshard.router.new() <router_api-new>`,
:ref:`vshard.router.enable() <router_api-enable>` and
:ref:`vshard.router.disable() <router_api-disable>`, to throw a Lua
error in case of invoking them. The error object has a name attribute
equal to ``ROUTER_IS_DISABLED``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Manually restrict access to the router API. Disabling makes all
its methods, excluding :ref:`vshard.router.cfg() <router_api-cfg>`,
:ref:`vshard.router.new() <router_api-new>`,
:ref:`vshard.router.enable() <router_api-enable>` and
:ref:`vshard.router.disable() <router_api-disable>`, to throw a Lua
error in case of invoking them. The error object has a name attribute
equal to ``ROUTER_IS_DISABLED``.
Manually restrict access to the router API. When the API is disabled,
all its methods throw a Lua error,
except :ref:`vshard.router.cfg() <router_api-cfg>`,
:ref:`vshard.router.new() <router_api-new>`,
:ref:`vshard.router.enable() <router_api-enable>` and
:ref:`vshard.router.disable() <router_api-disable>`. The error object's name attribute is
``ROUTER_IS_DISABLED``.

Russian is a wordy language, and English is not. Please try to use fewer words and simpler constructions whenever possible.

equal to ``ROUTER_IS_DISABLED``.

The router is enabled by default. However, it is automatically and
forcefully disabled until configuration is finished as accessing the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
forcefully disabled until configuration is finished as accessing the
forcefully disabled until the configuration is finished, as accessing the

@Serpentian
Copy link
Contributor Author

Closed as a duplicate of #3025

@Serpentian Serpentian closed this Jul 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

vshard.router.enable/disable()
2 participants