fix: optional schema fields are always set to 0 #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for this PR, and sorry for not noticing it for so long. I'd like to understand the intent behind these fields, and maybe look into populating them correctly. I'm sure these changes are more correct than populating them all with zeros, so it looks like a good PR to merge. Thanks again. |
cswank
approved these changes
Sep 23, 2024
|
Thanks for merging.
There is some documentation about these fields here |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SchemaElementint32 optional fields likeFieldId,Scale,Precisionetc. are always serialised with value 0.See for example the schema generated for the example in
_examples/people/:returns
{ "name": "Root", "num_children": 13, "children": [ { "type": "INT32", "type_length": 0, "repetition_type": "REQUIRED", "name": "Id", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT32", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Age", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT64", "type_length": 0, "repetition_type": "REQUIRED", "name": "Happiness", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT64", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Sadness", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "BYTE_ARRAY", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Code", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "FLOAT", "type_length": 0, "repetition_type": "REQUIRED", "name": "Funkiness", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "FLOAT", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Lameness", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "BOOLEAN", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Keen", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT32", "type_length": 0, "repetition_type": "REQUIRED", "name": "Birthday", "converted_type": "UINT_32", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT64", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Anniversary", "converted_type": "UINT_64", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT32", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Difficulty", "scale": 0, "precision": 0, "field_id": 0 }, { "repetition_type": "OPTIONAL", "name": "Hobby", "num_children": 2, "children": [ { "type": "BYTE_ARRAY", "type_length": 0, "repetition_type": "REQUIRED", "name": "Name", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT32", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Difficulty", "scale": 0, "precision": 0, "field_id": 0 } ] }, { "repetition_type": "REPEATED", "name": "Friends", "num_children": 2, "children": [ { "type": "INT32", "type_length": 0, "repetition_type": "REQUIRED", "name": "Id", "scale": 0, "precision": 0, "field_id": 0 }, { "type": "INT32", "type_length": 0, "repetition_type": "OPTIONAL", "name": "Age", "scale": 0, "precision": 0, "field_id": 0 } ] } ] }This can have unintended consequences with any Parquet reader that explicitly uses the schema.
Additionally the fields are only serialised if they are not
nil, see here.With the proposed changes the schema for the example in
_examples/people/is:{ "name": "Root", "num_children": 13, "children": [ { "type": "INT32", "repetition_type": "REQUIRED", "name": "Id" }, { "type": "INT32", "repetition_type": "OPTIONAL", "name": "Age" }, { "type": "INT64", "repetition_type": "REQUIRED", "name": "Happiness" }, { "type": "INT64", "repetition_type": "OPTIONAL", "name": "Sadness" }, { "type": "BYTE_ARRAY", "repetition_type": "OPTIONAL", "name": "Code" }, { "type": "FLOAT", "repetition_type": "REQUIRED", "name": "Funkiness" }, { "type": "FLOAT", "repetition_type": "OPTIONAL", "name": "Lameness" }, { "type": "BOOLEAN", "repetition_type": "OPTIONAL", "name": "Keen" }, { "type": "INT32", "repetition_type": "REQUIRED", "name": "Birthday", "converted_type": "UINT_32" }, { "type": "INT64", "repetition_type": "OPTIONAL", "name": "Anniversary", "converted_type": "UINT_64" }, { "type": "INT32", "repetition_type": "OPTIONAL", "name": "Difficulty" }, { "repetition_type": "OPTIONAL", "name": "Hobby", "num_children": 2, "children": [ { "type": "BYTE_ARRAY", "repetition_type": "REQUIRED", "name": "Name" }, { "type": "INT32", "repetition_type": "OPTIONAL", "name": "Difficulty" } ] }, { "repetition_type": "REPEATED", "name": "Friends", "num_children": 2, "children": [ { "type": "INT32", "repetition_type": "REQUIRED", "name": "Id" }, { "type": "INT32", "repetition_type": "OPTIONAL", "name": "Age" } ] } ] }