Skip to content

Commit

Permalink
app/vmctl: document that -vm-native-step-interval command-line option…
Browse files Browse the repository at this point in the history
… now supports `week` value

This is a follow-up for d322ee4

Updates #4738
  • Loading branch information
valyala committed Aug 12, 2023
1 parent 9ac0d98 commit f7f29a1
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions app/vmctl/README.md
Expand Up @@ -826,7 +826,7 @@ It is possible split migration process into set of smaller batches based on time
migrating large volumes of data as this adds indication of progress and ability to restore process from certain point
in case of failure.

To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `day`, `hour`, `minute`.
To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `week`, `day`, `hour`, `minute`.
Note that in order to use this it is required `--vm-native-filter-time-start` to be set to calculate time ranges for
export process.

Expand All @@ -836,7 +836,7 @@ Every range is being processed independently, which means that:
so it is possible to restart process starting from failed range.

It is recommended using the `month` step when migrating the data over multiple months,
since the migration with `day` and `hour` steps may take longer time to complete because of additional overhead.
since the migration with `week`, `day` and `hour` steps may take longer time to complete because of additional overhead.

Usage example:
```console
Expand Down
5 changes: 3 additions & 2 deletions app/vmctl/flags.go
Expand Up @@ -361,8 +361,9 @@ var (
Usage: "The time filter may contain different timestamp formats. See more details here https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#timestamp-formats",
},
&cli.StringFlag{
Name: vmNativeStepInterval,
Usage: fmt.Sprintf("Split export data into chunks. Requires setting --%s. Valid values are '%s','%s','%s','%s'.", vmNativeFilterTimeStart, stepper.StepMonth, stepper.StepDay, stepper.StepHour, stepper.StepMinute),
Name: vmNativeStepInterval,
Usage: fmt.Sprintf("Split export data into chunks. Requires setting --%s. Valid values are '%s','%s','%s','%s','%s'.", vmNativeFilterTimeStart,
stepper.StepMonth, stepper.StepWeek, stepper.StepDay, stepper.StepHour, stepper.StepMinute),
Value: stepper.StepMonth,
},
&cli.BoolFlag{
Expand Down
4 changes: 2 additions & 2 deletions app/vmctl/stepper/split.go
Expand Up @@ -8,10 +8,10 @@ import (
const (
// StepMonth represents a one month interval
StepMonth string = "month"
// StepDay represents a one day interval
StepDay string = "day"
// StepWeek represents a one week interval
StepWeek string = "week"
// StepDay represents a one day interval
StepDay string = "day"
// StepHour represents a one hour interval
StepHour string = "hour"
// StepMinute represents a one minute interval
Expand Down
4 changes: 2 additions & 2 deletions docs/vmctl.md
Expand Up @@ -837,7 +837,7 @@ It is possible split migration process into set of smaller batches based on time
migrating large volumes of data as this adds indication of progress and ability to restore process from certain point
in case of failure.

To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `day`, `hour`, `minute`.
To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `week`, `day`, `hour`, `minute`.
Note that in order to use this it is required `--vm-native-filter-time-start` to be set to calculate time ranges for
export process.

Expand All @@ -847,7 +847,7 @@ Every range is being processed independently, which means that:
so it is possible to restart process starting from failed range.

It is recommended using the `month` step when migrating the data over multiple months,
since the migration with `day` and `hour` steps may take longer time to complete because of additional overhead.
since the migration with `week`, `day` and `hour` steps may take longer time to complete because of additional overhead.

Usage example:
```console
Expand Down

0 comments on commit f7f29a1

Please sign in to comment.