Document type mapping and FieldUpdate/version-compat surface - #141
Merged
Conversation
…bility Add a new Types and Values guide page covering: - The full Go-schema-type to Python-type mapping (including time, duration, url, json -> datetime, timedelta, URL, dict/list), which docs previously only listed five scalar types for. - The FieldUpdate dataclass shape and a set_many bulk-write example. - A note on the SDK's current string-only write limitation: set/set_many always send string-valued TypedValues, and the server requires an exact oneof-variant match with no coercion, so writes to non-string-typed fields raise InvalidArgumentError today. Extend the Connecting guide with the previously-undocumented `interceptors` constructor kwarg (including interceptor ordering for sync vs async clients) and the version-compatibility surface (check_version, get_server_version, check_compatibility, IncompatibleServerError). Closes #136
zeevdr
added
size: M
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Summary
time,duration,url,jsonwere missing) or theFieldUpdatebulk-write shape, leaving readers to guess atdatetime/timedelta/URL/dict/listsupport inget().interceptors,get_server_version,check_compatibility,IncompatibleServerError) had no documentation at all.Test plan
docs/guide/types.md: full Go-schema-type -> Python-type table,get()supported-types list (includingdatetime,timedelta,URL,dict,list),FieldUpdatefield reference and aset_manyexample, and an explicit warning documenting the SDK's current string-only write limitation (writes to non-stringfields raiseInvalidArgumentErrorbecause the server requires an exact oneof-variant match with no coercion).docs/guide/connect.mdwith theinterceptorsconstructor kwarg (including sync vs. async interceptor ordering) and the version-compatibility surface (check_version,get_server_version,check_compatibility,IncompatibleServerError).make lint,make typecheck,make testall pass.mkdocs build --strictsucceeds with no broken links or nav warnings.Closes #136