rdblue commented on a change in pull request #4120:
URL: https://github.com/apache/iceberg/pull/4120#discussion_r806316193
##########
File path: core/src/main/java/org/apache/iceberg/avro/AvroSchemaUtil.java
##########
@@ -90,6 +90,23 @@ static boolean hasIds(Schema schema) {
return AvroCustomOrderSchemaVisitor.visit(schema, new HasIds());
}
+ /**
+ * @param schema an Avro Schema
+ * @return true/false based on whether any of the nodes in the provided
schema is missing an
+ * ID property recognizable by Iceberg core API. To have an ID recognizable
by Iceberg core API:
+ * <ul>
+ * <li>a field node under struct (record) schema should have {@link
FIELD_ID_PROP} property
+ * <li>an element node under list (array) schema should have {@link
ELEMENT_ID_PROP} property
+ * <li>a pair of key and value node under map schema should have {@link
KEY_ID_PROP} and
+ * {@link VALUE_ID_PROP} respectively
+ * <li>a primitive node is not assigned any ID related properties
+ * </ul>
Review comment:
This long content is better suited for the main description, rather than
in the return. `@return` should be a short summary, like "@return true if the
schema has at least one field ID property, false otherwise"
The details about what "field ID property" could be should be above.
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
