Skip to content

feat: extract comments from avro schema #796

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.

Sign up for GitHub

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

Open
parisni wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: extract comments from avro schema #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c1d2b3
feat: extract comments from avro schema
parisni Feb 3, 2026
ffd6761
add ut
parisni Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions xtable-core/src/main/java/org/apache/xtable/avro/AvroSchemaConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,19 @@ private InternalSchema toInternalSchema(
List<InternalField> subFields = new ArrayList<>(schema.getFields().size());
for (Schema.Field avroField : schema.getFields()) {
IdMapping idMapping = fieldNameToIdMapping.get(avroField.name());
String fieldDoc = avroField.doc();
if (fieldDoc == null) {
fieldDoc = avroField.getProp("comment");
Copy link
Contributor

@the-other-tim-brown the-other-tim-brown Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a legacy way of adding docs to avro?

}
InternalSchema subFieldSchema =
toInternalSchema(
avroField.schema(),
SchemaUtils.getFullyQualifiedPath(parentPath, avroField.name()),
getChildIdMap(idMapping));
Object defaultValue = getDefaultValue(avroField);
if (fieldDoc != null && subFieldSchema.getComment() == null) {
subFieldSchema = InternalSchema.builderFrom(subFieldSchema).comment(fieldDoc).build();
}
subFields.add(
InternalField.builder()
.parentPath(parentPath)
Expand Down
21 changes: 21 additions & 0 deletions xtable-core/src/test/java/org/apache/xtable/avro/TestAvroSchemaConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -889,4 +889,25 @@ public void testIcebergToAvroUUIDSupport() {
assertEquals(
internalSchema, AvroSchemaConverter.getInstance().toInternalSchema(avroRepresentation));
}

@Test
public void testExtractFieldCommentsFromAvroDocOrProp() {
Schema avroRepresentation =
new Schema.Parser()
.parse(
"{\"type\":\"record\",\"name\":\"commentRecord\",\"fields\":["
+ "{\"name\":\"withDoc\",\"type\":\"string\",\"doc\":\"doc comment\"},"
+ "{\"name\":\"withProp\",\"type\":\"int\",\"comment\":\"prop comment\"}"
+ "]}");

InternalSchema internalSchema =
AvroSchemaConverter.getInstance().toInternalSchema(avroRepresentation);

Map<String, InternalField> fieldsByName =
internalSchema.getFields().stream()
.collect(java.util.stream.Collectors.toMap(InternalField::getName, f -> f));
Copy link
Contributor

@the-other-tim-brown the-other-tim-brown Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use an import instead of the fully qualified path


assertEquals("doc comment", fieldsByName.get("withDoc").getSchema().getComment());
assertEquals("prop comment", fieldsByName.get("withProp").getSchema().getComment());
}
}