Repository navigation
docs(changelog): list the query completeness fields in 0.2.0 (Arc#726) - #34
Merged
Merged
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.
The 0.2.0 changelog covered the Arrow and MessagePack cap metadata from #25, but not the four
QueryResponsefields users actually read:truncated,truncation_reason,rows_cappedandrow_cap.This adds them under Query path, with the behaviour a caller needs to know:
truncated: Arc's stream failed part way, sodatais missing rows.query()returns it rather than raising, so callers must check the flag. This is the part most likely to surprise.rows_capped/row_cap: a governance row cap stopped the query, and the result is valid up to the cap.ArcQueryError, and the cap is in the schema metadata.ArcQueryError.Checked against the code:
models/query.py,query/arrow_response.py,query/msgpack_response.py, andtests/unit/http/test_query_metadata_contracts.py, which asserts thatquery()returnstruncated=Truerather than raising.Changelog only. Part of Arc#726, which closes once 0.2.0 ships.