Skip to content

[Cosmos] work items for async preview #22043

Closed

Description

This issue will be used to track work items that should be completed while the async client is in preview mode. Any item with a checkmark will have its PR as a comment below as well.

  • Move the asynchronous client away from using **kwargs to align with python3 best design practices
  • Remove support for Python2 - RELEASED b2
  • Add warning to sync client's populate_query_metrics flag if used in methods that don't need it and remove from documentation
  • Deprecate read_offer in the sync api to align with read_throughput renaming in async client (Cosmos no longer references Offers in public docs as opposed to Throughput - may confuse users trying to use these functionalities)
  • Undocument/ remove documentation around build_options, cosmos_client_connection, connection_retry_policy for both clients - objects need to be private. For this one, add samples to show how a user might pass in retry/ policy config values as opposed to object instance
    • Will have to split this one into individual efforts for each since some cover a lot of area within the SDK
  • Transition into using python3 typehints for async client
  • GetAuthorizationHeader documentation should be removed from sync client and then made private, also bring in method with proper naming to not create breaking changes.
    • This method is being used both in tests and in samples for non-partitioned container operations using rest API, in order to remove usages of the method these tests/samples would have to be removed too
  • Verify and split proof GONE status code for partition key refresh - RELEASED SYNC b2, ASYNC b3
  • Edit async client user agent to be different for ease of use when debugging - RELEASED b2
  • before we go GA we should make most of these files in aio directory private
  • [Cosmos] move is_system_key logic to be computed only once on container usage #23169 - RELEASED b4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

ClientThis issue points to a problem in the data-plane of the library.Cosmos

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions