Add read method for yielding transformed records to TIMDEXDataset #58
Conversation
This file contains hidden or 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
Why these changes are being introduced: * Transformed records are recorded as serialized JSON strings under the 'transformed_record' column for each row in a TIMDEXDataset. This method allows applications for TIMDEX ETL to easily retrieve parsed transformed records from a dataset via this library. How this addresses that need: * Add 'read_transformed_records_iter' method to TIMDEXDataset Side effects of this change: * Applications like TIM can now retrieve parsed transformed records from dataset Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/TIMX-453
ghukill
approved these changes
Jan 6, 2025
Contributor
ghukill
left a comment
ghukill
left a comment
There was a problem hiding this comment.
Short and sweet, looks great to me!
ehanson8
approved these changes
Jan 6, 2025
jonavellecuerdo
deleted the
TIMX-453-read-transformed-records-from-dataset
branch
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.
Purpose and background context
Transformed records are recorded as serialized JSON strings under the transformed_record column for each row in a TIMDEXDataset. This new method will resemble the read methods implemented via https://mitlibraries.atlassian.net/browse/TIMX-417 , with the additional step of parsing the JSON string and yielding dictionaries of transformed records.
How can a reviewer manually see the effects of these changes?
Reviewing the new unit test should be sufficient for this PR.
Includes new or updated dependencies?
NO
Changes expectations for external applications?
YES - These changes came from initial discussions on how TIM accesses transformed records from a
TIMDEXDataset. Applications like TIM can use this method to retrieve parsed transformed records from the dataset.What are the relevant tickets?
Developer
Code Reviewer(s)