Schema clarifications

This commit is contained in:
Martin Sumner 2020-12-09 09:18:38 +00:00
parent 186e3868a9
commit 182395ee00
2 changed files with 26 additions and 12 deletions

View file

@ -11,7 +11,7 @@
%% @doc Strategy for flushing data to disk %% @doc Strategy for flushing data to disk
%% Can be set to riak_sync, sync (if OTP > 16) or none. Use none, and the OS %% Can be set to riak_sync, sync (if OTP > 16) or none. Use none, and the OS
%% will flush when most efficient. Use riak_sync or sync to flush after every %% will flush when most efficient. Use riak_sync or sync to flush after every
%% PUT (not recommended wihtout some hardware support e.g. flash drives and/or %% PUT (not recommended without some hardware support e.g. flash drives and/or
%% Flash-backed Write Caches) %% Flash-backed Write Caches)
{mapping, "leveled.sync_strategy", "leveled.sync_strategy", [ {mapping, "leveled.sync_strategy", "leveled.sync_strategy", [
{default, none}, {default, none},
@ -100,9 +100,11 @@
{datatype, integer} {datatype, integer}
]}. ]}.
%% @doc The number of times per day to score an individual file for compaction %% @doc The number of times per day to score an individual file for compaction.
%% The default value will lead to each file, on average, being scored once
%% every 8 hours
{mapping, "leveled.compaction_scores_perday", "leveled.compaction_scores_perday", [ {mapping, "leveled.compaction_scores_perday", "leveled.compaction_scores_perday", [
{default, 1}, {default, 3},
{datatype, integer} {datatype, integer}
]}. ]}.
@ -126,7 +128,9 @@
%% @doc Max Journal Files Per Compaction Run %% @doc Max Journal Files Per Compaction Run
%% In a single compaction run, what is the maximum number of consecutive files %% In a single compaction run, what is the maximum number of consecutive files
%% which may be compacted. %% which may be compacted. If increasing this value, the average number of
%% files per run may decrease, unless adjustments are also made to the
%% maxrunlength and singlefile compactionpercentage settings.
{mapping, "leveled.max_run_length", "leveled.max_run_length", [ {mapping, "leveled.max_run_length", "leveled.max_run_length", [
{default, 4}, {default, 4},
{datatype, integer} {datatype, integer}
@ -146,10 +150,10 @@
%% @doc Target Percentage for Single File %% @doc Target Percentage for Single File
%% What is the target score for a run of a single file, to qualify for %% What is the target score for a run of a single file, to qualify for
%% compaction. If less than this percentage would be retained after compaction %% compaction. If less than this percentage would be retained after compaction
%% then it is a candidate (e.g. in default case if 70% of space would be %% then it is a candidate (e.g. in default case if 75% of space would be
%% recovered) %% recovered)
{mapping, "leveled.singlefile_compactionpercentage", "leveled.singlefile_compactionpercentage", [ {mapping, "leveled.singlefile_compactionpercentage", "leveled.singlefile_compactionpercentage", [
{default, 30.0}, {default, 25.0},
{datatype, float}, {datatype, float},
hidden hidden
]}. ]}.

View file

@ -12,7 +12,7 @@
%% @doc Strategy for flushing data to disk %% @doc Strategy for flushing data to disk
%% Can be set to riak_sync, sync (if OTP > 16) or none. Use none, and the OS %% Can be set to riak_sync, sync (if OTP > 16) or none. Use none, and the OS
%% will flush when most efficient. Use riak_sync or sync to flush after every %% will flush when most efficient. Use riak_sync or sync to flush after every
%% PUT (not recommended wihtout some hardware support e.g. flash drives and/or %% PUT (not recommended without some hardware support e.g. flash drives and/or
%% Flash-backed Write Caches) %% Flash-backed Write Caches)
{mapping, "multi_backend.$name.leveled.sync_strategy", "riak_kv.multi_backend", [ {mapping, "multi_backend.$name.leveled.sync_strategy", "riak_kv.multi_backend", [
{default, none}, {default, none},
@ -91,11 +91,19 @@
%% The higher the value, the more compaction runs, and the sooner space is %% The higher the value, the more compaction runs, and the sooner space is
%% recovered. But each run has a cost %% recovered. But each run has a cost
{mapping, "multi_backend.$name.leveled.compaction_runs_perday", "riak_kv.multi_backend", [ {mapping, "multi_backend.$name.leveled.compaction_runs_perday", "riak_kv.multi_backend", [
{default, 16}, {default, 24},
{datatype, integer}, {datatype, integer},
hidden hidden
]}. ]}.
%% @doc The number of times per day to score an individual file for compaction
%% The default value will lead to each file, on average, being scored once
%% every 8 hours
{mapping, "multi_backend.$name.leveled.compaction_scores_perday", "riak_kv.multi_backend", [
{default, 3},
{datatype, integer}
]}.
%% @doc Compaction Low Hour %% @doc Compaction Low Hour
%% The hour of the day in which journal compaction can start. Use Low hour %% The hour of the day in which journal compaction can start. Use Low hour
%% of 0 and High hour of 23 to have no compaction window (i.e. always compact %% of 0 and High hour of 23 to have no compaction window (i.e. always compact
@ -118,9 +126,11 @@
%% @doc Max Journal Files Per Compaction Run %% @doc Max Journal Files Per Compaction Run
%% In a single compaction run, what is the maximum number of consecutive files %% In a single compaction run, what is the maximum number of consecutive files
%% which may be compacted. %% which may be compacted. If increasing this value, the average number of
%% files per run may decrease, unless adjustments are also made to the
%% maxrunlength and singlefile compactionpercentage settings.
{mapping, "multi_backend.$name.leveled.max_run_length", "riak_kv.multi_backend", [ {mapping, "multi_backend.$name.leveled.max_run_length", "riak_kv.multi_backend", [
{default, 6}, {default, 4},
{datatype, integer}, {datatype, integer},
hidden hidden
]}. ]}.
@ -139,10 +149,10 @@
%% @doc Target Percentage for Single File %% @doc Target Percentage for Single File
%% What is the target score for a run of a single file, to qualify for %% What is the target score for a run of a single file, to qualify for
%% compaction. If less than this percentage would be retained after compaction %% compaction. If less than this percentage would be retained after compaction
%% then it is a candidate (e.g. in default case if 50% of space would be %% then it is a candidate (e.g. in default case if 25% of space would be
%% recovered) %% recovered)
{mapping, "multi_backend.$name.leveled.singlefile_compactionpercentage", "riak_kv.multi_backend", [ {mapping, "multi_backend.$name.leveled.singlefile_compactionpercentage", "riak_kv.multi_backend", [
{default, 50.0}, {default, 25.0},
{datatype, float}, {datatype, float},
hidden hidden
]}. ]}.