feat: Add preserveAsciiControlCharacters to CsvOptions

googleapis · Jun 28, 2022 · ff800b0 · ff800b0
1 parent e1e58d3
commit ff800b0
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/CsvOptions.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/CsvOptions.java
@@ -34,6 +34,7 @@ public final class CsvOptions extends FormatOptions {
   private final String fieldDelimiter;
   private final String quote;
   private final Long skipLeadingRows;
+  private final Boolean preserveAsciiControlCharacters;
 
   public static final class Builder {
 
@@ -43,6 +44,7 @@ public static final class Builder {
     private String fieldDelimiter;
     private String quote;
     private Long skipLeadingRows;
+    private Boolean preserveAsciiControlCharacters;
 
     private Builder() {}
 
@@ -53,6 +55,7 @@ private Builder(CsvOptions csvOptions) {
       this.fieldDelimiter = csvOptions.fieldDelimiter;
       this.quote = csvOptions.quote;
       this.skipLeadingRows = csvOptions.skipLeadingRows;
+      this.preserveAsciiControlCharacters = csvOptions.preserveAsciiControlCharacters;
     }
 
     /**
@@ -130,6 +133,15 @@ public Builder setSkipLeadingRows(long skipLeadingRows) {
       return this;
     }
 
+    /**
+     * Sets whether BigQuery should allow ascii control characters in a CSV file. By default ascii
+     * control characters are not allowed.
+     */
+    public Builder setPreserveAsciiControlCharacters(boolean preserveAsciiControlCharacters) {
+      this.preserveAsciiControlCharacters = preserveAsciiControlCharacters;
+      return this;
+    }
+
     /** Creates a {@code CsvOptions} object. */
     public CsvOptions build() {
       return new CsvOptions(this);
@@ -144,6 +156,7 @@ private CsvOptions(Builder builder) {
     this.fieldDelimiter = builder.fieldDelimiter;
     this.quote = builder.quote;
     this.skipLeadingRows = builder.skipLeadingRows;
+    this.preserveAsciiControlCharacters = builder.preserveAsciiControlCharacters;
   }
 
   /**
@@ -192,6 +205,14 @@ public Long getSkipLeadingRows() {
     return skipLeadingRows;
   }
 
+  /**
+   * Returns whether BigQuery should allow ascii control characters in a CSV file. By default ascii
+   * control characters are not allowed.
+   */
+  public Boolean getPreserveAsciiControlCharacters() {
+    return preserveAsciiControlCharacters;
+  }
+
   /** Returns a builder for the {@code CsvOptions} object. */
   public Builder toBuilder() {
     return new Builder(this);
@@ -207,6 +228,7 @@ public String toString() {
         .add("fieldDelimiter", fieldDelimiter)
         .add("quote", quote)
         .add("skipLeadingRows", skipLeadingRows)
+        .add("preserveAsciiControlCharacters", preserveAsciiControlCharacters)
         .toString();
   }
 
@@ -219,7 +241,8 @@ public int hashCode() {
         encoding,
         fieldDelimiter,
         quote,
-        skipLeadingRows);
+        skipLeadingRows,
+        preserveAsciiControlCharacters);
   }
 
   @Override

diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/WriteChannelConfiguration.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/WriteChannelConfiguration.java
@@ -455,7 +455,8 @@ com.google.api.services.bigquery.model.JobConfiguration toPb() {
           .setAllowJaggedRows(csvOptions.allowJaggedRows())
           .setAllowQuotedNewlines(csvOptions.allowQuotedNewLines())
           .setEncoding(csvOptions.getEncoding())
-          .setQuote(csvOptions.getQuote());
+          .setQuote(csvOptions.getQuote())
+          .setPreserveAsciiControlCharacters(csvOptions.getPreserveAsciiControlCharacters());
       if (csvOptions.getSkipLeadingRows() != null) {
         // todo(mziccard) remove checked cast or comment when #1044 is closed
         loadConfigurationPb.setSkipLeadingRows(Ints.checkedCast(csvOptions.getSkipLeadingRows()));

diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/CsvOptionsTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/CsvOptionsTest.java
@@ -30,6 +30,8 @@ public class CsvOptionsTest {
   private static final String FIELD_DELIMITER = ",";
   private static final String QUOTE = "\"";
   private static final long SKIP_LEADING_ROWS = 42L;
+
+  private static final boolean PRESERVE_ASCII_CONTROL_CHARACTERS = true;
   private static final CsvOptions CSV_OPTIONS =
       CsvOptions.newBuilder()
           .setAllowJaggedRows(ALLOW_JAGGED_ROWS)
@@ -38,6 +40,7 @@ public class CsvOptionsTest {
           .setFieldDelimiter(FIELD_DELIMITER)
           .setQuote(QUOTE)
           .setSkipLeadingRows(SKIP_LEADING_ROWS)
+          .setPreserveAsciiControlCharacters(PRESERVE_ASCII_CONTROL_CHARACTERS)
           .build();
 
   @Test
@@ -64,6 +67,8 @@ public void testBuilder() {
     assertEquals(FIELD_DELIMITER, CSV_OPTIONS.getFieldDelimiter());
     assertEquals(QUOTE, CSV_OPTIONS.getQuote());
     assertEquals(SKIP_LEADING_ROWS, (long) CSV_OPTIONS.getSkipLeadingRows());
+    assertEquals(
+        PRESERVE_ASCII_CONTROL_CHARACTERS, CSV_OPTIONS.getPreserveAsciiControlCharacters());
   }
 
   @Test

diff --git a/...cloud-bigquery/src/test/java/com/google/cloud/bigquery/WriteChannelConfigurationTest.java b/...cloud-bigquery/src/test/java/com/google/cloud/bigquery/WriteChannelConfigurationTest.java
@@ -35,6 +35,7 @@ public class WriteChannelConfigurationTest {
       CsvOptions.newBuilder()
           .setAllowJaggedRows(true)
           .setAllowQuotedNewLines(false)
+          .setPreserveAsciiControlCharacters(true)
           .setEncoding(StandardCharsets.UTF_8)
           .build();
   private static final TableId TABLE_ID = TableId.of("dataset", "table");