Add config.storage client and config.storage TTL option
#5116
Conversation
This file contains hidden or 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
github-actions
bot
temporarily deployed
to
branch-config-storage-client
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. The examples on connecting to a config.storage instance via iproto has been changed to an example on connecting to multiple config.storage instances using the config.storage client and interacting with a config.storage cluster. Closes #4734
This patch adds a time-to-live (TTL) option to `config.storage` API methods. This option allows one to put keys that will expire when the passed time passes. Closes tarantool/enterprise_doc#281
georgiy-belyanin
force-pushed
the
gbelyanin/config-storage-client
branch
from
870e4a7 to
c41464a
Compare
Totktonada
reviewed
May 16, 2025
|
|
||
| Put a value by the specified path. | ||
|
|
||
| :param string path: a path to put the value by | ||
| :param string value: a value to put | ||
| :param table opts: a table containing the following optional fields: | ||
|
|
||
| * ``ttl`` (since :doc:`3.2.0 </release/3.2.0>`, default: unset): time-to-live in seconds, if nil or not set the key won't expire, may issue an error if set on config.storage running old schema, see :ref:`config.storage.info <config_storage_api_reference_info>`. |
There was a problem hiding this comment.
AFAIR, we discussed a lot the following corner cases:
- If a key exists and has no TTL, what
putof this key with TTL do? - Vice versa: if the key exists and has TTL, what
putof this key without TTL do? - Next, if a key has TTL that expires at time T and we attempt to
putthis key with a TTL that expires at time T1 < T, whether the expire occurs on T1 or T? How about T2 > T?
I would like if the API documentation would describe a behavior in these scenarios.
Totktonada
reviewed
May 16, 2025
Comment on lines
+644
to
+652
| :return: a table containing the following fields: | ||
|
|
||
| * ``data``: a table containing the information about the value: | ||
|
|
||
| * ``path``: a path | ||
| * ``mod_revision``: the last revision at which this value was modified | ||
| * ``value:``: a value | ||
|
|
||
| * ``revision``: a revision after performing the operation |
There was a problem hiding this comment.
TBH, it is not very clear from this description, whether data contains the {path = <...>, mod_revision = <...>, value = <...>} mapping or an array of them. Since the call suport both point and prefix requests, I guess that it is either an array or a mapping of mappings. Anyway, I think that it would be nice to make it clear.
This is not really to this PR, because the description is the same as for the server API. Feel free to ignore.
Totktonada
reviewed
May 16, 2025
Comment on lines
+615
to
+616
| :param string path: a path to put the value by | ||
| :param string value: a value to put |
There was a problem hiding this comment.
Don't know why, but it seems the rendering fails here:
Totktonada
approved these changes
May 16, 2025
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 patchset focuses on updates in th
configLua module reference related toconfig.storage.The first 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.
The examples on connecting to a config.storage instance via iproto has
been changed to an example on connecting to multiple config.storage
instances using the config.storage client and interacting with a
config.storage cluster.
Closes #4734
The second patch adds
config.storageTTL option allowing one to specify atime-to-live for the key in config.storage.
Closes https://github.com/tarantool/enterprise_doc/issues/281