Repository navigation
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
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.
What's Changed
Arrow JS can read and write compressed IPC record batches, but nothing outside the tests explained that you have to register codecs yourself, so this adds TSDoc covering it:
CodecandcompressionRegistry: no codecs are bundled or registered by default; a codec needsdecodeto read andencodeto write;encodehas to produce an LZ4 frame or Zstandard frame and is checked against the magic number when registered; codecs are process-wide; includes a short LZ4 example.tableFromIPC: compressed data is decompressed only if a codec was registered first, otherwise it throws.tableToIPCand the writercompressionTypeoption: a codec withencodemust be registered, buffers that don't shrink are written uncompressed, and the legacy IPC format isn't supported.Docs only, no behavior change.
eslint src/ipcpasses andtypedocreports the same warning count as onmain. I also checked the example and the error cases with a throwaway jest test (writing without a codec throws, reading without adecodethrows "Record batch is compressed but codec not found", and the round trip works once both are registered).This PR was prepared with AI assistance and reviewed by me.
Closes #298.