reuvenlax commented on a change in pull request #14136: URL: https://github.com/apache/beam/pull/14136#discussion_r587896071
########## File path: sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BeamRowToStorageApiProto.java ########## @@ -0,0 +1,339 @@ +/* + * 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; + +import com.google.protobuf.ByteString; +import com.google.protobuf.DescriptorProtos.DescriptorProto; +import com.google.protobuf.DescriptorProtos.FieldDescriptorProto; +import com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Label; +import com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type; +import com.google.protobuf.DescriptorProtos.FileDescriptorProto; +import com.google.protobuf.Descriptors.Descriptor; +import com.google.protobuf.Descriptors.DescriptorValidationException; +import com.google.protobuf.Descriptors.FieldDescriptor; +import com.google.protobuf.Descriptors.FileDescriptor; +import com.google.protobuf.DynamicMessage; +import java.math.BigDecimal; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.stream.Collectors; +import java.util.stream.StreamSupport; +import javax.annotation.Nullable; +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.Schema.LogicalType; +import org.apache.beam.sdk.schemas.Schema.TypeName; +import org.apache.beam.sdk.schemas.logicaltypes.EnumerationType; +import org.apache.beam.sdk.schemas.logicaltypes.SqlTypes; +import org.apache.beam.sdk.values.Row; +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.Functions; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.Iterables; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.Lists; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.primitives.Bytes; +import org.joda.time.Instant; +import org.joda.time.ReadableInstant; + +/** + * Utility methods for converting Beam {@link Row} objects to dynamic protocol message, for use with + * the Storage write API. + */ +public class BeamRowToStorageApiProto { + // Number of digits after the decimal point supported by the NUMERIC data type. + private static final int NUMERIC_SCALE = 9; + // Maximum and minimum allowed values for the NUMERIC data type. + private static final BigDecimal MAX_NUMERIC_VALUE = + new BigDecimal("99999999999999999999999999999.999999999"); + private static final BigDecimal MIN_NUMERIC_VALUE = + new BigDecimal("-99999999999999999999999999999.999999999"); + + // TODO(reuvenlax): Support BIGNUMERIC and GEOGRAPHY types. + static final Map<TypeName, Type> PRIMITIVE_TYPES = + ImmutableMap.<TypeName, Type>builder() + .put(TypeName.INT16, Type.TYPE_INT32) + .put(TypeName.BYTE, Type.TYPE_INT32) + .put(TypeName.INT32, Type.TYPE_INT32) + .put(TypeName.INT64, Type.TYPE_INT64) + .put(TypeName.FLOAT, Type.TYPE_FLOAT) + .put(TypeName.DOUBLE, Type.TYPE_DOUBLE) + .put(TypeName.STRING, Type.TYPE_STRING) + .put(TypeName.BOOLEAN, Type.TYPE_BOOL) + .put(TypeName.DATETIME, Type.TYPE_INT64) + .put(TypeName.BYTES, Type.TYPE_BYTES) + .put(TypeName.DECIMAL, Type.TYPE_BYTES) + .build(); + + // A map of supported logical types to the protobuf field type. + static final Map<String, Type> LOGICAL_TYPES = + ImmutableMap.<String, Type>builder() + .put(SqlTypes.DATE.getIdentifier(), Type.TYPE_INT32) + .put(SqlTypes.TIME.getIdentifier(), Type.TYPE_INT64) + .put(SqlTypes.DATETIME.getIdentifier(), Type.TYPE_INT64) + .put(SqlTypes.TIMESTAMP.getIdentifier(), Type.TYPE_INT64) + .put(EnumerationType.IDENTIFIER, Type.TYPE_STRING) + .build(); + + static final Map<TypeName, Function<Object, Object>> PRIMITIVE_ENCODERS = + ImmutableMap.<TypeName, Function<Object, Object>>builder() + .put(TypeName.INT16, o -> Integer.valueOf((Short) o)) + .put(TypeName.BYTE, o -> Integer.valueOf((Byte) o)) + .put(TypeName.INT32, Functions.identity()) + .put(TypeName.INT64, Functions.identity()) + .put(TypeName.FLOAT, Function.identity()) + .put(TypeName.DOUBLE, Function.identity()) + .put(TypeName.STRING, Function.identity()) + .put(TypeName.BOOLEAN, Function.identity()) + .put(TypeName.DATETIME, o -> ((ReadableInstant) o).getMillis() * 1000) + .put(TypeName.BYTES, o -> ByteString.copyFrom((byte[]) o)) + .put( + TypeName.DECIMAL, + o -> + serializeBigDecimal( + (BigDecimal) o, + NUMERIC_SCALE, + MAX_NUMERIC_VALUE, + MIN_NUMERIC_VALUE, + "Numeric")) + .build(); + + // A map of supported logical types to their encoding functions. + static final Map<String, BiFunction<LogicalType<?, ?>, Object, Object>> LOGICAL_TYPE_ENCODERS = + ImmutableMap.<String, BiFunction<LogicalType<?, ?>, Object, Object>>builder() + .put( + SqlTypes.DATE.getIdentifier(), + (logicalType, value) -> (int) ((LocalDate) value).toEpochDay()) + .put( + SqlTypes.TIME.getIdentifier(), + (logicalType, value) -> CivilTimeEncoder.encodePacked64TimeMicros((LocalTime) value)) + .put( + SqlTypes.DATETIME.getIdentifier(), + (logicalType, value) -> + CivilTimeEncoder.encodePacked64DatetimeSeconds((LocalDateTime) value)) + .put( + SqlTypes.TIMESTAMP.getIdentifier(), + (logicalType, value) -> ((Instant) value).getMillis() * 1000) + .put( + EnumerationType.IDENTIFIER, + (logicalType, value) -> + ((EnumerationType) logicalType).toString((EnumerationType.Value) value)) + .build(); + + /** + * Given a Beam Schema, returns a protocol-buffer Descriptor that can be used to write data using + * the BigQuery Storage API. + */ + public static Descriptor getDescriptorFromSchema(Schema schema) + throws DescriptorValidationException { + DescriptorProto descriptorProto = descriptorSchemaFromBeamSchema(schema); + FileDescriptorProto fileDescriptorProto = + FileDescriptorProto.newBuilder().addMessageType(descriptorProto).build(); + FileDescriptor fileDescriptor = + FileDescriptor.buildFrom(fileDescriptorProto, new FileDescriptor[0]); + + return Iterables.getOnlyElement(fileDescriptor.getMessageTypes()); + } + + /** + * Given a Beam {@link Row} object, returns a protocol-buffer message that can be used to write + * data using the BigQuery Storage streaming API. + */ + public static DynamicMessage messageFromBeamRow(Descriptor descriptor, Row row) { + Schema beamSchema = row.getSchema(); + DynamicMessage.Builder builder = DynamicMessage.newBuilder(descriptor); + for (int i = 0; i < row.getFieldCount(); ++i) { + Field beamField = beamSchema.getField(i); + FieldDescriptor fieldDescriptor = + Preconditions.checkNotNull(descriptor.findFieldByName(beamField.getName().toLowerCase())); + @Nullable Object value = messageValueFromRowValue(fieldDescriptor, beamField, i, row); + if (value != null) { + builder.setField(fieldDescriptor, value); + } + } + return builder.build(); + } + + @VisibleForTesting + static DescriptorProto descriptorSchemaFromBeamSchema(Schema schema) { + DescriptorProto.Builder descriptorBuilder = DescriptorProto.newBuilder(); + // Create a unique name for the descriptor ('-' characters cannot be used). + descriptorBuilder.setName("D" + UUID.randomUUID().toString().replace("-", "_")); + int i = 1; + List<DescriptorProto> nestedTypes = Lists.newArrayList(); + for (Field field : schema.getFields()) { + FieldDescriptorProto.Builder fieldDescriptorProtoBuilder = + fieldDescriptorFromBeamField(field, i++, nestedTypes); + descriptorBuilder.addField(fieldDescriptorProtoBuilder); + } + nestedTypes.forEach(descriptorBuilder::addNestedType); + return descriptorBuilder.build(); + } + + private static FieldDescriptorProto.Builder fieldDescriptorFromBeamField( + Field field, int fieldNumber, List<DescriptorProto> nestedTypes) { + FieldDescriptorProto.Builder fieldDescriptorBuilder = FieldDescriptorProto.newBuilder(); + fieldDescriptorBuilder = fieldDescriptorBuilder.setName(field.getName().toLowerCase()); + fieldDescriptorBuilder = fieldDescriptorBuilder.setNumber(fieldNumber); + + switch (field.getType().getTypeName()) { + case ROW: + @Nullable Schema rowSchema = field.getType().getRowSchema(); + if (rowSchema == null) { + throw new RuntimeException("Unexpected null schema!"); + } + DescriptorProto nested = descriptorSchemaFromBeamSchema(rowSchema); + nestedTypes.add(nested); + fieldDescriptorBuilder = + fieldDescriptorBuilder.setType(Type.TYPE_MESSAGE).setTypeName(nested.getName()); + break; + case ARRAY: + case ITERABLE: + @Nullable FieldType elementType = field.getType().getCollectionElementType(); + if (elementType == null) { + throw new RuntimeException("Unexpected null element type!"); + } + Preconditions.checkState( + !Preconditions.checkNotNull(elementType.getTypeName()).isCollectionType(), + "Nested arrays not supported by BigQuery."); + return fieldDescriptorFromBeamField( + Field.of(field.getName(), elementType), fieldNumber, nestedTypes) + .setLabel(Label.LABEL_REPEATED); + case LOGICAL_TYPE: + @Nullable LogicalType<?, ?> logicalType = field.getType().getLogicalType(); + if (logicalType == null) { + throw new RuntimeException("Unexpected null logical type " + field.getType()); + } + @Nullable Type type = LOGICAL_TYPES.get(logicalType.getIdentifier()); + if (type == null) { + throw new RuntimeException("Unsupported logical type " + field.getType()); + } + fieldDescriptorBuilder = fieldDescriptorBuilder.setType(type); + break; + case MAP: + throw new RuntimeException("Map types not supported by BigQuery."); + default: + @Nullable Type primitiveType = PRIMITIVE_TYPES.get(field.getType().getTypeName()); + if (primitiveType == null) { + throw new RuntimeException("Unsupported type " + field.getType()); + } + fieldDescriptorBuilder = fieldDescriptorBuilder.setType(primitiveType); + } + if (field.getType().getNullable()) { + fieldDescriptorBuilder = fieldDescriptorBuilder.setLabel(Label.LABEL_OPTIONAL); + } else { + fieldDescriptorBuilder = fieldDescriptorBuilder.setLabel(Label.LABEL_REQUIRED); + } + return fieldDescriptorBuilder; + } + + @Nullable + private static Object messageValueFromRowValue( + FieldDescriptor fieldDescriptor, Field beamField, int index, Row row) { + @Nullable Object value = row.getValue(index); + if (value == null) { + if (fieldDescriptor.isOptional()) { + return null; + } else { + throw new IllegalArgumentException( + "Received null value for non-nullable field " + fieldDescriptor.getName()); + } + } + return toProtoValue(fieldDescriptor, beamField.getType(), value); + } + + private static Object toProtoValue( + FieldDescriptor fieldDescriptor, FieldType beamFieldType, Object value) { + switch (beamFieldType.getTypeName()) { + case ROW: + return messageFromBeamRow(fieldDescriptor.getMessageType(), (Row) value); + case ARRAY: + List<Object> list = (List<Object>) value; + @Nullable FieldType arrayElementType = beamFieldType.getCollectionElementType(); + if (arrayElementType == null) { + throw new RuntimeException("Unexpected null element type!"); + } + return list.stream() + .map(v -> toProtoValue(fieldDescriptor, arrayElementType, v)) + .collect(Collectors.toList()); + case ITERABLE: + Iterable<Object> iterable = (Iterable<Object>) value; + @Nullable FieldType iterableElementType = beamFieldType.getCollectionElementType(); + if (iterableElementType == null) { + throw new RuntimeException("Unexpected null element type!"); + } + return StreamSupport.stream(iterable.spliterator(), false) + .map(v -> toProtoValue(fieldDescriptor, iterableElementType, v)) + .collect(Collectors.toList()); + case MAP: + throw new RuntimeException("Map types not supported by BigQuery."); + default: + return scalarToProtoValue(beamFieldType, value); + } + } + + @VisibleForTesting + static Object scalarToProtoValue(FieldType beamFieldType, Object value) { + if (beamFieldType.getTypeName() == TypeName.LOGICAL_TYPE) { + @Nullable LogicalType<?, ?> logicalType = beamFieldType.getLogicalType(); + if (logicalType == null) { + throw new RuntimeException("Unexpectedly null logical type " + beamFieldType); + } + @Nullable + BiFunction<LogicalType<?, ?>, Object, Object> logicalTypeEncoder = + LOGICAL_TYPE_ENCODERS.get(logicalType.getIdentifier()); + if (logicalTypeEncoder == null) { + throw new RuntimeException("Unsupported logical type " + logicalType.getIdentifier()); + } + return logicalTypeEncoder.apply(logicalType, value); + } else { + @Nullable + Function<Object, Object> encoder = PRIMITIVE_ENCODERS.get(beamFieldType.getTypeName()); + if (encoder == null) { + throw new RuntimeException("Unexpected beam type " + beamFieldType); + } + return encoder.apply(value); + } + } + + private static ByteString serializeBigDecimal( + BigDecimal v, int scale, BigDecimal maxValue, BigDecimal minValue, String typeName) { Review comment: This was copied from zetasql code. The main reason I believe is that this function can be used for BIGNUMERIC types as well, though I haven't added that support in this PR. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
