Skip to content
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

Enhance description for S3 export/import CLI parameters #10331

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions ydb/public/lib/ydb_cli/commands/ydb_service_export.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,12 @@ void TCommandExportToS3::Config(TConfig& config) {
config.Opts->AddLongOption("s3-endpoint", "S3 endpoint to connect to")
.Required().RequiredArgument("ENDPOINT").StoreResult(&AwsEndpoint);

config.Opts->AddLongOption("scheme", "S3 endpoint scheme")
auto colors = NColorizer::AutoColors(Cout);
config.Opts->AddLongOption("scheme", TStringBuilder()
<< "S3 endpoint scheme - "
<< colors.BoldColor() << "http" << colors.OldColor()
<< " or "
<< colors.BoldColor() << "https" << colors.OldColor())
.RequiredArgument("SCHEME").StoreResult(&AwsScheme).DefaultValue(AwsScheme);

TStringBuilder storageClassHelp;
Expand Down Expand Up @@ -277,7 +282,12 @@ void TCommandExportToS3::Config(TConfig& config) {
<< " - zstd-N (N is compression level, e.g. zstd-3)" << Endl)
.RequiredArgument("STRING").StoreResult(&Compression);

config.Opts->AddLongOption("use-virtual-addressing", "S3 bucket virtual addressing")
config.Opts->AddLongOption("use-virtual-addressing", TStringBuilder()
<< "Sets bucket URL style. Value "
<< colors.BoldColor() << "true" << colors.OldColor()
<< " means use Virtual-Hosted-Style URL, "
<< colors.BoldColor() << "false" << colors.OldColor()
<< " - Path-Style URL.")
.RequiredArgument("BOOL").StoreResult<bool>(&UseVirtualAddressing).DefaultValue("true");

AddDeprecatedJsonOption(config);
Expand Down
14 changes: 12 additions & 2 deletions ydb/public/lib/ydb_cli/commands/ydb_service_import.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,12 @@ void TCommandImportFromS3::Config(TConfig& config) {
config.Opts->AddLongOption("s3-endpoint", "S3 endpoint to connect to")
.Required().RequiredArgument("ENDPOINT").StoreResult(&AwsEndpoint);

config.Opts->AddLongOption("scheme", "S3 endpoint scheme")
auto colors = NColorizer::AutoColors(Cout);
config.Opts->AddLongOption("scheme", TStringBuilder()
<< "S3 endpoint scheme - "
<< colors.BoldColor() << "http" << colors.OldColor()
<< " or "
<< colors.BoldColor() << "https" << colors.OldColor())
.RequiredArgument("SCHEME").StoreResult(&AwsScheme).DefaultValue(AwsScheme);

config.Opts->AddLongOption("bucket", "S3 bucket")
Expand Down Expand Up @@ -92,7 +97,12 @@ void TCommandImportFromS3::Config(TConfig& config) {
config.Opts->AddLongOption("retries", "Number of retries")
.RequiredArgument("NUM").StoreResult(&NumberOfRetries).DefaultValue(NumberOfRetries);

config.Opts->AddLongOption("use-virtual-addressing", "S3 bucket virtual addressing")
config.Opts->AddLongOption("use-virtual-addressing", TStringBuilder()
<< "Sets bucket URL style. Value "
<< colors.BoldColor() << "true" << colors.OldColor()
<< " means use Virtual-Hosted-Style URL, "
<< colors.BoldColor() << "false" << colors.OldColor()
<< " - Path-Style URL.")
.RequiredArgument("BOOL").StoreResult<bool>(&UseVirtualAddressing).DefaultValue("true");

config.Opts->AddLongOption("no-acl", "Prevent importing of ACL and owner")
Expand Down