-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Avro: Add internal writer #11919
Avro: Add internal writer #11919
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
/* | ||
* 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.iceberg.avro; | ||
|
||
import java.util.List; | ||
import org.apache.avro.LogicalType; | ||
import org.apache.avro.LogicalTypes; | ||
import org.apache.avro.Schema; | ||
import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
|
||
abstract class BaseAvroSchemaVisitor extends AvroSchemaVisitor<ValueWriter<?>> { | ||
|
||
protected abstract ValueWriter<?> createRecordWriter(List<ValueWriter<?>> fields); | ||
|
||
protected abstract ValueWriter<?> fixedWriter(int size); | ||
|
||
@Override | ||
public ValueWriter<?> record(Schema record, List<String> names, List<ValueWriter<?>> fields) { | ||
return createRecordWriter(fields); | ||
} | ||
|
||
@Override | ||
public ValueWriter<?> union(Schema union, List<ValueWriter<?>> options) { | ||
Preconditions.checkArgument( | ||
options.contains(ValueWriters.nulls()), | ||
"Cannot create writer for non-option union: %s", | ||
union); | ||
rdblue marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Preconditions.checkArgument( | ||
options.size() == 2, "Cannot create writer for non-option union: %s", union); | ||
if (union.getTypes().get(0).getType() == Schema.Type.NULL) { | ||
return ValueWriters.option(0, options.get(1)); | ||
} else { | ||
return ValueWriters.option(1, options.get(0)); | ||
} | ||
} | ||
|
||
@Override | ||
public ValueWriter<?> array(Schema array, ValueWriter<?> elementWriter) { | ||
if (array.getLogicalType() instanceof LogicalMap) { | ||
ValueWriters.StructWriter<?> keyValueWriter = (ValueWriters.StructWriter<?>) elementWriter; | ||
return ValueWriters.arrayMap(keyValueWriter.writer(0), keyValueWriter.writer(1)); | ||
} | ||
|
||
return ValueWriters.array(elementWriter); | ||
} | ||
|
||
@Override | ||
public ValueWriter<?> map(Schema map, ValueWriter<?> valueWriter) { | ||
return ValueWriters.map(ValueWriters.strings(), valueWriter); | ||
} | ||
|
||
@Override | ||
public ValueWriter<?> primitive(Schema primitive) { | ||
LogicalType logicalType = primitive.getLogicalType(); | ||
if (logicalType != null) { | ||
switch (logicalType.getName()) { | ||
case "date": | ||
return ValueWriters.ints(); | ||
|
||
case "time-micros": | ||
return ValueWriters.longs(); | ||
|
||
case "timestamp-micros": | ||
return ValueWriters.longs(); | ||
|
||
case "decimal": | ||
LogicalTypes.Decimal decimal = (LogicalTypes.Decimal) logicalType; | ||
return ValueWriters.decimal(decimal.getPrecision(), decimal.getScale()); | ||
|
||
case "uuid": | ||
return ValueWriters.uuids(); | ||
|
||
default: | ||
throw new IllegalArgumentException("Unsupported logical type: " + logicalType); | ||
} | ||
} | ||
|
||
switch (primitive.getType()) { | ||
case NULL: | ||
return ValueWriters.nulls(); | ||
case BOOLEAN: | ||
return ValueWriters.booleans(); | ||
case INT: | ||
return ValueWriters.ints(); | ||
case LONG: | ||
return ValueWriters.longs(); | ||
case FLOAT: | ||
return ValueWriters.floats(); | ||
case DOUBLE: | ||
return ValueWriters.doubles(); | ||
case STRING: | ||
return ValueWriters.strings(); | ||
case FIXED: | ||
return fixedWriter(primitive.getFixedSize()); | ||
case BYTES: | ||
return ValueWriters.byteBuffers(); | ||
default: | ||
throw new IllegalArgumentException("Unsupported type: " + primitive); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -205,7 +205,6 @@ public ValueReader<?> primitive(Pair<Integer, Type> partner, Schema primitive) { | |
case STRING: | ||
return ValueReaders.strings(); | ||
case FIXED: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As per Types.java, fixed also should be written and read as plain ByteBuffers. Refer the testcase in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree with this change. Another check that this is correct is that |
||
return ValueReaders.fixed(primitive); | ||
case BYTES: | ||
return ValueReaders.byteBuffers(); | ||
case ENUM: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
/* | ||
* 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.iceberg.avro; | ||
|
||
import java.io.IOException; | ||
import java.util.List; | ||
import java.util.stream.Stream; | ||
import org.apache.avro.Schema; | ||
import org.apache.avro.io.Encoder; | ||
import org.apache.iceberg.FieldMetrics; | ||
import org.apache.iceberg.types.Type; | ||
|
||
/** | ||
* A Writer that consumes Iceberg's internal in-memory object model. | ||
* | ||
* <p>Iceberg's internal in-memory object model produces the types defined in {@link | ||
* Type.TypeID#javaClass()}. | ||
*/ | ||
public class InternalWriter<T> implements MetricsAwareDatumWriter<T> { | ||
private ValueWriter<T> writer = null; | ||
|
||
public static <D> InternalWriter<D> create(Schema schema) { | ||
return new InternalWriter<>(schema); | ||
} | ||
|
||
InternalWriter(Schema schema) { | ||
setSchema(schema); | ||
} | ||
|
||
@Override | ||
@SuppressWarnings("unchecked") | ||
public void setSchema(Schema schema) { | ||
this.writer = (ValueWriter<T>) AvroSchemaVisitor.visit(schema, new GenericAvroSchemaVisitor()); | ||
} | ||
|
||
@Override | ||
public void write(T datum, Encoder out) throws IOException { | ||
writer.write(datum, out); | ||
} | ||
|
||
@Override | ||
public Stream<FieldMetrics> metrics() { | ||
return writer.metrics(); | ||
} | ||
|
||
private static class GenericAvroSchemaVisitor extends BaseAvroSchemaVisitor { | ||
ajantha-bhat marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
@Override | ||
protected ValueWriter<?> createRecordWriter(List<ValueWriter<?>> fields) { | ||
return ValueWriters.struct(fields); | ||
} | ||
|
||
@Override | ||
protected ValueWriter<?> fixedWriter(int size) { | ||
return ValueWriters.byteBuffers(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This isn't correct for the write path. In the read path, we want to broadly accept values and let validation happen later, so reading directly as @Override
public void write(byte[] bytes, Encoder encoder) throws IOException {
Preconditions.checkArgument(
bytes.length == length,
"Cannot write byte array of length %s as fixed[%s]",
bytes.length,
length);
encoder.writeFixed(bytes);
} I think this needs a new public static ValueWriter<ByteBuffer> fixedBuffers(int length) {
return new FixedByteBufferWriter(length);
}
private static class FixedByteBufferWriter implements ValueWriter<ByteBuffer> {
private final int length;
private FixedByteBufferWriter(int length) {
this.length = length;
}
@Override
public void write(ByteBuffer bytes, Encoder encoder) throws IOException {
Preconditions.checkArgument(
bytes.remaining() == length,
"Cannot write byte buffer of length %s as fixed[%s]",
bytes.remaining(),
length);
encoder.writeBytes(bytes);
}
} |
||
} | ||
} | ||
} |
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.
It's true that this is a visitor, but I think it's a best practice to use the class name to convey the purpose of this particular visitor.
In this case, it's building a writer tree so I think a name like
BaseWriteBuilder
would be more appropriate (based on what was copied here). You were right to useBase
to indicate that it is an abstract base class that is shared across object models. I might revise that suggestion when I read through more to see if this is more specific, too.Another reason is that the name
BaseAvroSchemaVisitor
is misleading. This class builds a writer tree and has a specific purpose. It wouldn't be used as a base for a visitor that has a different purpose, but the name implies that it could be.