Add rangeconfig CLI.

fdbcli/RangeConfigCommand.actor.cpp

@@ -0,0 +1,149 @@
+/*
+ * RangeConfigCommand.actor.cpp
+ *
+ * This source file is part of the FoundationDB open source project
+ *
+ * Copyright 2013-2022 Apple Inc. and the FoundationDB project authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <boost/lexical_cast.hpp>
+#include <algorithm>
+#include <boost/lexical_cast/bad_lexical_cast.hpp>
+#include <list>
+
+#include "fdbcli/fdbcli.actor.h"
+#include "fdbclient/NativeAPI.actor.h"
+#include "fdbclient/DataDistributionConfig.actor.h"
+
+#include "flow/actorcompiler.h" // This must be the last #include.
+
+namespace fdb_cli {
+
+ACTOR Future<bool> rangeConfigCommandActor(Database localDb, std::vector<StringRef> tokens) {
+	state std::function<bool(std::string)> fail = [&](std::string msg) {
+		if (!msg.empty()) {
+			fmt::print(stderr, "ERROR: {}\n", msg);
+		}
+		printUsage(tokens[0]);
+		return false;
+	};
+
+	state std::list<StringRef> args(tokens.begin() + 1, tokens.end());
+	state std::function<StringRef()> nextArg = [&]() {
+		ASSERT(!args.empty());
+		auto s = args.front();
+		args.pop_front();
+		return s;
+	};
+	state std::function<int()> nextArgInt = [&]() {
+		if (args.empty()) {
+			throw boost::bad_lexical_cast();
+		}
+		return boost::lexical_cast<int>(nextArg().toString());
+	};
+
+	if (args.size() < 1) {
+		return fail("No subcommand given.");
+	}
+
+	StringRef cmd = nextArg();
+
+	if (cmd == "show"_sr) {
+		state bool includeDefault = false;
+
+		while (!args.empty()) {
+			auto arg = nextArg();
+			if (arg == "includeDefault"_sr) {
+				includeDefault = true;
+			} else {
+				return fail(fmt::format("Unknown argument: '{}'", arg.printable()));
+			}
+		}
+
+		DDConfiguration::RangeConfigMapSnapshot config =
+		    wait(DDConfiguration().userRangeConfig().getSnapshot(localDb.getReference(), allKeys.begin, allKeys.end));
+		fmt::print(
+		    "{}\n",
+		    json_spirit::write_string(DDConfiguration::toJSON(config, includeDefault), json_spirit::pretty_print));
+
+	} else if (cmd == "set"_sr) {
+		if (args.size() < 3) {
+			return fail("Begin, end, and at least one configuration option are required.");
+		}
+
+		state KeyRef begin = nextArg();
+		state KeyRef end = nextArg();
+		if (end <= begin) {
+			return fail("Range end must be > range begin.");
+		}
+
+		state DDRangeConfig rangeConfig;
+
+		while (!args.empty()) {
+			state StringRef option = nextArg();
+
+			try {
+				if (option == "replication"_sr) {
+					rangeConfig.replicationFactor = nextArgInt();
+				} else if (option == "teamID"_sr) {
+					rangeConfig.teamID = nextArgInt();
+				} else {
+					return fail(fmt::format("Unknown range option: '{}'", option.printable()));
+				}
+			} catch (...) {
+				return fail(
+				    fmt::format("Required argument for range option '{}' missing or invalid.", option.toString()));
+			}
+
+			state ReadYourWritesTransaction tr(localDb);
+			loop {
+				try {
+					tr.setOption(FDBTransactionOptions::PRIORITY_SYSTEM_IMMEDIATE);
+					tr.setOption(FDBTransactionOptions::ACCESS_SYSTEM_KEYS);
+					tr.setOption(FDBTransactionOptions::LOCK_AWARE);
+
+					wait(DDConfiguration().userRangeConfig().updateRange(&tr, begin, end, rangeConfig));
+					wait(tr.commit());
+					break;
+				} catch (Error& e) {
+					wait(tr.onError(e));
+				}
+			}
+		}
+	} else {
+		return fail(fmt::format("Unknown command: '{}'", cmd.printable()));
+	}
+
+	return true;
+}
+
+CommandFactory rangeConfigFactory(
+    "rangeconfig",
+    CommandHelp(
+        "rangeconfig show [includeDefault] | [set <beginKey> <endKey> [replication <N>] [teamID <N>]",
+        "Show or set the per-keyrange configuration options.",
+        "The 'show' command will print the range configuration in JSON.  By default, ranges with no configured "
+        "options are not shown, these are called 'default ranges' and can be shown with the 'includeDefault' flag."
+        "A key range can have zero or more override options set.  Unset options for the range will keep their "
+        "default values.  These options do not change anything about the shard map directly, rather they are "
+        "hints which DataDistribution should honor.\n"
+        " Setting 'replication' for a range can be used to increase "
+        "the replication factor for that range, but not to decrease it.  Replication factors in the "
+        "configuration lower than the cluster's configured replication factor will be treated as the cluster's "
+        "replication factor.\n"
+        " Ranges with different teamID settings should be assigned to different storage teams.  Shards with the same "
+        "team ID can be assigned to the same storage team, but nothing explicitly attempts to do or prefer this."));
+
+} // namespace fdb_cli

fdbcli/fdbcli.actor.cpp

@@ -2156,6 +2156,13 @@ ACTOR Future<int> cli(CLIOptions opt, LineNoise* plinenoise, Reference<ClusterCo
 					continue;
 				}
 
+				if (tokencmp(tokens[0], "rangeconfig")) {
+					bool _result = wait(makeInterruptable(rangeConfigCommandActor(localDb, tokens)));
+					if (!_result)
+						is_error = true;
+					continue;
+				}
+
 				fprintf(stderr, "ERROR: Unknown command `%s'. Try `help'?\n", formatStringRef(tokens[0]).c_str());
 				is_error = true;
 			}

fdbcli/include/fdbcli/fdbcli.actor.h

@@ -55,7 +55,8 @@ struct CommandHelp {
 	std::string short_desc;
 	std::string long_desc;
 	CommandHelp() {}
-	CommandHelp(const char* u, const char* s, const char* l) : usage(u), short_desc(s), long_desc(l) {}
+	CommandHelp(const char* usage, const char* short_desc, const char* long_desc)
+	  : usage(usage), short_desc(short_desc), long_desc(long_desc) {}
 };
 
 void arrayGenerator(const char* text, const char* line, const char** options, std::vector<std::string>& lc);
@@ -286,6 +287,9 @@ ACTOR Future<bool> targetVersionCommandActor(Reference<IDatabase> db, std::vecto
 // idempotencyids command
 ACTOR Future<bool> idempotencyIdsCommandActor(Database cx, std::vector<StringRef> tokens);
 
+// rangeconfig command
+ACTOR Future<bool> rangeConfigCommandActor(Database cx, std::vector<StringRef> tokens);
+
 } // namespace fdb_cli
 
 #include "flow/unactorcompiler.h"