feat(yaml): Add BigTable write connector #35435
There are no files selected for viewing
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| /* | ||
| * 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.bigtable; | ||
|
|
||
| import static java.util.Optional.ofNullable; | ||
| import static org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions.checkArgument; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import com.google.bigtable.v2.Mutation; | ||
| import com.google.bigtable.v2.TimestampRange; | ||
| import com.google.protobuf.ByteString; | ||
| import java.util.Objects; | ||
| import org.apache.beam.sdk.io.gcp.bigtable.BigtableWriteSchemaTransformProvider.BigtableWriteSchemaTransformConfiguration; | ||
| 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.GroupByKey; | ||
| import org.apache.beam.sdk.transforms.MapElements; | ||
| import org.apache.beam.sdk.values.KV; | ||
| 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.sdk.values.TypeDescriptors; | ||
|
|
||
| /** | ||
| * An implementation of {@link TypedSchemaTransformProvider} for Bigtable Write jobs configured via | ||
| * {@link BigtableWriteSchemaTransformConfiguration}. | ||
| */ | ||
| @AutoService(SchemaTransformProvider.class) | ||
| public class BigtableSimpleWriteSchemaTransformProvider | ||
arnavarora2004 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| extends TypedSchemaTransformProvider<BigtableWriteSchemaTransformConfiguration> { | ||
|
|
||
| private static final String INPUT_TAG = "input"; | ||
|
|
||
| @Override | ||
| protected SchemaTransform from(BigtableWriteSchemaTransformConfiguration configuration) { | ||
| return new BigtableSimpleWriteSchemaTransform(configuration); | ||
| } | ||
|
|
||
| @Override | ||
| public String identifier() { | ||
| return "beam:schematransform:org.apache.beam:bigtable_simple_write:v1"; | ||
| } | ||
|
|
||
| /** | ||
| * A {@link SchemaTransform} for Bigtable writes, configured with {@link | ||
| * BigtableWriteSchemaTransformConfiguration} and instantiated by {@link | ||
| * BigtableWriteSchemaTransformProvider}. | ||
| */ | ||
| private static class BigtableSimpleWriteSchemaTransform extends SchemaTransform { | ||
| private final BigtableWriteSchemaTransformConfiguration configuration; | ||
|
|
||
| BigtableSimpleWriteSchemaTransform(BigtableWriteSchemaTransformConfiguration configuration) { | ||
| configuration.validate(); | ||
| this.configuration = configuration; | ||
| } | ||
|
|
||
| @Override | ||
| public PCollectionRowTuple expand(PCollectionRowTuple input) { | ||
| checkArgument( | ||
arnavarora2004 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| input.has(INPUT_TAG), | ||
| String.format( | ||
| "Could not find expected input [%s] to %s.", INPUT_TAG, getClass().getSimpleName())); | ||
|
|
||
| PCollection<KV<ByteString, Iterable<Mutation>>> bigtableMutations = | ||
| changeMutationInput(input); | ||
|
|
||
| bigtableMutations.apply( | ||
| BigtableIO.write() | ||
| .withTableId(configuration.getTableId()) | ||
| .withInstanceId(configuration.getInstanceId()) | ||
| .withProjectId(configuration.getProjectId())); | ||
|
|
||
| return PCollectionRowTuple.empty(input.getPipeline()); | ||
| } | ||
|
|
||
| public PCollection<KV<ByteString, Iterable<Mutation>>> changeMutationInput( | ||
| PCollectionRowTuple inputR) { | ||
| PCollection<Row> beamRowMutationsList = inputR.getSinglePCollection(); | ||
| // convert all row inputs into KV<ByteString, Mutation> | ||
| PCollection<KV<ByteString, Mutation>> changedBeamRowMutationsList = | ||
| beamRowMutationsList.apply( | ||
| MapElements.into( | ||
| TypeDescriptors.kvs( | ||
| TypeDescriptor.of(ByteString.class), TypeDescriptor.of(Mutation.class))) | ||
| .via( | ||
| (Row input) -> { | ||
| @SuppressWarnings("nullness") | ||
| ByteString key = | ||
| ByteString.copyFrom(((Objects.requireNonNull(input.getBytes("key"))))); | ||
|
|
||
| Mutation bigtableMutation; | ||
| String mutationType = | ||
| input.getString("type"); // Direct call, can return null | ||
| if (mutationType == null) { | ||
| throw new IllegalArgumentException("Mutation type cannot be null."); | ||
|
||
| } | ||
| switch (mutationType) { | ||
| case "SetCell": | ||
| @SuppressWarnings("nullness") | ||
| Mutation.SetCell.Builder setMutation = | ||
| Mutation.SetCell.newBuilder() | ||
| .setValue( | ||
| ByteString.copyFrom( | ||
| ((Objects.requireNonNull(input.getBytes("value")))))) | ||
arnavarora2004 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| .setColumnQualifier( | ||
| ByteString.copyFrom( | ||
| ((Objects.requireNonNull( | ||
| input.getBytes("column_qualifier")))))) | ||
| .setFamilyNameBytes( | ||
| ByteString.copyFrom( | ||
| (Objects.requireNonNull( | ||
| input.getBytes("family_name"))))); | ||
| // Use timestamp if provided, else default to -1 (current | ||
| // Bigtable | ||
| // server time) | ||
| // Timestamp (optional, assuming Long type in Row schema) | ||
| Long timestampMicros = input.getInt64("timestamp_micros"); | ||
| setMutation.setTimestampMicros( | ||
| timestampMicros != null ? timestampMicros : -1); | ||
|
|
||
| bigtableMutation = | ||
| Mutation.newBuilder().setSetCell(setMutation.build()).build(); | ||
| break; | ||
| case "DeleteFromColumn": | ||
| // set timestamp range if applicable | ||
| @SuppressWarnings("nullness") | ||
| Mutation.DeleteFromColumn.Builder deleteMutation = | ||
| Mutation.DeleteFromColumn.newBuilder() | ||
| .setColumnQualifier( | ||
| ByteString.copyFrom( | ||
| Objects.requireNonNull( | ||
| input.getBytes("column_qualifier")))) | ||
| .setFamilyNameBytes( | ||
| ByteString.copyFrom( | ||
| ofNullable(input.getBytes("family_name")).get())); | ||
|
|
||
| // if start or end timestamp provided | ||
| // Timestamp Range (optional, assuming Long type in Row schema) | ||
| Long startTimestampMicros = null; | ||
| Long endTimestampMicros = null; | ||
|
|
||
| if (input.getSchema().hasField("start_timestamp_micros")) { | ||
| startTimestampMicros = input.getInt64("start_timestamp_micros"); | ||
| } | ||
| if (input.getSchema().hasField("end_timestamp_micros")) { | ||
| endTimestampMicros = input.getInt64("end_timestamp_micros"); | ||
| } | ||
|
|
||
| if (startTimestampMicros != null || endTimestampMicros != null) { | ||
| TimestampRange.Builder timeRange = TimestampRange.newBuilder(); | ||
| if (startTimestampMicros != null) { | ||
| timeRange.setStartTimestampMicros(startTimestampMicros); | ||
| } | ||
| if (endTimestampMicros != null) { | ||
| timeRange.setEndTimestampMicros(endTimestampMicros); | ||
| } | ||
| deleteMutation.setTimeRange(timeRange.build()); | ||
| } | ||
| bigtableMutation = | ||
| Mutation.newBuilder() | ||
| .setDeleteFromColumn(deleteMutation.build()) | ||
| .build(); | ||
| break; | ||
| case "DeleteFromFamily": | ||
| bigtableMutation = | ||
| Mutation.newBuilder() | ||
| .setDeleteFromFamily( | ||
| Mutation.DeleteFromFamily.newBuilder() | ||
| .setFamilyNameBytes( | ||
| ByteString.copyFrom( | ||
| ofNullable(input.getBytes("family_name")) | ||
| .get())) | ||
| .build()) | ||
| .build(); | ||
| break; | ||
| case "DeleteFromRow": | ||
| bigtableMutation = | ||
| Mutation.newBuilder() | ||
| .setDeleteFromRow(Mutation.DeleteFromRow.newBuilder().build()) | ||
| .build(); | ||
| break; | ||
| default: | ||
| throw new RuntimeException( | ||
| String.format( | ||
| "Unexpected mutation type [%s]: %s", | ||
| ((input.getString("type"))), input)); | ||
| } | ||
| return KV.of(key, bigtableMutation); | ||
| })); | ||
| // now we need to make the KV into a PCollection of KV<ByteString, Iterable<Mutation>> | ||
| return changedBeamRowMutationsList.apply(GroupByKey.create()); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let us update CHANGES.md