Add new flag to change Teradata Transaction mode (#338)

dawidxc · web-flow · commit 2c38fc04243c · 2024-01-11T20:50:27.000+01:00
The default transaction mode in the dumper is ANSI.

The new command-line flag `-Dteradata.tmode` allows setting this mode to one of ANSI, TERA, DEFAULT or NONE for the `teradata` and `teradata-logs` connectors.
diff --git a/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/MetadataDumperUsageException.java b/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/MetadataDumperUsageException.java
@@ -27,7 +27,7 @@
  *
  * @author matt
  */
-public class MetadataDumperUsageException extends Exception {
+public class MetadataDumperUsageException extends RuntimeException {
 
   private final List<String> msgs;
 
diff --git a/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/AbstractTeradataConnector.java b/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/AbstractTeradataConnector.java
@@ -16,8 +16,12 @@
  */
 package com.google.edwmigration.dumper.application.dumper.connector.teradata;
 
+import static com.google.edwmigration.dumper.application.dumper.connector.teradata.TeradataUtils.determineTransactionMode;
+
 import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Joiner;
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
 import com.google.common.io.ByteSink;
 import com.google.edwmigration.dumper.application.dumper.ConnectorArguments;
 import com.google.edwmigration.dumper.application.dumper.annotations.RespectsArgumentDriverClass;
@@ -28,6 +32,7 @@
 import com.google.edwmigration.dumper.application.dumper.annotations.RespectsArgumentUser;
 import com.google.edwmigration.dumper.application.dumper.annotations.RespectsInput;
 import com.google.edwmigration.dumper.application.dumper.connector.AbstractJdbcConnector;
+import com.google.edwmigration.dumper.application.dumper.connector.ConnectorProperty;
 import com.google.edwmigration.dumper.application.dumper.handle.Handle;
 import com.google.edwmigration.dumper.application.dumper.handle.JdbcHandle;
 import com.google.edwmigration.dumper.application.dumper.task.JdbcSelectTask;
@@ -41,6 +46,7 @@
 import java.time.ZoneOffset;
 import java.time.format.DateTimeFormatter;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import javax.annotation.Nonnull;
@@ -87,6 +93,31 @@ public abstract class AbstractTeradataConnector extends AbstractJdbcConnector {
   @VisibleForTesting /* pp */ static final String DEF_LOG_TABLE = "dbc.DBQLogTbl";
   @VisibleForTesting /* pp */ static final String DEF_QUERY_TABLE = "dbc.DBQLSQLTbl";
 
+  protected enum CommonTeradataConnectorProperty implements ConnectorProperty {
+    TMODE(
+        "teradata.tmode",
+        "Transaction mode - one of ANSI, TERA, DEFAULT or NONE. If NONE is used, then no"
+            + " transaction mode is included in the JDBC connection string. Default: ANSI.");
+
+    private final String name;
+    private final String description;
+
+    CommonTeradataConnectorProperty(String name, String description) {
+      this.name = name;
+      this.description = description;
+    }
+
+    @Nonnull
+    public String getName() {
+      return name;
+    }
+
+    @Nonnull
+    public String getDescription() {
+      return description;
+    }
+  }
+
   protected static class TeradataJdbcSelectTask extends JdbcSelectTask {
 
     private final String sqlCount;
@@ -166,7 +197,13 @@ public Handle open(ConnectorArguments arguments) throws Exception {
     if (url == null) {
       String host = arguments.getHost();
       int port = arguments.getPort(OPT_PORT_DEFAULT);
-      url = "jdbc:teradata://" + host + "/DBS_PORT=" + port + ",TMODE=ANSI,CHARSET=UTF8";
+      ImmutableList.Builder<String> properties = ImmutableList.builder();
+      properties.add("DBS_PORT=" + port);
+      determineTransactionMode(
+              Optional.ofNullable(arguments.getDefinition(CommonTeradataConnectorProperty.TMODE)))
+          .ifPresent(transactionMode -> properties.add("TMODE=" + transactionMode));
+      properties.add("CHARSET=UTF8");
+      url = "jdbc:teradata://" + host + "/" + (Joiner.on(",").join(properties.build()));
       // ,MAX_MESSAGE_BODY=16777216
     }
 
diff --git a/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataLogsConnector.java b/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataLogsConnector.java
@@ -98,7 +98,8 @@ public enum TeradataLogsConnectorProperty implements ConnectorProperty {
             + " Example: 10000. Allowed range: "
             + MAX_SQL_LENGTH_RANGE
             + ".",
-        /* defaultValue= */ null);
+        /* defaultValue= */ null),
+    TMODE(CommonTeradataConnectorProperty.TMODE);
 
     private final String name;
     private final String description;
@@ -110,6 +111,12 @@ public enum TeradataLogsConnectorProperty implements ConnectorProperty {
       this.defaultValue = defaultValue;
     }
 
+    TeradataLogsConnectorProperty(CommonTeradataConnectorProperty connectorProperty) {
+      this.name = connectorProperty.getName();
+      this.description = connectorProperty.getDescription();
+      this.defaultValue = null;
+    }
+
     @Nonnull
     public String getName() {
       return name;
diff --git a/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataMetadataConnector.java b/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataMetadataConnector.java
@@ -79,7 +79,8 @@ public enum TeradataMetadataConnectorProperties implements ConnectorProperty {
             + " Text that is longer than the defined limit will be split into multiple rows."
             + " Example: 10000. Allowed range: "
             + MAX_TEXT_LENGTH_RANGE
-            + ".");
+            + "."),
+    TMODE(CommonTeradataConnectorProperty.TMODE);
 
     private final String name;
     private final String description;
@@ -89,6 +90,11 @@ public enum TeradataMetadataConnectorProperties implements ConnectorProperty {
       this.description = description;
     }
 
+    TeradataMetadataConnectorProperties(CommonTeradataConnectorProperty connectorProperty) {
+      this.name = connectorProperty.getName();
+      this.description = connectorProperty.getDescription();
+    }
+
     @Nonnull
     public String getName() {
       return name;
diff --git a/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataUtils.java b/dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataUtils.java
@@ -17,10 +17,14 @@
 package com.google.edwmigration.dumper.application.dumper.connector.teradata;
 
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableSet;
+import com.google.edwmigration.dumper.application.dumper.MetadataDumperUsageException;
 import java.util.Optional;
 import java.util.function.Supplier;
 
 public class TeradataUtils {
+  private static final ImmutableSet<String> VALID_TRANSACTION_MODES =
+      ImmutableSet.of("ANSI", "TERA", "DEFAULT", "NONE");
 
   public static <T> Optional<T> optionalIf(boolean condition, Supplier<T> supplier) {
     return condition ? Optional.of(supplier.get()) : Optional.empty();
@@ -46,6 +50,33 @@ public static String formatQuery(String query) {
     return query.replaceAll("\\s+", " ").replaceAll("\\( ", "(").replaceAll(" \\)", ")").trim();
   }
 
+  /**
+   * If the mode is not provided (empty optional), then returns the default mode - ANSI. Otherwise,
+   * performs the validation of the transaction mode.
+   *
+   * @param commandLineTransactionMode command-line argument containing the transaction mode
+   * @return validated transaction mode
+   * @throws MetadataDumperUsageException if the mode is not supported
+   */
+  static Optional<String> determineTransactionMode(Optional<String> commandLineTransactionMode)
+      throws MetadataDumperUsageException {
+    if (!commandLineTransactionMode.isPresent()) {
+      return Optional.of("ANSI");
+    }
+    Optional<String> processedMode =
+        commandLineTransactionMode.map(mode -> mode.trim().toUpperCase());
+    processedMode.ifPresent(
+        mode -> {
+          if (!VALID_TRANSACTION_MODES.contains(mode)) {
+            throw new MetadataDumperUsageException(
+                String.format(
+                    "Unsupported transaction mode='%s', supported modes='%s'.",
+                    commandLineTransactionMode.get(), VALID_TRANSACTION_MODES));
+          }
+        });
+    return processedMode.filter(mode -> !mode.equals("NONE"));
+  }
+
   static String createTimestampExpression(String tableAlias, String columnName) {
     return createTimestampExpression(Optional.of(tableAlias), columnName);
   }
diff --git a/dumper/app/src/test/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataUtilsTest.java b/dumper/app/src/test/java/com/google/edwmigration/dumper/application/dumper/connector/teradata/TeradataUtilsTest.java
@@ -19,6 +19,8 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThrows;
 
+import com.google.edwmigration.dumper.application.dumper.MetadataDumperUsageException;
+import java.util.Optional;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
@@ -95,4 +97,52 @@ public void formatQuery_spacesInsideMultipleParentheses() {
 
     assertEquals("SELECT (2 + N + (3 + N + (N + N)))", formattedQuery);
   }
+
+  @Test
+  public void determineTransactionMode_tera() {
+    Optional<String> transactionMode = TeradataUtils.determineTransactionMode(Optional.of("TERA"));
+
+    assertEquals(Optional.of("TERA"), transactionMode);
+  }
+
+  @Test
+  public void determineTransactionMode_ansi() {
+    Optional<String> transactionMode = TeradataUtils.determineTransactionMode(Optional.of("ANSI"));
+
+    assertEquals(Optional.of("ANSI"), transactionMode);
+  }
+
+  @Test
+  public void determineTransactionMode_default() {
+    Optional<String> transactionMode =
+        TeradataUtils.determineTransactionMode(Optional.of("DEFAULT"));
+
+    assertEquals(Optional.of("DEFAULT"), transactionMode);
+  }
+
+  @Test
+  public void determineTransactionMode_unsupportedMode_throwsException() {
+    MetadataDumperUsageException e =
+        assertThrows(
+            MetadataDumperUsageException.class,
+            () -> TeradataUtils.determineTransactionMode(Optional.of("fast")));
+
+    assertEquals(
+        "Unsupported transaction mode='fast', supported modes='[ANSI, TERA, DEFAULT, NONE]'.",
+        e.getMessage());
+  }
+
+  @Test
+  public void determineTransactionMode_none() {
+    Optional<String> transactionMode = TeradataUtils.determineTransactionMode(Optional.of("NONE"));
+
+    assertEquals(Optional.empty(), transactionMode);
+  }
+
+  @Test
+  public void determineTransactionMode_commandLineOptionNotSpecified() {
+    Optional<String> transactionMode = TeradataUtils.determineTransactionMode(Optional.empty());
+
+    assertEquals(Optional.of("ANSI"), transactionMode);
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`*`
`28`	`28`	`* @author matt`
`29`	`29`	`*/`
`30`		`-public class MetadataDumperUsageException extends Exception {`
	`30`	`+public class MetadataDumperUsageException extends RuntimeException {`
`31`	`31`
`32`	`32`	`private final List<String> msgs;`
`33`	`33`