pabloem commented on code in PR #23988: URL: https://github.com/apache/beam/pull/23988#discussion_r1042612193
########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java: ########## @@ -0,0 +1,361 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.beam.sdk.io.gcp.bigquery.providers; + +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkNotNull; + +import com.google.api.services.bigquery.model.TableSchema; +import com.google.auto.service.AutoService; +import com.google.auto.value.AutoValue; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.CreateDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.Method; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.WriteDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryUtils; +import org.apache.beam.sdk.io.gcp.bigquery.WriteResult; +import org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransformConfiguration; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.Schema; +import org.apache.beam.sdk.schemas.Schema.Field; +import org.apache.beam.sdk.schemas.Schema.FieldType; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; +import org.apache.beam.sdk.schemas.transforms.SchemaTransform; +import org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider; +import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; +import org.apache.beam.sdk.transforms.MapElements; +import org.apache.beam.sdk.transforms.PTransform; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionRowTuple; +import org.apache.beam.sdk.values.Row; +import org.apache.beam.sdk.values.TypeDescriptor; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.joda.time.Duration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link TypedSchemaTransformProvider} for BigQuery Storage Write API jobs + * configured via {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. + * + * <p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We + * provide no backwards compatibility guarantees, and it should not be implemented outside the Beam + * repository. + */ +@SuppressWarnings({ + "nullness" // TODO(https://github.com/apache/beam/issues/20497) +}) +@Experimental(Kind.SCHEMAS) +@AutoService(SchemaTransformProvider.class) +public class BigQueryStorageWriteApiSchemaTransformProvider + extends TypedSchemaTransformProvider<BigQueryStorageWriteApiSchemaTransformConfiguration> { + private static final Logger LOG = LoggerFactory.getLogger(BigQueryStorageWriteApiSchemaTransformProvider.class); + + private static final String INPUT_ROWS_TAG = "INPUT_ROWS"; + private static final String OUTPUT_ERRORS_TAG = "ERROR_ROWS"; + + @Override + protected Class<BigQueryStorageWriteApiSchemaTransformConfiguration> configurationClass() { + return BigQueryStorageWriteApiSchemaTransformConfiguration.class; + } + + @Override + protected SchemaTransform from( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + return new BigQueryStorageWriteApiSchemaTransform(configuration); + } + + @Override + public String identifier() { + return String.format("beam:transform:org.apache.beam:bigquery_storage_write:v1"); + } + + @Override + public List<String> inputCollectionNames() { + return Collections.singletonList(INPUT_ROWS_TAG); + } + + @Override + public List<String> outputCollectionNames() { + return Collections.singletonList(OUTPUT_ERRORS_TAG); + } + + /** Configuration for writing to BigQuery with Storage Write API. */ + @DefaultSchema(AutoValueSchema.class) + @AutoValue + public abstract static class BigQueryStorageWriteApiSchemaTransformConfiguration { + static final Map<String, CreateDisposition> CREATE_DISPOSITIONS = + ImmutableMap.<String, CreateDisposition>builder() + .put(CreateDisposition.CREATE_IF_NEEDED.name(), CreateDisposition.CREATE_IF_NEEDED) + .put(CreateDisposition.CREATE_NEVER.name(), CreateDisposition.CREATE_NEVER) + .build(); + + static final Map<String, WriteDisposition> WRITE_DISPOSITIONS = + ImmutableMap.<String, WriteDisposition>builder() + .put(WriteDisposition.WRITE_TRUNCATE.name(), WriteDisposition.WRITE_TRUNCATE) + .put(WriteDisposition.WRITE_EMPTY.name(), WriteDisposition.WRITE_EMPTY) + .put(WriteDisposition.WRITE_APPEND.name(), WriteDisposition.WRITE_APPEND) + .build(); + + public void validate() { + String invalidConfigMessage = "Invalid BigQuery Storage Write configuration: "; + + // validate output table spec + checkArgument( + !Strings.isNullOrEmpty(this.getOutputTable()), + invalidConfigMessage + "Table spec for a BigQuery Write must be specified."); + checkNotNull(BigQueryHelpers.parseTableSpec(this.getOutputTable())); + + // validate create and write dispositions + CreateDisposition createDisposition = null; + if (!Strings.isNullOrEmpty(this.getCreateDisposition())) { + checkArgument( + CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()) != null, + invalidConfigMessage + + "Invalid create disposition was specified. Available dispositions are: ", + CREATE_DISPOSITIONS.keySet()); + createDisposition = CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()); + } + if (!Strings.isNullOrEmpty(this.getWriteDisposition())) { + checkNotNull( + WRITE_DISPOSITIONS.get(this.getWriteDisposition().toUpperCase()), + invalidConfigMessage + + "Invalid write disposition was specified. Available dispositions are: ", + WRITE_DISPOSITIONS.keySet()); + } + + // validate schema + if (!Strings.isNullOrEmpty(this.getJsonSchema())) { + // check if a TableSchema can be deserialized from the input schema string + checkNotNull(BigQueryHelpers.fromJsonString(this.getJsonSchema(), TableSchema.class)); + } else if (this.getUseBeamSchema() == null || !this.getUseBeamSchema()) { + // if no schema is provided, create disposition CREATE_NEVER has to be specified. + checkArgument( + createDisposition == CreateDisposition.CREATE_NEVER, + invalidConfigMessage + + "Create disposition is CREATE_IF_NEEDED, but no schema was provided."); + } + + // validation checks for streaming writes + checkArgument( + this.getNumStorageWriteApiStreams() == null || this.getNumStorageWriteApiStreams() > 0, + invalidConfigMessage + "When set, numStorageWriteApiStreams must be > 0, but was: %s", + this.getNumStorageWriteApiStreams()); + checkArgument( + this.getNumFileShards() == null || this.getNumFileShards() > 0, + invalidConfigMessage + "When set, numFileShards must be > 0, but was: %s", + this.getNumFileShards()); + checkArgument( + this.getTriggeringFrequencySeconds() == null || this.getTriggeringFrequencySeconds() > 0, + invalidConfigMessage + "When set, the trigger frequency must be > 0, but was: %s", + this.getTriggeringFrequencySeconds()); + } + + /** + * Instantiates a {@link BigQueryStorageWriteApiSchemaTransformConfiguration.Builder} instance. + */ + public static Builder builder() { + return new AutoValue_BigQueryStorageWriteApiSchemaTransformProvider_BigQueryStorageWriteApiSchemaTransformConfiguration + .Builder(); + } + + public abstract String getOutputTable(); + + @Nullable + public abstract String getJsonSchema(); + + @Nullable + public abstract Boolean getUseBeamSchema(); + + @Nullable + public abstract String getCreateDisposition(); + + @Nullable + public abstract String getWriteDisposition(); + + @Nullable + public abstract Integer getNumStorageWriteApiStreams(); + + @Nullable + public abstract Integer getNumFileShards(); + + @Nullable + public abstract Integer getTriggeringFrequencySeconds(); + + @Nullable + public abstract Boolean getUseAtLeastOnceSemantics(); + + /** Builder for {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. */ + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder setOutputTable(String tableSpec); + + public abstract Builder setJsonSchema(String jsonSchema); + + public abstract Builder setUseBeamSchema(Boolean useBeamSchema); + + public abstract Builder setCreateDisposition(String createDisposition); + + public abstract Builder setWriteDisposition(String writeDisposition); + + public abstract Builder setNumStorageWriteApiStreams(Integer numStorageWriteApiStreams); + + public abstract Builder setNumFileShards(Integer numFileShards); Review Comment: I think we should have default values for these (file shards are not relevant for storage, right?) - and avoid exposing them if possible. In fact, we should use auto sharding if it's supported. ########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java: ########## @@ -0,0 +1,361 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.beam.sdk.io.gcp.bigquery.providers; + +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkNotNull; + +import com.google.api.services.bigquery.model.TableSchema; +import com.google.auto.service.AutoService; +import com.google.auto.value.AutoValue; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.CreateDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.Method; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.WriteDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryUtils; +import org.apache.beam.sdk.io.gcp.bigquery.WriteResult; +import org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransformConfiguration; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.Schema; +import org.apache.beam.sdk.schemas.Schema.Field; +import org.apache.beam.sdk.schemas.Schema.FieldType; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; +import org.apache.beam.sdk.schemas.transforms.SchemaTransform; +import org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider; +import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; +import org.apache.beam.sdk.transforms.MapElements; +import org.apache.beam.sdk.transforms.PTransform; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionRowTuple; +import org.apache.beam.sdk.values.Row; +import org.apache.beam.sdk.values.TypeDescriptor; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.joda.time.Duration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link TypedSchemaTransformProvider} for BigQuery Storage Write API jobs + * configured via {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. + * + * <p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We + * provide no backwards compatibility guarantees, and it should not be implemented outside the Beam + * repository. + */ +@SuppressWarnings({ + "nullness" // TODO(https://github.com/apache/beam/issues/20497) +}) +@Experimental(Kind.SCHEMAS) +@AutoService(SchemaTransformProvider.class) +public class BigQueryStorageWriteApiSchemaTransformProvider + extends TypedSchemaTransformProvider<BigQueryStorageWriteApiSchemaTransformConfiguration> { + private static final Logger LOG = LoggerFactory.getLogger(BigQueryStorageWriteApiSchemaTransformProvider.class); + + private static final String INPUT_ROWS_TAG = "INPUT_ROWS"; + private static final String OUTPUT_ERRORS_TAG = "ERROR_ROWS"; + + @Override + protected Class<BigQueryStorageWriteApiSchemaTransformConfiguration> configurationClass() { + return BigQueryStorageWriteApiSchemaTransformConfiguration.class; + } + + @Override + protected SchemaTransform from( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + return new BigQueryStorageWriteApiSchemaTransform(configuration); + } + + @Override + public String identifier() { + return String.format("beam:transform:org.apache.beam:bigquery_storage_write:v1"); + } + + @Override + public List<String> inputCollectionNames() { + return Collections.singletonList(INPUT_ROWS_TAG); + } + + @Override + public List<String> outputCollectionNames() { + return Collections.singletonList(OUTPUT_ERRORS_TAG); + } + + /** Configuration for writing to BigQuery with Storage Write API. */ + @DefaultSchema(AutoValueSchema.class) + @AutoValue + public abstract static class BigQueryStorageWriteApiSchemaTransformConfiguration { + static final Map<String, CreateDisposition> CREATE_DISPOSITIONS = + ImmutableMap.<String, CreateDisposition>builder() + .put(CreateDisposition.CREATE_IF_NEEDED.name(), CreateDisposition.CREATE_IF_NEEDED) + .put(CreateDisposition.CREATE_NEVER.name(), CreateDisposition.CREATE_NEVER) + .build(); + + static final Map<String, WriteDisposition> WRITE_DISPOSITIONS = + ImmutableMap.<String, WriteDisposition>builder() + .put(WriteDisposition.WRITE_TRUNCATE.name(), WriteDisposition.WRITE_TRUNCATE) + .put(WriteDisposition.WRITE_EMPTY.name(), WriteDisposition.WRITE_EMPTY) + .put(WriteDisposition.WRITE_APPEND.name(), WriteDisposition.WRITE_APPEND) + .build(); + + public void validate() { + String invalidConfigMessage = "Invalid BigQuery Storage Write configuration: "; + + // validate output table spec + checkArgument( + !Strings.isNullOrEmpty(this.getOutputTable()), + invalidConfigMessage + "Table spec for a BigQuery Write must be specified."); + checkNotNull(BigQueryHelpers.parseTableSpec(this.getOutputTable())); + + // validate create and write dispositions + CreateDisposition createDisposition = null; + if (!Strings.isNullOrEmpty(this.getCreateDisposition())) { + checkArgument( + CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()) != null, + invalidConfigMessage + + "Invalid create disposition was specified. Available dispositions are: ", + CREATE_DISPOSITIONS.keySet()); + createDisposition = CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()); + } + if (!Strings.isNullOrEmpty(this.getWriteDisposition())) { + checkNotNull( + WRITE_DISPOSITIONS.get(this.getWriteDisposition().toUpperCase()), + invalidConfigMessage + + "Invalid write disposition was specified. Available dispositions are: ", + WRITE_DISPOSITIONS.keySet()); + } + + // validate schema + if (!Strings.isNullOrEmpty(this.getJsonSchema())) { + // check if a TableSchema can be deserialized from the input schema string + checkNotNull(BigQueryHelpers.fromJsonString(this.getJsonSchema(), TableSchema.class)); + } else if (this.getUseBeamSchema() == null || !this.getUseBeamSchema()) { + // if no schema is provided, create disposition CREATE_NEVER has to be specified. + checkArgument( + createDisposition == CreateDisposition.CREATE_NEVER, + invalidConfigMessage + + "Create disposition is CREATE_IF_NEEDED, but no schema was provided."); + } + + // validation checks for streaming writes + checkArgument( + this.getNumStorageWriteApiStreams() == null || this.getNumStorageWriteApiStreams() > 0, + invalidConfigMessage + "When set, numStorageWriteApiStreams must be > 0, but was: %s", + this.getNumStorageWriteApiStreams()); + checkArgument( + this.getNumFileShards() == null || this.getNumFileShards() > 0, + invalidConfigMessage + "When set, numFileShards must be > 0, but was: %s", + this.getNumFileShards()); + checkArgument( + this.getTriggeringFrequencySeconds() == null || this.getTriggeringFrequencySeconds() > 0, + invalidConfigMessage + "When set, the trigger frequency must be > 0, but was: %s", + this.getTriggeringFrequencySeconds()); + } + + /** + * Instantiates a {@link BigQueryStorageWriteApiSchemaTransformConfiguration.Builder} instance. + */ + public static Builder builder() { + return new AutoValue_BigQueryStorageWriteApiSchemaTransformProvider_BigQueryStorageWriteApiSchemaTransformConfiguration + .Builder(); + } + + public abstract String getOutputTable(); + + @Nullable + public abstract String getJsonSchema(); + + @Nullable + public abstract Boolean getUseBeamSchema(); + + @Nullable + public abstract String getCreateDisposition(); + + @Nullable + public abstract String getWriteDisposition(); + + @Nullable + public abstract Integer getNumStorageWriteApiStreams(); + + @Nullable + public abstract Integer getNumFileShards(); + + @Nullable + public abstract Integer getTriggeringFrequencySeconds(); + + @Nullable + public abstract Boolean getUseAtLeastOnceSemantics(); + + /** Builder for {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. */ + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder setOutputTable(String tableSpec); + + public abstract Builder setJsonSchema(String jsonSchema); + + public abstract Builder setUseBeamSchema(Boolean useBeamSchema); + + public abstract Builder setCreateDisposition(String createDisposition); + + public abstract Builder setWriteDisposition(String writeDisposition); + + public abstract Builder setNumStorageWriteApiStreams(Integer numStorageWriteApiStreams); + + public abstract Builder setNumFileShards(Integer numFileShards); + + public abstract Builder setTriggeringFrequencySeconds(Integer seconds); + + public abstract Builder setUseAtLeastOnceSemantics(Boolean use); + + /** Builds a {@link BigQueryStorageWriteApiSchemaTransformConfiguration} instance. */ + public abstract BigQueryStorageWriteApiSchemaTransformProvider + .BigQueryStorageWriteApiSchemaTransformConfiguration + build(); + } + } + + /** + * A {@link SchemaTransform} for BigQuery Storage Write API, configured with {@link + * BigQueryStorageWriteApiSchemaTransformConfiguration} and instantiated by {@link + * BigQueryStorageWriteApiSchemaTransformProvider}. + */ + private static class BigQueryStorageWriteApiSchemaTransform implements SchemaTransform { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + + BigQueryStorageWriteApiSchemaTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + configuration.validate(); + this.configuration = configuration; + } + + @Override + public PTransform<PCollectionRowTuple, PCollectionRowTuple> buildTransform() { + return new BigQueryStorageWriteApiPCollectionRowTupleTransform(configuration); + } + } + + static class BigQueryStorageWriteApiPCollectionRowTupleTransform + extends PTransform<PCollectionRowTuple, PCollectionRowTuple> { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + private BigQueryServices testBigQueryServices = null; + + BigQueryStorageWriteApiPCollectionRowTupleTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + this.configuration = configuration; + } + + @VisibleForTesting + public void setBigQueryServices(BigQueryServices testBigQueryServices) { + this.testBigQueryServices = testBigQueryServices; + } + + @Override + public PCollectionRowTuple expand(PCollectionRowTuple input) { + // Check that the input exists + checkArgument(input.has(INPUT_ROWS_TAG), "Missing expected input tag: %s", INPUT_ROWS_TAG); + PCollection<Row> inputRows = input.get(INPUT_ROWS_TAG); + + BigQueryIO.Write<Row> write = createStorageWriteApiTransform(); + + LOG.info("JSON SCHEMA: " + configuration.getJsonSchema()); + WriteResult result = inputRows.apply(write); + + Schema errorSchema = + Schema.of( + Field.of("failed_row", FieldType.STRING), + Field.of("error_message", FieldType.STRING)); + + // Errors consisting of failed rows along with their error message + PCollection<Row> errorRows = + result + .getFailedStorageApiInserts() + .apply( + "Extract Errors", + MapElements.into(TypeDescriptor.of(Row.class)) + .via( + (storageError) -> + Row.withSchema(errorSchema) + .withFieldValue("error_message", storageError.getErrorMessage()) + .withFieldValue("failed_row", storageError.getRow().toString()) + .build())) + .setRowSchema(errorSchema); + + return PCollectionRowTuple.of(OUTPUT_ERRORS_TAG, errorRows); + } + + BigQueryIO.Write<Row> createStorageWriteApiTransform() { + Method writeMethod = + configuration.getUseAtLeastOnceSemantics() != null + && configuration.getUseAtLeastOnceSemantics() + ? Method.STORAGE_API_AT_LEAST_ONCE + : Method.STORAGE_WRITE_API; + BigQueryIO.Write<Row> write = + BigQueryIO.<Row>write() + .to(configuration.getOutputTable()) + .withMethod(writeMethod) + .withFormatFunction(BigQueryUtils.toTableRow()); + + if (!Strings.isNullOrEmpty(configuration.getJsonSchema())) { + write = + write.withSchema( + BigQueryHelpers.fromJsonString(configuration.getJsonSchema(), TableSchema.class)); + } + if (configuration.getUseBeamSchema() != null && configuration.getUseBeamSchema()) { + write = write.useBeamSchema(); + } + if (!Strings.isNullOrEmpty(configuration.getCreateDisposition())) { + CreateDisposition createDisposition = + BigQueryStorageWriteApiSchemaTransformConfiguration.CREATE_DISPOSITIONS.get( + configuration.getCreateDisposition()); + write = write.withCreateDisposition(createDisposition); + } + if (!Strings.isNullOrEmpty(configuration.getWriteDisposition())) { + WriteDisposition writeDisposition = + BigQueryStorageWriteApiSchemaTransformConfiguration.WRITE_DISPOSITIONS.get( + configuration.getWriteDisposition()); + write = write.withWriteDisposition(writeDisposition); + } + if (configuration.getNumStorageWriteApiStreams() != null) { + write = write.withNumStorageWriteApiStreams(configuration.getNumStorageWriteApiStreams()); + } Review Comment: I don't recall - but I think we should be able to use Auto Sharding here. Do you know if the featureexists for this? ########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java: ########## @@ -0,0 +1,361 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.beam.sdk.io.gcp.bigquery.providers; + +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkNotNull; + +import com.google.api.services.bigquery.model.TableSchema; +import com.google.auto.service.AutoService; +import com.google.auto.value.AutoValue; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.CreateDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.Method; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.WriteDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryUtils; +import org.apache.beam.sdk.io.gcp.bigquery.WriteResult; +import org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransformConfiguration; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.Schema; +import org.apache.beam.sdk.schemas.Schema.Field; +import org.apache.beam.sdk.schemas.Schema.FieldType; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; +import org.apache.beam.sdk.schemas.transforms.SchemaTransform; +import org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider; +import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; +import org.apache.beam.sdk.transforms.MapElements; +import org.apache.beam.sdk.transforms.PTransform; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionRowTuple; +import org.apache.beam.sdk.values.Row; +import org.apache.beam.sdk.values.TypeDescriptor; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.joda.time.Duration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link TypedSchemaTransformProvider} for BigQuery Storage Write API jobs + * configured via {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. + * + * <p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We + * provide no backwards compatibility guarantees, and it should not be implemented outside the Beam + * repository. + */ +@SuppressWarnings({ + "nullness" // TODO(https://github.com/apache/beam/issues/20497) +}) +@Experimental(Kind.SCHEMAS) +@AutoService(SchemaTransformProvider.class) +public class BigQueryStorageWriteApiSchemaTransformProvider + extends TypedSchemaTransformProvider<BigQueryStorageWriteApiSchemaTransformConfiguration> { + private static final Logger LOG = LoggerFactory.getLogger(BigQueryStorageWriteApiSchemaTransformProvider.class); + + private static final String INPUT_ROWS_TAG = "INPUT_ROWS"; + private static final String OUTPUT_ERRORS_TAG = "ERROR_ROWS"; + + @Override + protected Class<BigQueryStorageWriteApiSchemaTransformConfiguration> configurationClass() { + return BigQueryStorageWriteApiSchemaTransformConfiguration.class; + } + + @Override + protected SchemaTransform from( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + return new BigQueryStorageWriteApiSchemaTransform(configuration); + } + + @Override + public String identifier() { + return String.format("beam:transform:org.apache.beam:bigquery_storage_write:v1"); + } + + @Override + public List<String> inputCollectionNames() { + return Collections.singletonList(INPUT_ROWS_TAG); + } + + @Override + public List<String> outputCollectionNames() { + return Collections.singletonList(OUTPUT_ERRORS_TAG); + } + + /** Configuration for writing to BigQuery with Storage Write API. */ + @DefaultSchema(AutoValueSchema.class) + @AutoValue + public abstract static class BigQueryStorageWriteApiSchemaTransformConfiguration { + static final Map<String, CreateDisposition> CREATE_DISPOSITIONS = + ImmutableMap.<String, CreateDisposition>builder() + .put(CreateDisposition.CREATE_IF_NEEDED.name(), CreateDisposition.CREATE_IF_NEEDED) + .put(CreateDisposition.CREATE_NEVER.name(), CreateDisposition.CREATE_NEVER) + .build(); + + static final Map<String, WriteDisposition> WRITE_DISPOSITIONS = + ImmutableMap.<String, WriteDisposition>builder() + .put(WriteDisposition.WRITE_TRUNCATE.name(), WriteDisposition.WRITE_TRUNCATE) + .put(WriteDisposition.WRITE_EMPTY.name(), WriteDisposition.WRITE_EMPTY) + .put(WriteDisposition.WRITE_APPEND.name(), WriteDisposition.WRITE_APPEND) + .build(); + + public void validate() { + String invalidConfigMessage = "Invalid BigQuery Storage Write configuration: "; + + // validate output table spec + checkArgument( + !Strings.isNullOrEmpty(this.getOutputTable()), + invalidConfigMessage + "Table spec for a BigQuery Write must be specified."); + checkNotNull(BigQueryHelpers.parseTableSpec(this.getOutputTable())); + + // validate create and write dispositions + CreateDisposition createDisposition = null; + if (!Strings.isNullOrEmpty(this.getCreateDisposition())) { + checkArgument( + CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()) != null, + invalidConfigMessage + + "Invalid create disposition was specified. Available dispositions are: ", + CREATE_DISPOSITIONS.keySet()); + createDisposition = CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()); + } + if (!Strings.isNullOrEmpty(this.getWriteDisposition())) { + checkNotNull( + WRITE_DISPOSITIONS.get(this.getWriteDisposition().toUpperCase()), + invalidConfigMessage + + "Invalid write disposition was specified. Available dispositions are: ", + WRITE_DISPOSITIONS.keySet()); + } + + // validate schema + if (!Strings.isNullOrEmpty(this.getJsonSchema())) { + // check if a TableSchema can be deserialized from the input schema string + checkNotNull(BigQueryHelpers.fromJsonString(this.getJsonSchema(), TableSchema.class)); + } else if (this.getUseBeamSchema() == null || !this.getUseBeamSchema()) { + // if no schema is provided, create disposition CREATE_NEVER has to be specified. + checkArgument( + createDisposition == CreateDisposition.CREATE_NEVER, + invalidConfigMessage + + "Create disposition is CREATE_IF_NEEDED, but no schema was provided."); + } + + // validation checks for streaming writes + checkArgument( + this.getNumStorageWriteApiStreams() == null || this.getNumStorageWriteApiStreams() > 0, + invalidConfigMessage + "When set, numStorageWriteApiStreams must be > 0, but was: %s", + this.getNumStorageWriteApiStreams()); + checkArgument( + this.getNumFileShards() == null || this.getNumFileShards() > 0, + invalidConfigMessage + "When set, numFileShards must be > 0, but was: %s", + this.getNumFileShards()); + checkArgument( + this.getTriggeringFrequencySeconds() == null || this.getTriggeringFrequencySeconds() > 0, + invalidConfigMessage + "When set, the trigger frequency must be > 0, but was: %s", + this.getTriggeringFrequencySeconds()); + } + + /** + * Instantiates a {@link BigQueryStorageWriteApiSchemaTransformConfiguration.Builder} instance. + */ + public static Builder builder() { + return new AutoValue_BigQueryStorageWriteApiSchemaTransformProvider_BigQueryStorageWriteApiSchemaTransformConfiguration + .Builder(); + } + + public abstract String getOutputTable(); + + @Nullable + public abstract String getJsonSchema(); + + @Nullable + public abstract Boolean getUseBeamSchema(); + + @Nullable + public abstract String getCreateDisposition(); + + @Nullable + public abstract String getWriteDisposition(); + + @Nullable + public abstract Integer getNumStorageWriteApiStreams(); + + @Nullable + public abstract Integer getNumFileShards(); + + @Nullable + public abstract Integer getTriggeringFrequencySeconds(); + + @Nullable + public abstract Boolean getUseAtLeastOnceSemantics(); + + /** Builder for {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. */ + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder setOutputTable(String tableSpec); + + public abstract Builder setJsonSchema(String jsonSchema); + + public abstract Builder setUseBeamSchema(Boolean useBeamSchema); + + public abstract Builder setCreateDisposition(String createDisposition); + + public abstract Builder setWriteDisposition(String writeDisposition); + + public abstract Builder setNumStorageWriteApiStreams(Integer numStorageWriteApiStreams); + + public abstract Builder setNumFileShards(Integer numFileShards); + + public abstract Builder setTriggeringFrequencySeconds(Integer seconds); + + public abstract Builder setUseAtLeastOnceSemantics(Boolean use); + + /** Builds a {@link BigQueryStorageWriteApiSchemaTransformConfiguration} instance. */ + public abstract BigQueryStorageWriteApiSchemaTransformProvider + .BigQueryStorageWriteApiSchemaTransformConfiguration + build(); + } + } + + /** + * A {@link SchemaTransform} for BigQuery Storage Write API, configured with {@link + * BigQueryStorageWriteApiSchemaTransformConfiguration} and instantiated by {@link + * BigQueryStorageWriteApiSchemaTransformProvider}. + */ + private static class BigQueryStorageWriteApiSchemaTransform implements SchemaTransform { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + + BigQueryStorageWriteApiSchemaTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + configuration.validate(); + this.configuration = configuration; + } + + @Override + public PTransform<PCollectionRowTuple, PCollectionRowTuple> buildTransform() { + return new BigQueryStorageWriteApiPCollectionRowTupleTransform(configuration); + } + } + + static class BigQueryStorageWriteApiPCollectionRowTupleTransform + extends PTransform<PCollectionRowTuple, PCollectionRowTuple> { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + private BigQueryServices testBigQueryServices = null; + + BigQueryStorageWriteApiPCollectionRowTupleTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + this.configuration = configuration; + } + + @VisibleForTesting + public void setBigQueryServices(BigQueryServices testBigQueryServices) { + this.testBigQueryServices = testBigQueryServices; + } + + @Override + public PCollectionRowTuple expand(PCollectionRowTuple input) { + // Check that the input exists + checkArgument(input.has(INPUT_ROWS_TAG), "Missing expected input tag: %s", INPUT_ROWS_TAG); + PCollection<Row> inputRows = input.get(INPUT_ROWS_TAG); + + BigQueryIO.Write<Row> write = createStorageWriteApiTransform(); + + LOG.info("JSON SCHEMA: " + configuration.getJsonSchema()); + WriteResult result = inputRows.apply(write); + + Schema errorSchema = + Schema.of( + Field.of("failed_row", FieldType.STRING), + Field.of("error_message", FieldType.STRING)); + + // Errors consisting of failed rows along with their error message + PCollection<Row> errorRows = + result + .getFailedStorageApiInserts() + .apply( + "Extract Errors", + MapElements.into(TypeDescriptor.of(Row.class)) + .via( + (storageError) -> + Row.withSchema(errorSchema) + .withFieldValue("error_message", storageError.getErrorMessage()) + .withFieldValue("failed_row", storageError.getRow().toString()) + .build())) + .setRowSchema(errorSchema); + + return PCollectionRowTuple.of(OUTPUT_ERRORS_TAG, errorRows); + } + + BigQueryIO.Write<Row> createStorageWriteApiTransform() { + Method writeMethod = + configuration.getUseAtLeastOnceSemantics() != null + && configuration.getUseAtLeastOnceSemantics() + ? Method.STORAGE_API_AT_LEAST_ONCE + : Method.STORAGE_WRITE_API; + BigQueryIO.Write<Row> write = + BigQueryIO.<Row>write() + .to(configuration.getOutputTable()) + .withMethod(writeMethod) + .withFormatFunction(BigQueryUtils.toTableRow()); + + if (!Strings.isNullOrEmpty(configuration.getJsonSchema())) { + write = + write.withSchema( + BigQueryHelpers.fromJsonString(configuration.getJsonSchema(), TableSchema.class)); + } + if (configuration.getUseBeamSchema() != null && configuration.getUseBeamSchema()) { + write = write.useBeamSchema(); + } Review Comment: as stated above, we should always use Beam schemas here ########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java: ########## @@ -0,0 +1,361 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.beam.sdk.io.gcp.bigquery.providers; + +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkNotNull; + +import com.google.api.services.bigquery.model.TableSchema; +import com.google.auto.service.AutoService; +import com.google.auto.value.AutoValue; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.CreateDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.Method; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.WriteDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryUtils; +import org.apache.beam.sdk.io.gcp.bigquery.WriteResult; +import org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransformConfiguration; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.Schema; +import org.apache.beam.sdk.schemas.Schema.Field; +import org.apache.beam.sdk.schemas.Schema.FieldType; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; +import org.apache.beam.sdk.schemas.transforms.SchemaTransform; +import org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider; +import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; +import org.apache.beam.sdk.transforms.MapElements; +import org.apache.beam.sdk.transforms.PTransform; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionRowTuple; +import org.apache.beam.sdk.values.Row; +import org.apache.beam.sdk.values.TypeDescriptor; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.joda.time.Duration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link TypedSchemaTransformProvider} for BigQuery Storage Write API jobs + * configured via {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. + * + * <p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We + * provide no backwards compatibility guarantees, and it should not be implemented outside the Beam + * repository. + */ +@SuppressWarnings({ + "nullness" // TODO(https://github.com/apache/beam/issues/20497) +}) +@Experimental(Kind.SCHEMAS) +@AutoService(SchemaTransformProvider.class) +public class BigQueryStorageWriteApiSchemaTransformProvider + extends TypedSchemaTransformProvider<BigQueryStorageWriteApiSchemaTransformConfiguration> { + private static final Logger LOG = LoggerFactory.getLogger(BigQueryStorageWriteApiSchemaTransformProvider.class); + + private static final String INPUT_ROWS_TAG = "INPUT_ROWS"; + private static final String OUTPUT_ERRORS_TAG = "ERROR_ROWS"; + + @Override + protected Class<BigQueryStorageWriteApiSchemaTransformConfiguration> configurationClass() { + return BigQueryStorageWriteApiSchemaTransformConfiguration.class; + } + + @Override + protected SchemaTransform from( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + return new BigQueryStorageWriteApiSchemaTransform(configuration); + } + + @Override + public String identifier() { + return String.format("beam:transform:org.apache.beam:bigquery_storage_write:v1"); + } + + @Override + public List<String> inputCollectionNames() { + return Collections.singletonList(INPUT_ROWS_TAG); + } + + @Override + public List<String> outputCollectionNames() { + return Collections.singletonList(OUTPUT_ERRORS_TAG); + } + + /** Configuration for writing to BigQuery with Storage Write API. */ + @DefaultSchema(AutoValueSchema.class) + @AutoValue + public abstract static class BigQueryStorageWriteApiSchemaTransformConfiguration { + static final Map<String, CreateDisposition> CREATE_DISPOSITIONS = + ImmutableMap.<String, CreateDisposition>builder() + .put(CreateDisposition.CREATE_IF_NEEDED.name(), CreateDisposition.CREATE_IF_NEEDED) + .put(CreateDisposition.CREATE_NEVER.name(), CreateDisposition.CREATE_NEVER) + .build(); + + static final Map<String, WriteDisposition> WRITE_DISPOSITIONS = + ImmutableMap.<String, WriteDisposition>builder() + .put(WriteDisposition.WRITE_TRUNCATE.name(), WriteDisposition.WRITE_TRUNCATE) + .put(WriteDisposition.WRITE_EMPTY.name(), WriteDisposition.WRITE_EMPTY) + .put(WriteDisposition.WRITE_APPEND.name(), WriteDisposition.WRITE_APPEND) + .build(); + + public void validate() { + String invalidConfigMessage = "Invalid BigQuery Storage Write configuration: "; + + // validate output table spec + checkArgument( + !Strings.isNullOrEmpty(this.getOutputTable()), + invalidConfigMessage + "Table spec for a BigQuery Write must be specified."); + checkNotNull(BigQueryHelpers.parseTableSpec(this.getOutputTable())); + + // validate create and write dispositions + CreateDisposition createDisposition = null; + if (!Strings.isNullOrEmpty(this.getCreateDisposition())) { + checkArgument( + CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()) != null, + invalidConfigMessage + + "Invalid create disposition was specified. Available dispositions are: ", + CREATE_DISPOSITIONS.keySet()); + createDisposition = CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()); + } + if (!Strings.isNullOrEmpty(this.getWriteDisposition())) { + checkNotNull( + WRITE_DISPOSITIONS.get(this.getWriteDisposition().toUpperCase()), + invalidConfigMessage + + "Invalid write disposition was specified. Available dispositions are: ", + WRITE_DISPOSITIONS.keySet()); + } + + // validate schema + if (!Strings.isNullOrEmpty(this.getJsonSchema())) { + // check if a TableSchema can be deserialized from the input schema string + checkNotNull(BigQueryHelpers.fromJsonString(this.getJsonSchema(), TableSchema.class)); + } else if (this.getUseBeamSchema() == null || !this.getUseBeamSchema()) { + // if no schema is provided, create disposition CREATE_NEVER has to be specified. + checkArgument( + createDisposition == CreateDisposition.CREATE_NEVER, + invalidConfigMessage + + "Create disposition is CREATE_IF_NEEDED, but no schema was provided."); + } + + // validation checks for streaming writes + checkArgument( + this.getNumStorageWriteApiStreams() == null || this.getNumStorageWriteApiStreams() > 0, + invalidConfigMessage + "When set, numStorageWriteApiStreams must be > 0, but was: %s", + this.getNumStorageWriteApiStreams()); + checkArgument( + this.getNumFileShards() == null || this.getNumFileShards() > 0, + invalidConfigMessage + "When set, numFileShards must be > 0, but was: %s", + this.getNumFileShards()); + checkArgument( + this.getTriggeringFrequencySeconds() == null || this.getTriggeringFrequencySeconds() > 0, + invalidConfigMessage + "When set, the trigger frequency must be > 0, but was: %s", + this.getTriggeringFrequencySeconds()); + } + + /** + * Instantiates a {@link BigQueryStorageWriteApiSchemaTransformConfiguration.Builder} instance. + */ + public static Builder builder() { + return new AutoValue_BigQueryStorageWriteApiSchemaTransformProvider_BigQueryStorageWriteApiSchemaTransformConfiguration + .Builder(); + } + + public abstract String getOutputTable(); + + @Nullable + public abstract String getJsonSchema(); + + @Nullable + public abstract Boolean getUseBeamSchema(); + + @Nullable + public abstract String getCreateDisposition(); + + @Nullable + public abstract String getWriteDisposition(); + + @Nullable + public abstract Integer getNumStorageWriteApiStreams(); + + @Nullable + public abstract Integer getNumFileShards(); + + @Nullable + public abstract Integer getTriggeringFrequencySeconds(); + + @Nullable + public abstract Boolean getUseAtLeastOnceSemantics(); + + /** Builder for {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. */ + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder setOutputTable(String tableSpec); + + public abstract Builder setJsonSchema(String jsonSchema); + + public abstract Builder setUseBeamSchema(Boolean useBeamSchema); + + public abstract Builder setCreateDisposition(String createDisposition); + + public abstract Builder setWriteDisposition(String writeDisposition); + + public abstract Builder setNumStorageWriteApiStreams(Integer numStorageWriteApiStreams); + + public abstract Builder setNumFileShards(Integer numFileShards); + + public abstract Builder setTriggeringFrequencySeconds(Integer seconds); + + public abstract Builder setUseAtLeastOnceSemantics(Boolean use); + + /** Builds a {@link BigQueryStorageWriteApiSchemaTransformConfiguration} instance. */ + public abstract BigQueryStorageWriteApiSchemaTransformProvider + .BigQueryStorageWriteApiSchemaTransformConfiguration + build(); + } + } + + /** + * A {@link SchemaTransform} for BigQuery Storage Write API, configured with {@link + * BigQueryStorageWriteApiSchemaTransformConfiguration} and instantiated by {@link + * BigQueryStorageWriteApiSchemaTransformProvider}. + */ + private static class BigQueryStorageWriteApiSchemaTransform implements SchemaTransform { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + + BigQueryStorageWriteApiSchemaTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + configuration.validate(); + this.configuration = configuration; + } + + @Override + public PTransform<PCollectionRowTuple, PCollectionRowTuple> buildTransform() { + return new BigQueryStorageWriteApiPCollectionRowTupleTransform(configuration); + } + } + + static class BigQueryStorageWriteApiPCollectionRowTupleTransform + extends PTransform<PCollectionRowTuple, PCollectionRowTuple> { + private final BigQueryStorageWriteApiSchemaTransformConfiguration configuration; + private BigQueryServices testBigQueryServices = null; + + BigQueryStorageWriteApiPCollectionRowTupleTransform( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + this.configuration = configuration; + } + + @VisibleForTesting + public void setBigQueryServices(BigQueryServices testBigQueryServices) { + this.testBigQueryServices = testBigQueryServices; + } + + @Override + public PCollectionRowTuple expand(PCollectionRowTuple input) { + // Check that the input exists + checkArgument(input.has(INPUT_ROWS_TAG), "Missing expected input tag: %s", INPUT_ROWS_TAG); + PCollection<Row> inputRows = input.get(INPUT_ROWS_TAG); + + BigQueryIO.Write<Row> write = createStorageWriteApiTransform(); + + LOG.info("JSON SCHEMA: " + configuration.getJsonSchema()); + WriteResult result = inputRows.apply(write); + + Schema errorSchema = + Schema.of( + Field.of("failed_row", FieldType.STRING), + Field.of("error_message", FieldType.STRING)); + + // Errors consisting of failed rows along with their error message + PCollection<Row> errorRows = + result + .getFailedStorageApiInserts() + .apply( + "Extract Errors", + MapElements.into(TypeDescriptor.of(Row.class)) + .via( + (storageError) -> + Row.withSchema(errorSchema) + .withFieldValue("error_message", storageError.getErrorMessage()) + .withFieldValue("failed_row", storageError.getRow().toString()) + .build())) + .setRowSchema(errorSchema); + + return PCollectionRowTuple.of(OUTPUT_ERRORS_TAG, errorRows); + } + + BigQueryIO.Write<Row> createStorageWriteApiTransform() { + Method writeMethod = + configuration.getUseAtLeastOnceSemantics() != null + && configuration.getUseAtLeastOnceSemantics() + ? Method.STORAGE_API_AT_LEAST_ONCE + : Method.STORAGE_WRITE_API; + BigQueryIO.Write<Row> write = + BigQueryIO.<Row>write() + .to(configuration.getOutputTable()) + .withMethod(writeMethod) + .withFormatFunction(BigQueryUtils.toTableRow()); + + if (!Strings.isNullOrEmpty(configuration.getJsonSchema())) { + write = + write.withSchema( + BigQueryHelpers.fromJsonString(configuration.getJsonSchema(), TableSchema.class)); + } + if (configuration.getUseBeamSchema() != null && configuration.getUseBeamSchema()) { + write = write.useBeamSchema(); + } + if (!Strings.isNullOrEmpty(configuration.getCreateDisposition())) { + CreateDisposition createDisposition = + BigQueryStorageWriteApiSchemaTransformConfiguration.CREATE_DISPOSITIONS.get( + configuration.getCreateDisposition()); + write = write.withCreateDisposition(createDisposition); + } + if (!Strings.isNullOrEmpty(configuration.getWriteDisposition())) { + WriteDisposition writeDisposition = + BigQueryStorageWriteApiSchemaTransformConfiguration.WRITE_DISPOSITIONS.get( + configuration.getWriteDisposition()); + write = write.withWriteDisposition(writeDisposition); + } + if (configuration.getNumStorageWriteApiStreams() != null) { + write = write.withNumStorageWriteApiStreams(configuration.getNumStorageWriteApiStreams()); + } + if (configuration.getNumFileShards() != null) { + write = write.withNumFileShards(configuration.getNumFileShards()); + } + if (configuration.getTriggeringFrequencySeconds() != null) { + write = + write.withTriggeringFrequency( + Duration.standardSeconds(configuration.getTriggeringFrequencySeconds())); + } Review Comment: I think we should probably have a default value for this. Something like: ``` if input.isUnbounded(): write = write.withTriggeringFrequency(config.getTriggeringFrequency() == null ? DEFAULT_VALUE : conf.getTriggeringFrequency()) ``` so that this parameter can be optional even for streaming pipelines ########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/providers/BigQueryStorageWriteApiSchemaTransformProvider.java: ########## @@ -0,0 +1,361 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.beam.sdk.io.gcp.bigquery.providers; + +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkNotNull; + +import com.google.api.services.bigquery.model.TableSchema; +import com.google.auto.service.AutoService; +import com.google.auto.value.AutoValue; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.CreateDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.Method; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.WriteDisposition; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices; +import org.apache.beam.sdk.io.gcp.bigquery.BigQueryUtils; +import org.apache.beam.sdk.io.gcp.bigquery.WriteResult; +import org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransformConfiguration; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.Schema; +import org.apache.beam.sdk.schemas.Schema.Field; +import org.apache.beam.sdk.schemas.Schema.FieldType; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; +import org.apache.beam.sdk.schemas.transforms.SchemaTransform; +import org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider; +import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; +import org.apache.beam.sdk.transforms.MapElements; +import org.apache.beam.sdk.transforms.PTransform; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionRowTuple; +import org.apache.beam.sdk.values.Row; +import org.apache.beam.sdk.values.TypeDescriptor; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.joda.time.Duration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link TypedSchemaTransformProvider} for BigQuery Storage Write API jobs + * configured via {@link BigQueryStorageWriteApiSchemaTransformConfiguration}. + * + * <p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We + * provide no backwards compatibility guarantees, and it should not be implemented outside the Beam + * repository. + */ +@SuppressWarnings({ + "nullness" // TODO(https://github.com/apache/beam/issues/20497) +}) +@Experimental(Kind.SCHEMAS) +@AutoService(SchemaTransformProvider.class) +public class BigQueryStorageWriteApiSchemaTransformProvider + extends TypedSchemaTransformProvider<BigQueryStorageWriteApiSchemaTransformConfiguration> { + private static final Logger LOG = LoggerFactory.getLogger(BigQueryStorageWriteApiSchemaTransformProvider.class); + + private static final String INPUT_ROWS_TAG = "INPUT_ROWS"; + private static final String OUTPUT_ERRORS_TAG = "ERROR_ROWS"; + + @Override + protected Class<BigQueryStorageWriteApiSchemaTransformConfiguration> configurationClass() { + return BigQueryStorageWriteApiSchemaTransformConfiguration.class; + } + + @Override + protected SchemaTransform from( + BigQueryStorageWriteApiSchemaTransformConfiguration configuration) { + return new BigQueryStorageWriteApiSchemaTransform(configuration); + } + + @Override + public String identifier() { + return String.format("beam:transform:org.apache.beam:bigquery_storage_write:v1"); + } + + @Override + public List<String> inputCollectionNames() { + return Collections.singletonList(INPUT_ROWS_TAG); + } + + @Override + public List<String> outputCollectionNames() { + return Collections.singletonList(OUTPUT_ERRORS_TAG); + } + + /** Configuration for writing to BigQuery with Storage Write API. */ + @DefaultSchema(AutoValueSchema.class) + @AutoValue + public abstract static class BigQueryStorageWriteApiSchemaTransformConfiguration { + static final Map<String, CreateDisposition> CREATE_DISPOSITIONS = + ImmutableMap.<String, CreateDisposition>builder() + .put(CreateDisposition.CREATE_IF_NEEDED.name(), CreateDisposition.CREATE_IF_NEEDED) + .put(CreateDisposition.CREATE_NEVER.name(), CreateDisposition.CREATE_NEVER) + .build(); + + static final Map<String, WriteDisposition> WRITE_DISPOSITIONS = + ImmutableMap.<String, WriteDisposition>builder() + .put(WriteDisposition.WRITE_TRUNCATE.name(), WriteDisposition.WRITE_TRUNCATE) + .put(WriteDisposition.WRITE_EMPTY.name(), WriteDisposition.WRITE_EMPTY) + .put(WriteDisposition.WRITE_APPEND.name(), WriteDisposition.WRITE_APPEND) + .build(); + + public void validate() { + String invalidConfigMessage = "Invalid BigQuery Storage Write configuration: "; + + // validate output table spec + checkArgument( + !Strings.isNullOrEmpty(this.getOutputTable()), + invalidConfigMessage + "Table spec for a BigQuery Write must be specified."); + checkNotNull(BigQueryHelpers.parseTableSpec(this.getOutputTable())); + + // validate create and write dispositions + CreateDisposition createDisposition = null; + if (!Strings.isNullOrEmpty(this.getCreateDisposition())) { + checkArgument( + CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()) != null, + invalidConfigMessage + + "Invalid create disposition was specified. Available dispositions are: ", + CREATE_DISPOSITIONS.keySet()); + createDisposition = CREATE_DISPOSITIONS.get(this.getCreateDisposition().toUpperCase()); + } + if (!Strings.isNullOrEmpty(this.getWriteDisposition())) { + checkNotNull( + WRITE_DISPOSITIONS.get(this.getWriteDisposition().toUpperCase()), + invalidConfigMessage + + "Invalid write disposition was specified. Available dispositions are: ", + WRITE_DISPOSITIONS.keySet()); + } + + // validate schema + if (!Strings.isNullOrEmpty(this.getJsonSchema())) { + // check if a TableSchema can be deserialized from the input schema string + checkNotNull(BigQueryHelpers.fromJsonString(this.getJsonSchema(), TableSchema.class)); + } else if (this.getUseBeamSchema() == null || !this.getUseBeamSchema()) { + // if no schema is provided, create disposition CREATE_NEVER has to be specified. + checkArgument( + createDisposition == CreateDisposition.CREATE_NEVER, + invalidConfigMessage + + "Create disposition is CREATE_IF_NEEDED, but no schema was provided."); + } + + // validation checks for streaming writes + checkArgument( + this.getNumStorageWriteApiStreams() == null || this.getNumStorageWriteApiStreams() > 0, + invalidConfigMessage + "When set, numStorageWriteApiStreams must be > 0, but was: %s", + this.getNumStorageWriteApiStreams()); + checkArgument( + this.getNumFileShards() == null || this.getNumFileShards() > 0, + invalidConfigMessage + "When set, numFileShards must be > 0, but was: %s", + this.getNumFileShards()); + checkArgument( + this.getTriggeringFrequencySeconds() == null || this.getTriggeringFrequencySeconds() > 0, + invalidConfigMessage + "When set, the trigger frequency must be > 0, but was: %s", + this.getTriggeringFrequencySeconds()); + } + + /** + * Instantiates a {@link BigQueryStorageWriteApiSchemaTransformConfiguration.Builder} instance. + */ + public static Builder builder() { + return new AutoValue_BigQueryStorageWriteApiSchemaTransformProvider_BigQueryStorageWriteApiSchemaTransformConfiguration + .Builder(); + } + + public abstract String getOutputTable(); Review Comment: maybe just `getTable`? WDYT? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@beam.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
