Skip to content

Commit

Permalink
describe default values
Browse files Browse the repository at this point in the history
  • Loading branch information
ligurio committed Sep 13, 2021
1 parent 35e5a7b commit 5ff75ac
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions expirationd.lua
Original file line number Diff line number Diff line change
Expand Up @@ -335,10 +335,10 @@ end
-- should be possible to force work on replica.
-- @number[opt] options.full_scan_delay
-- Sleep time between full scans (in seconds). It is allowed to pass an FFI
-- number: `1LL`, `1UL` etc.
-- number: `1LL`, `1UL` etc. Default value is 1 sec.
-- @number[opt] options.full_scan_time
-- Time required for a full index scan (in seconds). It is allowed to pass
-- an FFI number: 1LL, 1UL etc.
-- an FFI number: 1LL, 1UL etc. Default value is 3600.
-- @string[opt] options.index
-- Name or id of the index to iterate on. If omitted, will use the primary
-- index. If there's no index with this name, will throw an error.
Expand All @@ -350,7 +350,7 @@ end
-- There's a default function which can be overriden with this parameter.
-- @number[opt] options.iteration_delay
-- Max sleep time between iterations (in seconds). It is allowed to pass
-- an FFI number: `1LL`, `1UL` etc.
-- an FFI number: `1LL`, `1UL` etc. Default value is 1 sec.
-- @string[opt] options.iterator_type
-- Type of the iterator to use, as string or box.index constant, for
-- example, 'EQ' or `box.index.EQ`, default is `box.index.ALL`. See
Expand All @@ -359,13 +359,17 @@ end
-- [1]: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_index/pairs/.
--
-- @func[opt] options.on_full_scan_complete
-- Function to call after completing a full scan iteration.
-- Function to call after completing a full scan iteration. Default value
-- is a function that do nothing.
-- @func[opt] options.on_full_scan_error
-- Function to call after terminating a full scan due to an error.
-- Function to call after terminating a full scan due to an error. Default
-- value is a function that do nothing.
-- @func[opt] options.on_full_scan_start
-- Function to call before starting a full scan iteration.
-- Function to call before starting a full scan iteration. Default value
-- is a function that do nothing.
-- @func[opt] options.on_full_scan_success
-- Function to call after successfully completing a full scan iteration.
-- Default value is a function that do nothing.
-- @func[opt] options.process_expired_tuple
-- Applied to expired tuples, receives `space_id`, `args`, `tuple` as
-- arguments. Can be a `nil`: by default tuples are removed.
Expand All @@ -378,16 +382,16 @@ end
-- the same data type as the index field or fields, or a function which
-- returns such value. If omitted or nil, all tuples will be checked.
-- @number[opt] options.tuples_per_iteration
-- Number of tuples to check in one batch (iteration). Default is 1024. It
-- is allowed to pass an FFI number: `1LL`, `1UL` etc.
-- Number of tuples to check in one batch (iteration). It is allowed to
-- pass an FFI number: `1LL`, `1UL` etc. Default value is 1024.
-- @number[opt] options.vinyl_assumed_space_len_factor
-- Factor for recalculation of vinyl space size. 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). It is
-- allowed to pass an FFI number: `1LL`, `1UL` etc.
-- allowed to pass an FFI number: `1LL`, `1UL` etc. Default value is 2.
-- @number[opt] options.vinyl_assumed_space_len
-- Assumed size of vinyl space (in the first iteration).
-- Vinyl space size can't be counted (since many operations, `upsert` for
Expand All @@ -396,7 +400,7 @@ end
-- `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). It is allowed to pass an FFI number:
-- `1LL`, `1UL` etc.
-- `1LL`, `1UL` etc. Default value is 10^7.
--
-- @treturn[1] task
--
Expand Down

0 comments on commit 5ff75ac

Please sign in to comment.