Skip to content
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

Update mapping.md #873

Merged
merged 6 commits into from
Dec 12, 2023
Merged

Update mapping.md #873

merged 6 commits into from
Dec 12, 2023

Conversation

clairemcginty
Copy link
Contributor

fyi: PR diff is much easier to read w/ rich formatting turned on!

Change summary:

  • Update Time types to include java.time vs joda.time packages
  • Add a few newly added types (i.e. ByteBuffer, CharSequence, Duration for Avro)
  • Add notes for micro/milli/nano precision packages
  • Be explicit about naming Parquet logical type schemas
  • Add note for AvroCompat's effect on array type representation

Copy link

codecov bot commented Dec 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (998abda) 95.21% compared to head (1ccb041) 95.21%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #873   +/-   ##
=======================================
  Coverage   95.21%   95.21%           
=======================================
  Files          51       51           
  Lines        1777     1777           
  Branches      175      175           
=======================================
  Hits         1692     1692           
  Misses         85       85           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +47 to +49
9. More information on Parquet logical type schemas can be found [here](https://github.com/apache/parquet-format/blob/master/LogicalTypes.md). Time types are available at multiple precisions; import `magnolify.parquet.logical.micros._`, `magnolify.avro.logical.millis._`, or `magnolify.avro.logical.nanos._` accordingly.
10. See [protobuf.md](https://github.com/spotify/magnolify/blob/master/docs/protobuf.md) for more
11. Logical types available at micro- or milli-second precision; import `magnolify.avro.logical.micros._` or `magnolify.avro.logical.millis._` accordingly. BigQuery-compatible conversions are available in `magnolify.avro.logical.bigquery._`.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is great! 🙌

docs/mapping.md Outdated
| `org.joda.time.LocalDate` | `INT`<sup>11</sup> | - | - | - | - | - | - |
| `org.joda.time.DateTime` | `INT`<sup>11</sup> | - | - | - | - | - | - |
| `org.joda.time.LocalTime` | `INT`<sup>11</sup> | - | - | - | - | - | - |
| `java.util.UUID` | `STRING`<sup>4</sup> | - | ByteString (16 bytes) | - | `FIXED[16]`<sup>9</sup> | - | - |
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure the 9. note holds for the UUID in parquet here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point! Removed it.

@clairemcginty clairemcginty merged commit c7619c9 into main Dec 12, 2023
12 checks passed
@clairemcginty clairemcginty deleted the update-mapping branch December 12, 2023 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants