Add config.storage_client documentation [WIP]
#4734
Draft
+298
−106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch adds documentation for the `config.storage_client` module. The module allows one to connect to a remote config.storage cluster and use it as a key-value storage. Examples for working both with Tarantool config.storage server and Tarantool config.storage client are provided side by side since they share quite the same API.
|
Note, that README should also be updated. https://github.com/tarantool/tarantool/tree/master/doc/examples/config/config-storage |
Totktonada
reviewed
Feb 17, 2025
|
|
||
| Put a value by the specified path. | ||
| The ``config.stoarge_client`` API allows you to connect to a remote replica set :ref:`configured as a Tarantool-based centralized configuration storage <centralized_configuration_set_up_tarantool>` and interact with it as a key-value storage, see Client API examples below. |
Totktonada
reviewed
Feb 17, 2025
Comment on lines
+381
to
+388
| .. function:: connect(endpoints[, options]) | ||
|
|
||
| Connect to a remote config.storage cluster. | ||
|
|
||
| :param table endpoints: a path to put the value by | ||
| :param table options: extra options | ||
|
|
||
| :return: a <config.storage object> object |
There was a problem hiding this comment.
:param table endpoints: a path to put the value by
Seems incorrect.
:param table options: extra options
Extra comparing to what?
Totktonada
reviewed
Feb 17, 2025
|
|
||
| Get a value stored by the specified path or prefix. | ||
| * ``recvision``: a revision after performing the operation |
There was a problem hiding this comment.
Typo: recvision -> revision.
Totktonada
reviewed
Feb 17, 2025
|
|
||
| * ``revision``: a revision after performing the operation | ||
| **Client API exapmle:** |
Totktonada
reviewed
Feb 17, 2025
Comment on lines
+72
to
+73
| * - :ref:`config.storage_client:connect() <config_storage_client_api_reference_connect>` | ||
| - Connect to a remote config.storage cluster |
There was a problem hiding this comment.
Should it be a module function, not an object method?
It seems it also called this way in myapp_client.lua.
Totktonada
reviewed
Feb 17, 2025
There was a problem hiding this comment.
It seems the following methods are missed:
:close():is_closed():watch():on_disconnect():is_connected()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch adds documentation for the
config.storage_clientmodule. The module allows one to connect to a remote config.storage cluster and use it as a key-value storage.Examples for working both with Tarantool config.storage server API and Tarantool config.storage client API are provided side by side since they share quite the same API.