Skip to content

Add config.storage_client documentation #4734

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

georgiy-belyanin
Copy link
Member

@georgiy-belyanin georgiy-belyanin commented Jan 20, 2025

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 API and
Tarantool config.storage client API are provided side by side since they
share quite the same API.

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.

@georgiy-belyanin
Copy link
Member Author

Note, that README should also be updated.

https://github.com/tarantool/tarantool/tree/master/doc/examples/config/config-storage

@georgiy-belyanin georgiy-belyanin force-pushed the config-storage-client branch 5 times, most recently from 0a1b4ee to ce749dd Compare May 13, 2025 09:02
@georgiy-belyanin georgiy-belyanin changed the title Add config.storage_client documentation [WIP] Add config.storage_client documentation May 13, 2025
@georgiy-belyanin georgiy-belyanin marked this pull request as ready for review May 13, 2025 09:02
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 tarantool#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
Copy link
Member Author

georgiy-belyanin commented May 15, 2025

@Totktonada thank you for your detailed review. I am closing the PR since it is made from the fork. Though I've force pushed the changes for you to able to close the comments or to ask for changes.

Suppressed by #5116.

@github-actions github-actions bot temporarily deployed to branch-config-storage-client May 15, 2025 16:31 Destroyed
georgiy-belyanin added a commit that referenced this pull request May 15, 2025
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
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.

2 participants