diff --git a/model/pipeline/src/main/proto/beam_runner_api.proto b/model/pipeline/src/main/proto/beam_runner_api.proto index effc6ff899b2..204c408ba1a4 100644 --- a/model/pipeline/src/main/proto/beam_runner_api.proto +++ b/model/pipeline/src/main/proto/beam_runner_api.proto @@ -645,63 +645,6 @@ message StandardCoders { } } -// Experimental: A representation of a Beam Schema. -message Schema { - enum AtomicType { - UNSPECIFIED = 0; - BYTE = 1; - INT16 = 2; - INT32 = 3; - INT64 = 4; - FLOAT = 5; - DOUBLE = 6; - STRING = 7; - BOOLEAN = 8; - BYTES = 9; - } - - message ArrayType { - FieldType element_type = 1; - } - - message MapType { - FieldType key_type = 1; - FieldType value_type = 2; - } - - message RowType { - Schema schema = 1; - } - - message LogicalType { - string urn = 1; - string args = 2; - FieldType representation = 3; - } - - message FieldType { - bool nullable = 1; - oneof type_info { - AtomicType atomic_type = 2; - ArrayType array_type = 3; - MapType map_type = 4; - RowType row_type = 5; - LogicalType logical_type = 6; - } - } - - message Field { - string name = 1; - string description = 2; - FieldType type = 3; - int32 id = 4; - int32 encoding_position = 5; - } - - repeated Field fields = 1; - string id = 2; -} - // A windowing strategy describes the window function, triggering, allowed // lateness, and accumulation mode for a PCollection. // diff --git a/model/pipeline/src/main/proto/schema.proto b/model/pipeline/src/main/proto/schema.proto new file mode 100644 index 000000000000..42629ebbcdc3 --- /dev/null +++ b/model/pipeline/src/main/proto/schema.proto @@ -0,0 +1,85 @@ +/* + * 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. + */ + +// ** Experimental ** +// Protocol Buffers describing Beam Schemas, a portable representation for +// complex types. + +syntax = "proto3"; + +package org.apache.beam.model.pipeline.v1; + +option go_package = "pipeline_v1"; +option java_package = "org.apache.beam.model.pipeline.v1"; +option java_outer_classname = "SchemaApi"; + +message Schema { + repeated Field fields = 1; + string id = 2; +} + +message Field { + string name = 1; + string description = 2; + FieldType type = 3; + int32 id = 4; + int32 encoding_position = 5; +} + +message FieldType { + bool nullable = 1; + oneof type_info { + AtomicType atomic_type = 2; + ArrayType array_type = 3; + MapType map_type = 4; + RowType row_type = 5; + LogicalType logical_type = 6; + } +} + +enum AtomicType { + UNSPECIFIED = 0; + BYTE = 1; + INT16 = 2; + INT32 = 3; + INT64 = 4; + FLOAT = 5; + DOUBLE = 6; + STRING = 7; + BOOLEAN = 8; + BYTES = 9; +} + +message ArrayType { + FieldType element_type = 1; +} + +message MapType { + FieldType key_type = 1; + FieldType value_type = 2; +} + +message RowType { + Schema schema = 1; +} + +message LogicalType { + string urn = 1; + string args = 2; + FieldType representation = 3; +} diff --git a/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/SchemaTranslation.java b/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/SchemaTranslation.java index dabe4e13588b..e07a20a39d53 100644 --- a/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/SchemaTranslation.java +++ b/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/SchemaTranslation.java @@ -19,40 +19,24 @@ import java.util.Map; import java.util.UUID; -import org.apache.beam.model.pipeline.v1.RunnerApi; +import org.apache.beam.model.pipeline.v1.SchemaApi; 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.vendor.guava.v26_0_jre.com.google.common.collect.BiMap; -import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableBiMap; import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.Maps; /** Utility methods for translating schemas. */ public class SchemaTranslation { - - private static final BiMap ATOMIC_TYPE_MAPPING = - ImmutableBiMap.builder() - .put(TypeName.BYTE, RunnerApi.Schema.AtomicType.BYTE) - .put(TypeName.INT16, RunnerApi.Schema.AtomicType.INT16) - .put(TypeName.INT32, RunnerApi.Schema.AtomicType.INT32) - .put(TypeName.INT64, RunnerApi.Schema.AtomicType.INT64) - .put(TypeName.FLOAT, RunnerApi.Schema.AtomicType.FLOAT) - .put(TypeName.DOUBLE, RunnerApi.Schema.AtomicType.DOUBLE) - .put(TypeName.STRING, RunnerApi.Schema.AtomicType.STRING) - .put(TypeName.BOOLEAN, RunnerApi.Schema.AtomicType.BOOLEAN) - .put(TypeName.BYTES, RunnerApi.Schema.AtomicType.BYTES) - .build(); - private static final String URN_BEAM_LOGICAL_DATETIME = "beam:fieldtype:datetime"; private static final String URN_BEAM_LOGICAL_DECIMAL = "beam:fieldtype:decimal"; - public static RunnerApi.Schema toProto(Schema schema) { + public static SchemaApi.Schema toProto(Schema schema) { String uuid = schema.getUUID() != null ? schema.getUUID().toString() : ""; - RunnerApi.Schema.Builder builder = RunnerApi.Schema.newBuilder().setId(uuid); + SchemaApi.Schema.Builder builder = SchemaApi.Schema.newBuilder().setId(uuid); for (Field field : schema.getFields()) { - RunnerApi.Schema.Field protoField = + SchemaApi.Field protoField = toProto( field, schema.indexOf(field.getName()), @@ -62,8 +46,8 @@ public static RunnerApi.Schema toProto(Schema schema) { return builder.build(); } - private static RunnerApi.Schema.Field toProto(Field field, int fieldId, int position) { - return RunnerApi.Schema.Field.newBuilder() + private static SchemaApi.Field toProto(Field field, int fieldId, int position) { + return SchemaApi.Field.newBuilder() .setName(field.getName()) .setDescription(field.getDescription()) .setType(toProto(field.getType())) @@ -72,23 +56,23 @@ private static RunnerApi.Schema.Field toProto(Field field, int fieldId, int posi .build(); } - private static RunnerApi.Schema.FieldType toProto(FieldType fieldType) { - RunnerApi.Schema.FieldType.Builder builder = RunnerApi.Schema.FieldType.newBuilder(); + private static SchemaApi.FieldType toProto(FieldType fieldType) { + SchemaApi.FieldType.Builder builder = SchemaApi.FieldType.newBuilder(); switch (fieldType.getTypeName()) { case ROW: builder.setRowType( - RunnerApi.Schema.RowType.newBuilder().setSchema(toProto(fieldType.getRowSchema()))); + SchemaApi.RowType.newBuilder().setSchema(toProto(fieldType.getRowSchema()))); break; case ARRAY: builder.setArrayType( - RunnerApi.Schema.ArrayType.newBuilder() + SchemaApi.ArrayType.newBuilder() .setElementType(toProto(fieldType.getCollectionElementType()))); break; case MAP: builder.setMapType( - RunnerApi.Schema.MapType.newBuilder() + SchemaApi.MapType.newBuilder() .setKeyType(toProto(fieldType.getMapKeyType())) .setValueType(toProto(fieldType.getMapValueType())) .build()); @@ -97,7 +81,7 @@ private static RunnerApi.Schema.FieldType toProto(FieldType fieldType) { case LOGICAL_TYPE: LogicalType logicalType = fieldType.getLogicalType(); builder.setLogicalType( - RunnerApi.Schema.LogicalType.newBuilder() + SchemaApi.LogicalType.newBuilder() .setUrn(logicalType.getIdentifier()) .setArgs(logicalType.getArgument()) .setRepresentation(toProto(logicalType.getBaseType())) @@ -107,30 +91,54 @@ private static RunnerApi.Schema.FieldType toProto(FieldType fieldType) { // but not yet in Java. (BEAM-7554) case DATETIME: builder.setLogicalType( - RunnerApi.Schema.LogicalType.newBuilder() + SchemaApi.LogicalType.newBuilder() .setUrn(URN_BEAM_LOGICAL_DATETIME) .setRepresentation(toProto(FieldType.INT64)) .build()); break; case DECIMAL: builder.setLogicalType( - RunnerApi.Schema.LogicalType.newBuilder() + SchemaApi.LogicalType.newBuilder() .setUrn(URN_BEAM_LOGICAL_DECIMAL) .setRepresentation(toProto(FieldType.BYTES)) .build()); break; - default: - builder.setAtomicType(ATOMIC_TYPE_MAPPING.get(fieldType.getTypeName())); + case BYTE: + builder.setAtomicType(SchemaApi.AtomicType.BYTE); + break; + case INT16: + builder.setAtomicType(SchemaApi.AtomicType.INT16); + break; + case INT32: + builder.setAtomicType(SchemaApi.AtomicType.INT32); + break; + case INT64: + builder.setAtomicType(SchemaApi.AtomicType.INT64); + break; + case FLOAT: + builder.setAtomicType(SchemaApi.AtomicType.FLOAT); + break; + case DOUBLE: + builder.setAtomicType(SchemaApi.AtomicType.DOUBLE); + break; + case STRING: + builder.setAtomicType(SchemaApi.AtomicType.STRING); + break; + case BOOLEAN: + builder.setAtomicType(SchemaApi.AtomicType.BOOLEAN); + break; + case BYTES: + builder.setAtomicType(SchemaApi.AtomicType.BYTES); break; } builder.setNullable(fieldType.getNullable()); return builder.build(); } - public static Schema fromProto(RunnerApi.Schema protoSchema) { + public static Schema fromProto(SchemaApi.Schema protoSchema) { Schema.Builder builder = Schema.builder(); Map encodingLocationMap = Maps.newHashMap(); - for (RunnerApi.Schema.Field protoField : protoSchema.getFieldsList()) { + for (SchemaApi.Field protoField : protoSchema.getFieldsList()) { Field field = fieldFromProto(protoField); builder.addField(field); encodingLocationMap.put(protoField.getName(), protoField.getEncodingPosition()); @@ -144,52 +152,72 @@ public static Schema fromProto(RunnerApi.Schema protoSchema) { return schema; } - private static Field fieldFromProto(RunnerApi.Schema.Field protoField) { + private static Field fieldFromProto(SchemaApi.Field protoField) { return Field.of(protoField.getName(), fieldTypeFromProto(protoField.getType())) .withDescription(protoField.getDescription()); } - private static FieldType fieldTypeFromProto(RunnerApi.Schema.FieldType protoFieldType) { - FieldType fieldType; + private static FieldType fieldTypeFromProto(SchemaApi.FieldType protoFieldType) { + FieldType fieldType = fieldTypeFromProtoWithoutNullable(protoFieldType); + + if (protoFieldType.getNullable()) { + fieldType = fieldType.withNullable(true); + } + + return fieldType; + } + + private static FieldType fieldTypeFromProtoWithoutNullable(SchemaApi.FieldType protoFieldType) { switch (protoFieldType.getTypeInfoCase()) { case ATOMIC_TYPE: - TypeName typeName = ATOMIC_TYPE_MAPPING.inverse().get(protoFieldType.getAtomicType()); - fieldType = FieldType.of(typeName); - break; + switch (protoFieldType.getAtomicType()) { + case BYTE: + return FieldType.of(TypeName.BYTE); + case INT16: + return FieldType.of(TypeName.INT16); + case INT32: + return FieldType.of(TypeName.INT32); + case INT64: + return FieldType.of(TypeName.INT64); + case FLOAT: + return FieldType.of(TypeName.FLOAT); + case DOUBLE: + return FieldType.of(TypeName.DOUBLE); + case STRING: + return FieldType.of(TypeName.STRING); + case BOOLEAN: + return FieldType.of(TypeName.BOOLEAN); + case BYTES: + return FieldType.of(TypeName.BYTES); + case UNSPECIFIED: + throw new IllegalArgumentException("Encountered UNSPECIFIED AtomicType"); + default: + throw new IllegalArgumentException( + "Encountered unknown AtomicType: " + protoFieldType.getAtomicType()); + } case ROW_TYPE: - fieldType = FieldType.row(fromProto(protoFieldType.getRowType().getSchema())); - break; + return FieldType.row(fromProto(protoFieldType.getRowType().getSchema())); case ARRAY_TYPE: - fieldType = - FieldType.array(fieldTypeFromProto(protoFieldType.getArrayType().getElementType())); - break; + return FieldType.array(fieldTypeFromProto(protoFieldType.getArrayType().getElementType())); case MAP_TYPE: - fieldType = - FieldType.map( - fieldTypeFromProto(protoFieldType.getMapType().getKeyType()), - fieldTypeFromProto(protoFieldType.getMapType().getValueType())); - break; + return FieldType.map( + fieldTypeFromProto(protoFieldType.getMapType().getKeyType()), + fieldTypeFromProto(protoFieldType.getMapType().getValueType())); case LOGICAL_TYPE: // Special-case for DATETIME and DECIMAL which are logical types in portable representation, // but not yet in Java. (BEAM-7554) String urn = protoFieldType.getLogicalType().getUrn(); if (urn.equals(URN_BEAM_LOGICAL_DATETIME)) { - fieldType = FieldType.DATETIME; + return FieldType.DATETIME; } else if (urn.equals(URN_BEAM_LOGICAL_DECIMAL)) { - fieldType = FieldType.DECIMAL; + return FieldType.DECIMAL; } else { // TODO: Look up logical type class by URN. throw new IllegalArgumentException("Decoding logical types is not yet supported."); } - break; default: throw new IllegalArgumentException( "Unexpected type_info: " + protoFieldType.getTypeInfoCase()); } - - if (protoFieldType.getNullable()) { - fieldType = fieldType.withNullable(true); - } - return fieldType; } } diff --git a/runners/core-construction-java/src/test/java/org/apache/beam/runners/core/construction/SchemaTranslationTest.java b/runners/core-construction-java/src/test/java/org/apache/beam/runners/core/construction/SchemaTranslationTest.java index 5293cfe9f783..2502d0b8b668 100644 --- a/runners/core-construction-java/src/test/java/org/apache/beam/runners/core/construction/SchemaTranslationTest.java +++ b/runners/core-construction-java/src/test/java/org/apache/beam/runners/core/construction/SchemaTranslationTest.java @@ -20,7 +20,7 @@ import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; -import org.apache.beam.model.pipeline.v1.RunnerApi; +import org.apache.beam.model.pipeline.v1.SchemaApi; import org.apache.beam.sdk.schemas.Schema; import org.apache.beam.sdk.schemas.Schema.Field; import org.apache.beam.sdk.schemas.Schema.FieldType; @@ -80,7 +80,7 @@ public static Iterable data() { @Test public void toAndFromProto() throws Exception { - RunnerApi.Schema schemaProto = SchemaTranslation.toProto(schema); + SchemaApi.Schema schemaProto = SchemaTranslation.toProto(schema); Schema decodedSchema = SchemaTranslation.fromProto(schemaProto); assertThat(decodedSchema, equalTo(schema)); diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/SchemaCoderCloudObjectTranslator.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/SchemaCoderCloudObjectTranslator.java index 2395f12a2555..af73fd04570a 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/SchemaCoderCloudObjectTranslator.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/SchemaCoderCloudObjectTranslator.java @@ -18,7 +18,7 @@ package org.apache.beam.runners.dataflow.util; import java.io.IOException; -import org.apache.beam.model.pipeline.v1.RunnerApi; +import org.apache.beam.model.pipeline.v1.SchemaApi; import org.apache.beam.runners.core.construction.SchemaTranslation; import org.apache.beam.runners.core.construction.SdkComponents; import org.apache.beam.sdk.schemas.Schema; @@ -72,8 +72,8 @@ public SchemaCoder fromCloudObject(CloudObject cloudObject) { StringUtils.jsonStringToByteArray( Structs.getString(cloudObject, FROM_ROW_FUNCTION)), "fromRowFunction"); - RunnerApi.Schema protoSchema = - RunnerApi.Schema.parseFrom( + SchemaApi.Schema protoSchema = + SchemaApi.Schema.parseFrom( StringUtils.jsonStringToByteArray(Structs.getString(cloudObject, SCHEMA))); Schema schema = SchemaTranslation.fromProto(protoSchema); return SchemaCoder.of(schema, toRowFunction, fromRowFunction);