Replace usages of 'client' and 'cluster' with 'driver' and 'enterprise' throughout (#212)

## What is the goal of this PR?

We replace the term 'cluster' with 'enterprise', to reflect the new
consistent terminology used through Vaticle. We also replace 'client'
with 'driver', where appropriate.

## What are the changes implemented in this PR?

* Update REPL, README and code to no longer refer to TypeDB 'Clients',
and use the new terminology of TypeDB 'Drivers', and replace usage of
TypeDB 'Cluster' with TypeDB 'Enterprise'

---------

Co-authored-by: joshua <[email protected]>

Author: dmitrii-ubskii

BUILD

@@ -42,9 +42,9 @@ java_library(
     name = "console",
     srcs = glob(["*.java", "*/*.java", "*/*/*.java"], exclude=["bazel-*/*"]) + [":version"],
     deps = [
-        "@vaticle_typedb_client_java//java:client-java",
-        "@vaticle_typedb_client_java//java/api",
-        "@vaticle_typedb_client_java//java/common",
+        "@vaticle_typedb_driver//java:driver-java",
+        "@vaticle_typedb_driver//java/api",
+        "@vaticle_typedb_driver//java/common",
         "@vaticle_typeql//java:typeql-lang",
         "@vaticle_typeql//java/common:common",
         "@vaticle_typeql//java/query",
@@ -196,7 +196,7 @@ release_validate_deps(
     tagged_deps = [
         "@vaticle_typedb_common",
         "@vaticle_typeql",
-        "@vaticle_typedb_client_java",
+        "@vaticle_typedb_driver",
     ],
     tags = ["manual"]  # in order for bazel test //... to not fail
 )

README.md

@@ -20,11 +20,11 @@ cd <your_typedb_console_dir>/
 You can provide several command arguments when running console in the terminal.
 
 - `--server=<address>` : TypeDB server address to which the console will connect to.
-- `--cluster=<address>` : TypeDB Cluster server address to which the console will connect to.
-- `--username=<username>` : TypeDB Cluster username to connect with.
-- `--password` : Interactively enter password to connect to TypeDB Cluster with.
+- `--enterprise=<address>` : TypeDB Enterprise server address to which the console will connect to.
+- `--username=<username>` : TypeDB Enterprise username to connect with.
+- `--password` : Interactively enter password to connect to TypeDB Enterprise with.
 - `--script=<script>` : Run commands in the script file in non-interactive mode.
-- `--tls-enabled`: Enable TLS for connecting to TypeDB Cluster.
+- `--tls-enabled`: Enable TLS for connecting to TypeDB Enterprise.
 - `--tls-root-ca`: Path to root CA certificate for TLS encryption.
 - `--command=<command1> --command=<command2> ...` : Run commands in non-interactive mode.
 - `-V, --version` : Print version information and exit.

TypeDBConsole.java

@@ -145,11 +145,11 @@ pip_deps()
 ################################
 
 # Load repositories
-load("//dependencies/vaticle:repositories.bzl", "vaticle_typedb_common", "vaticle_typedb_client_java")
+load("//dependencies/vaticle:repositories.bzl", "vaticle_typedb_common", "vaticle_typedb_driver")
 vaticle_typedb_common()
-vaticle_typedb_client_java()
+vaticle_typedb_driver()
 
-load("@vaticle_typedb_client_java//dependencies/vaticle:repositories.bzl", "vaticle_typedb_protocol", "vaticle_typeql")
+load("@vaticle_typedb_driver//dependencies/vaticle:repositories.bzl", "vaticle_typedb_protocol", "vaticle_typeql")
 vaticle_typeql()
 vaticle_typedb_protocol()
 
@@ -160,7 +160,7 @@ vaticle_typedb_artifact()
 # Load maven
 load("@vaticle_typedb_common//dependencies/maven:artifacts.bzl", vaticle_typedb_common_artifacts = "artifacts")
 load("@vaticle_typeql//dependencies/maven:artifacts.bzl", vaticle_typeql_artifacts = "artifacts")
-load("@vaticle_typedb_client_java//dependencies/maven:artifacts.bzl", vaticle_typedb_client_java_artifacts = "artifacts")
+load("@vaticle_typedb_driver//dependencies/maven:artifacts.bzl", vaticle_typedb_driver_artifacts = "artifacts")
 load("@vaticle_typedb_console//dependencies/maven:artifacts.bzl", vaticle_typedb_console_artifacts = "artifacts")
 
 ###############
@@ -171,7 +171,7 @@ load("@vaticle_dependencies//library/maven:rules.bzl", "maven")
 maven(
     vaticle_typedb_common_artifacts +
     vaticle_typeql_artifacts +
-    vaticle_typedb_client_java_artifacts +
+    vaticle_typedb_driver_artifacts +
     vaticle_typedb_console_artifacts +
     vaticle_dependencies_tool_maven_artifacts +
     io_grpc_artifacts,

WORKSPACE

@@ -17,10 +17,10 @@
 
 package com.vaticle.typedb.console.command;
 
-import com.vaticle.typedb.client.api.TypeDBClient;
-import com.vaticle.typedb.client.api.TypeDBOptions;
-import com.vaticle.typedb.client.api.TypeDBSession;
-import com.vaticle.typedb.client.api.TypeDBTransaction;
+import com.vaticle.typedb.driver.api.TypeDBDriver;
+import com.vaticle.typedb.driver.api.TypeDBOptions;
+import com.vaticle.typedb.driver.api.TypeDBSession;
+import com.vaticle.typedb.driver.api.TypeDBTransaction;
 import com.vaticle.typedb.common.collection.Pair;
 import com.vaticle.typedb.console.common.Printer;
 import com.vaticle.typedb.console.common.Utils;
@@ -532,17 +532,17 @@ class Options {
 
         public static String token = "transaction-options";
 
-        static TypeDBOptions from(String[] optionTokens, boolean isCluster) {
-            if (isCluster) return parseClusterOptions(optionTokens, new TypeDBOptions());
+        static TypeDBOptions from(String[] optionTokens, boolean isEnterprise) {
+            if (isEnterprise) return parseEnterpriseOptions(optionTokens, new TypeDBOptions());
             else return parseCoreOptions(optionTokens, new TypeDBOptions());
         }
 
-        private static TypeDBOptions parseClusterOptions(String[] optionTokens, TypeDBOptions options) {
+        private static TypeDBOptions parseEnterpriseOptions(String[] optionTokens, TypeDBOptions options) {
             for (int i = 0; i < optionTokens.length; i += 2) {
                 String token = optionTokens[i];
                 String arg = optionTokens[i + 1];
                 assert token.charAt(0) == '-' && token.charAt(1) == '-';
-                Option<TypeDBOptions> option = Options.Cluster.clusterOption(token.substring(2));
+                Option<TypeDBOptions> option = Options.Enterprise.enterpriseOption(token.substring(2));
                 try {
                     options = option.build(options, arg);
                 } catch (IllegalArgumentException e) {
@@ -606,20 +606,20 @@ static List<Pair<String, String>> helpMenu(List<? extends Option<? extends TypeD
             }
         }
 
-        static class Cluster extends Core {
+        static class Enterprise extends Core {
 
-            private static List<Option.Cluster> options = withCoreOptions(
-                    Option.cluster("read-any-replica", Option.Arg.BOOLEAN, "Allow (possibly stale) reads from any replica", (opt, arg) -> opt.readAnyReplica((Boolean) arg))
+            private static List<Option.Enterprise> options = withCoreOptions(
+                    Option.enterprise("read-any-replica", Option.Arg.BOOLEAN, "Allow (possibly stale) reads from any replica", (opt, arg) -> opt.readAnyReplica((Boolean) arg))
             );
 
-            private static List<Option.Cluster> withCoreOptions(Option.Cluster... clusterOptions) {
-                List<Option.Cluster> extendedOptions = new ArrayList<>();
-                Core.options.forEach(opt -> extendedOptions.add(opt.asClusterOption()));
-                extendedOptions.addAll(Arrays.asList(clusterOptions));
+            private static List<Option.Enterprise> withCoreOptions(Option.Enterprise... enterpriseOptions) {
+                List<Option.Enterprise> extendedOptions = new ArrayList<>();
+                Core.options.forEach(opt -> extendedOptions.add(opt.asEnterpriseOption()));
+                extendedOptions.addAll(Arrays.asList(enterpriseOptions));
                 return extendedOptions;
             }
 
-            public static Option<TypeDBOptions> clusterOption(String token) throws IllegalArgumentException {
+            public static Option<TypeDBOptions> enterpriseOption(String token) throws IllegalArgumentException {
                 return from(token, options);
             }
 
@@ -646,8 +646,8 @@ static Option.Core core(String name, Arg arg, String description, BiFunction<Typ
                 return new Option.Core(name, arg, description, builder);
             }
 
-            static Option.Cluster cluster(String name, Arg arg, String description, BiFunction<TypeDBOptions, Object, TypeDBOptions> builder) {
-                return new Option.Cluster(name, arg, description, builder);
+            static Option.Enterprise enterprise(String name, Arg arg, String description, BiFunction<TypeDBOptions, Object, TypeDBOptions> builder) {
+                return new Option.Enterprise(name, arg, description, builder);
             }
 
             OPTIONS build(OPTIONS options, String arg) {
@@ -666,14 +666,14 @@ private Core(String name, Arg arg, String description, BiFunction<TypeDBOptions,
                     super(name, arg, description, builder);
                 }
 
-                Option.Cluster asClusterOption() {
-                    return new Option.Cluster(name, arg, description, (clusterOption, arg) -> builder.apply(clusterOption, arg));
+                Option.Enterprise asEnterpriseOption() {
+                    return new Option.Enterprise(name, arg, description, (enterpriseOption, arg) -> builder.apply(enterpriseOption, arg));
                 }
             }
 
-            static class Cluster extends Option<TypeDBOptions> {
+            static class Enterprise extends Option<TypeDBOptions> {
 
-                private Cluster(String name, Arg arg, String description, BiFunction<TypeDBOptions, Object, TypeDBOptions> builder) {
+                private Enterprise(String name, Arg arg, String description, BiFunction<TypeDBOptions, Object, TypeDBOptions> builder) {
                     super(name, arg, description, builder);
                 }
             }
@@ -700,9 +700,9 @@ Object parse(String arg) throws IllegalArgumentException {
         }
     }
 
-    static String createHelpMenu(TypeDBClient client, boolean isCluster) {
+    static String createHelpMenu(TypeDBDriver driver, boolean isEnterprise) {
         List<Pair<String, String>> menu = new ArrayList<>();
-        if (client.users() != null) {
+        if (driver.users() != null) {
             menu.addAll(Arrays.asList(
                     pair(User.List.helpCommand, User.List.description),
                     pair(User.Create.helpCommand, User.Create.description),
@@ -717,12 +717,12 @@ static String createHelpMenu(TypeDBClient client, boolean isCluster) {
                 pair(Database.Delete.helpCommand, Database.Delete.description),
                 pair(Database.Schema.helpCommand, Database.Schema.description)));
 
-        if (isCluster) {
+        if (isEnterprise) {
             menu.add(pair(Database.Replicas.helpCommand, Database.Replicas.description));
         }
 
         menu.add(pair(Transaction.helpCommand, Transaction.description));
-        if (isCluster) menu.addAll(Options.Cluster.helpMenu());
+        if (isEnterprise) menu.addAll(Options.Enterprise.helpMenu());
         else menu.addAll(Options.Core.helpMenu());
 
         menu.addAll(Arrays.asList(
@@ -733,11 +733,11 @@ static String createHelpMenu(TypeDBClient client, boolean isCluster) {
         return Utils.createHelpMenu(menu);
     }
 
-    static REPLCommand readREPLCommand(LineReader reader, Printer printer, String prompt, boolean isCluster) throws InterruptedException {
+    static REPLCommand readREPLCommand(LineReader reader, Printer printer, String prompt, boolean isEnterprise) throws InterruptedException {
         REPLCommand command = null;
         while (command == null) {
             String line = Utils.readNonEmptyLine(reader, prompt);
-            command = readREPLCommand(line, reader, isCluster);
+            command = readREPLCommand(line, reader, isEnterprise);
             if (command == null) {
                 printer.error("Unrecognised command, please check help menu");
             }
@@ -746,7 +746,7 @@ static REPLCommand readREPLCommand(LineReader reader, Printer printer, String pr
         return command;
     }
 
-    static REPLCommand readREPLCommand(String line, @Nullable LineReader passwordReader, boolean isCluster) {
+    static REPLCommand readREPLCommand(String line, @Nullable LineReader passwordReader, boolean isEnterprise) {
         REPLCommand command = null;
         String[] tokens = Utils.splitLineByWhitespace(line);
         if (tokens.length == 1 && tokens[0].equals(Exit.token)) {
@@ -795,7 +795,7 @@ static REPLCommand readREPLCommand(String line, @Nullable LineReader passwordRea
             TypeDBSession.Type sessionType = tokens[2].equals("schema") ? TypeDBSession.Type.SCHEMA : TypeDBSession.Type.DATA;
             TypeDBTransaction.Type transactionType = tokens[3].equals("read") ? TypeDBTransaction.Type.READ : TypeDBTransaction.Type.WRITE;
             TypeDBOptions options;
-            if (tokens.length > 4) options = Options.from(Arrays.copyOfRange(tokens, 4, tokens.length), isCluster);
+            if (tokens.length > 4) options = Options.from(Arrays.copyOfRange(tokens, 4, tokens.length), isEnterprise);
             else options = new TypeDBOptions();
             command = new Transaction(database, sessionType, transactionType, options);
         }

command/REPLCommand.java

@@ -17,19 +17,19 @@
 
 package com.vaticle.typedb.console.common;
 
-import com.vaticle.typedb.client.api.TypeDBTransaction;
-import com.vaticle.typedb.client.api.answer.ConceptMap;
-import com.vaticle.typedb.client.api.answer.ConceptMapGroup;
-import com.vaticle.typedb.client.api.answer.Numeric;
-import com.vaticle.typedb.client.api.answer.NumericGroup;
-import com.vaticle.typedb.client.api.concept.Concept;
-import com.vaticle.typedb.client.api.concept.thing.Attribute;
-import com.vaticle.typedb.client.api.concept.thing.Relation;
-import com.vaticle.typedb.client.api.concept.thing.Thing;
-import com.vaticle.typedb.client.api.concept.type.RoleType;
-import com.vaticle.typedb.client.api.concept.type.Type;
-import com.vaticle.typedb.client.api.concept.value.Value;
-import com.vaticle.typedb.client.api.database.Database;
+import com.vaticle.typedb.driver.api.TypeDBTransaction;
+import com.vaticle.typedb.driver.api.answer.ConceptMap;
+import com.vaticle.typedb.driver.api.answer.ConceptMapGroup;
+import com.vaticle.typedb.driver.api.answer.Numeric;
+import com.vaticle.typedb.driver.api.answer.NumericGroup;
+import com.vaticle.typedb.driver.api.concept.Concept;
+import com.vaticle.typedb.driver.api.concept.thing.Attribute;
+import com.vaticle.typedb.driver.api.concept.thing.Relation;
+import com.vaticle.typedb.driver.api.concept.thing.Thing;
+import com.vaticle.typedb.driver.api.concept.type.RoleType;
+import com.vaticle.typedb.driver.api.concept.type.Type;
+import com.vaticle.typedb.driver.api.concept.value.Value;
+import com.vaticle.typedb.driver.api.database.Database;
 import com.vaticle.typedb.console.common.exception.TypeDBConsoleException;
 import com.vaticle.typeql.lang.common.TypeQLToken;
 import org.jline.utils.AttributedString;

common/Printer.java

@@ -28,12 +28,12 @@ def vaticle_typedb_common():
     git_repository(
         name = "vaticle_typedb_common",
         remote = "https://github.com/vaticle/typedb-common",
-        commit = "40f8ab74b34447b59517ce3f027c8700a8aa057a",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
+        tag = "2.24.1",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
     )
 
-def vaticle_typedb_client_java():
+def vaticle_typedb_driver():
     git_repository(
-        name = "vaticle_typedb_client_java",
-        remote = "https://github.com/vaticle/typedb-driver-java",
-        commit = "c9f39aa628ac5eb9d20e46018bf97685587d936a",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_client_java
+        name = "vaticle_typedb_driver",
+        remote = "https://github.com/vaticle/typedb-driver",
+        commit = "8c410a4a1332875b79333457ff63d5cf80861989",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_driver
     )