-
Notifications
You must be signed in to change notification settings - Fork 43
Document new 'config' API #4331
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
Conversation
9fe23c1
to
8715bc2
Compare
8715bc2
to
869d095
Compare
869d095
to
055bbfc
Compare
055bbfc
to
d16f367
Compare
e28dbd0
to
da9c332
Compare
b7ab107
to
07bb0a6
Compare
Get a configuration applied to the current instance. | ||
Optionally, you can pass a configuration option name to get its value. | ||
Get a configuration applied to the current or remote instance. | ||
Note that there is the following difference between getting a configuration for the current and remote instance: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that there is the following difference between getting a configuration for the current and remote instance: | |
Note the following differences between getting a configuration for the current and remote instance: |
Get a configuration applied to the current or remote instance. | ||
Note that there is the following difference between getting a configuration for the current and remote instance: | ||
|
||
- For the current instance, ``get()`` returns an instance configuration considering :ref:`environment variables <configuration_environment_variable>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- For the current instance, ``get()`` returns an instance configuration considering :ref:`environment variables <configuration_environment_variable>`. | |
- For the current instance, ``get()`` returns instance configuration considering :ref:`environment variables <configuration_environment_variable>`. |
Note that there is the following difference between getting a configuration for the current and remote instance: | ||
|
||
- For the current instance, ``get()`` returns an instance configuration considering :ref:`environment variables <configuration_environment_variable>`. | ||
- For a remote instance, ``get()`` only considers a cluster configuration and ignores environment variables. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- For a remote instance, ``get()`` only considers a cluster configuration and ignores environment variables. | |
- For a remote instance, ``get()`` only considers cluster configuration and ignores environment variables. |
**Example: configuration warnings** | ||
|
||
In the example below, the instance's state is ``check_warnings``. | ||
The ``alerts`` section informs that privileges to the ``bands`` space for ``sampleuser`` cannot be granted because the ``bands`` space has not created yet: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ``alerts`` section informs that privileges to the ``bands`` space for ``sampleuser`` cannot be granted because the ``bands`` space has not created yet: | |
The ``alerts`` section informs that privileges to the ``bands`` space for ``sampleuser`` cannot be granted because the ``bands`` space has not been created yet: |
|
||
Get a URI of the current or remote instance. | ||
|
||
:param string uri_type: a URI type. There are the following URI types are supported: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:param string uri_type: a URI type. There are the following URI types are supported: | |
:param string uri_type: a URI type. The following URI types are supported: |
7, debug' | ||
timestamp: 2024-02-29T12:55:54.366810+0300 | ||
... | ||
In this example, the same actions are performed for instances from the specific replica set: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this example, the same actions are performed for instances from the specific replica set: | |
In this example, the same actions are performed for instances from a specific replica set: |
65f532d
to
ae8e911
Compare
ae8e911
to
0e0243c
Compare
Updated reference for the
config
module. Fixed doc issues:config:info()
#4094Staging:
opts
argument in config:get() (in particular,opts.instance
)version
argument in config:info()Note
New code examples are created using the sharded_cluster_crud_docker demo application.