8000 Document usage on replica and `force` option more clearly · Issue #14 · tarantool/expirationd · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Document usage on replica and force option more clearly #14

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.

Sign up for GitHub

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

Jump to bottom
Closed
rtsisyk opened this issue Aug 1, 2016 · 1 comment
Closed

Document usage on replica and force option more clearly #14

rtsisyk opened this issue Aug 1, 2016 · 1 comment
Assignees
@lenkis
Labels
documentation Improvements or additions to documentation enhancement good first issue Good for newcomers

Comments

@rtsisyk
Copy link
Contributor
rtsisyk commented Aug 1, 2016

I and @kostja spent some time on IoT Hackathon trying to get expirationd working. It would be nice to log a warning that expirationd doesn't work on replica by default and force option should be used.
@bigbes bigbes assigned bigbes and lenkis and unassigned bigbes May 25, 2017
@bigbes
Copy link
Contributor
bigbes commented May 25, 2017

Document vinyl-specific options and tell about specific of vinyl expiration.

Options:

+    -- assumed size of vinyl space (in the first iteration)
+    vinyl_assumed_space_len = math.pow(10, 7),
+    -- factor for recalculation of vinyl space size
+    vinyl_assumed_space_len_factor = 2

Specific:

Vinyl space size can't be counted (since many operations, upsert for example, are applied when you address some data), so you should count (approximate space size) tuples with the first start. vinyl_assumed_space_len is approximate count for first run and vinyl_assumed_space_len_factor for next milestone (after we've reached next milestone is * and so on)

This was referenced Nov 23, 2018
Closed
Closed
@Totktonada Totktonada added the good first issue Good for newcomers label Aug 18, 2020
@Totktonada Totktonada mentioned this issue Oct 23, 2020
Closed
@ligurio ligurio added the documentation Improvements or additions to documentation label Sep 10, 2021
ligurio added a commit that referenced this issue Sep 10, 2021
@ligurio
Update documentation and convert to LDoc format
4bf7bab 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

TODO:
- Task API
- возвращаемые значения
- не описаны поля task (worker_canceled, atomic_iteration)

Closes #14
Closes #60
ligurio added a commit that referenced this issue Sep 13, 2021
@ligurio
Update documentation and convert to LDoc format
6e569b0 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

TODO:
- Task API
- возвращаемые значения
- не описаны поля task (worker_canceled, atomic_iteration)

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Update documentation and convert to LDoc format
2713649 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Update documentation and convert to LDoc format
163ae35 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Update documentation and convert to LDoc format
26f1401 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Update documentation and convert to LDoc format
4ddaf23 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
7fb12d1 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
a8b23bf 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
3ee2377 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 24, 2021
@ligurio
Update documentation and convert to LDoc format
acd7718 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
@Totktonada Totktonada mentioned this issue Sep 26, 2021
Merged
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Update documentation and convert to LDoc format
136de8b 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Update documentation and convert to LDoc format
ae702c9 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Update documentation and convert to LDoc format
6908f00 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Update documentation and convert to LDoc format
88d3def 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Oct 8, 2021
@ligurio
Update documentation and convert to LDoc format
3eb232b 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #60
Part of #14
Part of #79
ligurio added a commit that referenced this issue Oct 8, 2021
@ligurio
Add note about using expirationd with replication
0558013 
Closes #14
ligurio added a commit that referenced this issue Oct 8, 2021
@ligurio
Update documentation and convert to LDoc format
b8d170b 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #60
Part of #14
Part of #79
@ligurio ligurio closed this as completed in fbdf996 Oct 8, 2021
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
Update documentation and convert to LDoc format
718baa4 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes tarantool#60
Part of tarantool#14
Part of tarantool#79
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
Add note about using expirationd with replication
f9f4982 
Closes tarantool#14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lenkis lenkis

Labels
documentation Improvements or additions to documentation enhancement good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@Totktonada @bigbes @ligurio @rtsisyk @lenkis
0