Skip to content

Commit 25997da

Browse files
SnehaGundaSnehaGunda
committed
Python SDK release notes & sample updates
1 parent 254c1c3 commit 25997da

File tree

2 files changed

+18
-120
lines changed

2 files changed

+18
-120
lines changed

‎.openpublishing.publish.config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,11 @@
434434
"url": "https://github.com/Azure-Samples/azure-cosmos-db-sql-xamarin-getting-started",
435435
"branch": "master"
436436
},
437+
{
438+
"path_to_root": "cosmosdb-python-sdk",
439+
"url": "https://github.com/Azure/azure-sdk-for-python/sdk/cosmos/",
440+
"branch": "master"
441+
},
437442
{
438443
"path_to_root": "cosmosdb-nodejs-get-started",
439444
"url": "https://github.com/Azure-Samples/azure-cosmos-db-sql-api-nodejs-getting-started",

‎articles/cosmos-db/sql-api-sdk-python.md

Lines changed: 13 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
title: 'Azure Cosmos DB: SQL Python API, SDK & resources'
2+
title: Azure Cosmos DB SQL Python API, SDK & resources
33
description: Learn all about the SQL Python API and SDK including release dates, retirement dates, and changes made between each version of the Azure Cosmos DB Python SDK.
44
author: SnehaGunda
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-sql
77
ms.devlang: python
88
ms.topic: reference
9-
ms.date: 11/29/2018
9+
ms.date: 05/20/2020
1010
ms.author: sngun
11-
12-
1311
---
1412
# Azure Cosmos DB Python SDK for SQL API: Release notes and resources
13+
1514
> [!div class="op_single_selector"]
1615
> * [.NET](sql-api-sdk-dotnet.md)
1716
> * [.NET Change Feed](sql-api-sdk-dotnet-changefeed.md)
@@ -30,127 +29,20 @@ ms.author: sngun
3029
|---|---|
3130
|**Download SDK**|[PyPI](https://pypi.org/project/azure-cosmos)|
3231
|**API documentation**|[Python API reference documentation](https://docs.microsoft.com/python/api/azure-cosmos/?view=azure-python)|
33-
|**SDK installation instructions**|[Python SDK installation instructions](https://github.com/Azure/azure-cosmos-python)|
34-
|**Contribute to SDK**|[GitHub](https://github.com/Azure/azure-cosmos-python)|
35-
|**Get started**|[Get started with the Python SDK](sql-api-python-application.md)|
36-
|**Current supported platform**|[Python 2.7](https://www.python.org/downloads/) and [Python 3.5](https://www.python.org/downloads/)|
37-
38-
## Release notes
39-
40-
### <a name="3.0.2"/>3.0.2
41-
* Added support for MultiPolygon datatype
42-
* Bug fix in session read retry policy
43-
* Bug fix for incorrect padding issues while decoding base 64 strings
44-
45-
### <a name="3.0.1"/>3.0.1
46-
* Bug fix in LocationCache
47-
* Bug fix endpoint retry logic
48-
* Fixed documentation
49-
50-
### <a name="3.0.0"/>3.0.0
51-
* Support for multi-region writes.
52-
* Namespace changed to azure.cosmos.
53-
* Collection and document concepts renamed to container and item, document_client renamed to cosmos_client.
54-
55-
### <a name="2.3.3"/>2.3.3
56-
* Added support for proxy
57-
* Added support for reading change feed
58-
* Added support for collection quota headers
59-
* Bugfix for large session tokens issue
60-
* Bugfix for ReadMedia API
61-
* Bugfix in partition key range cache
62-
63-
### <a name="2.3.2"/>2.3.2
64-
* Added support for default retries on connection issues.
65-
66-
### <a name="2.3.1"/>2.3.1
67-
* Updated documentation to reference Azure Cosmos DB instead of Azure DocumentDB.
68-
69-
### <a name="2.3.0"/>2.3.0
70-
* This SDK version requires the latest version of [Azure Cosmos DB Emulator](https://aka.ms/cosmosdb-emulator).
71-
72-
### <a name="2.2.1"/>2.2.1
73-
* Bug fix for aggregate dictionary.
74-
* Bug fix for trimming slashes in the resource link.
75-
* Added tests for Unicode encoding.
76-
77-
### <a name="2.2.0"/>2.2.0
78-
* Added support for a new consistency level called ConsistentPrefix.
79-
80-
81-
### <a name="2.1.0"/>2.1.0
82-
* Added support for aggregation queries (COUNT, MIN, MAX, SUM, and AVG).
83-
* Added an option for disabling TLS verification when running against Cosmos DB Emulator.
84-
* Removed the restriction of dependent requests module to be exactly 2.10.0.
85-
* Lowered minimum throughput on partitioned collections from 10,100 RU/s to 2500 RU/s.
86-
* Added support for enabling script logging during stored procedure execution.
87-
* REST API version bumped to '2017-01-19' with this release.
88-
89-
### <a name="2.0.1"/>2.0.1
90-
* Made editorial changes to documentation comments.
91-
92-
### <a name="2.0.0"/>2.0.0
93-
* Added support for Python 3.5.
94-
* Added support for connection pooling using a requests module.
95-
* Added support for session consistency.
96-
* Added support for TOP/ORDERBY queries for partitioned collections.
32+
|**SDK installation instructions**|[Python SDK installation instructions](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos)|
33+
|**Get started**|[Get started with the Python SDK](create-sql-api-python.md)|
34+
|**Current supported platform**|[Python 2.7](https://www.python.org/downloads/) and [Python 3.5.3+](https://www.python.org/downloads/)|
9735

98-
### <a name="1.9.0"/>1.9.0
99-
* Added retry policy support for throttled requests. (Throttled requests receive a request rate too large exception, error code 429.) By default, Azure Cosmos DB retries nine times for each request when error code 429 is encountered, honoring the retryAfter time in the response header. A fixed retry interval time can now be set as part of the RetryOptions property on the ConnectionPolicy object if you want to ignore the retryAfter time returned by server between the retries. Azure Cosmos DB now waits for a maximum of 30 seconds for each request that is being throttled (irrespective of retry count) and returns the response with error code 429. This time can also be overridden in the RetryOptions property on ConnectionPolicy object.
100-
* Cosmos DB now returns x-ms-throttle-retry-count and x-ms-throttle-retry-wait-time-ms as the response headers in every request to denote the throttle retry count and the cumulative time the request waited between the retries.
101-
* Removed the RetryPolicy class and the corresponding property (retry_policy) exposed on the document_client class and instead introduced a RetryOptions class exposing the RetryOptions property on ConnectionPolicy class that can be used to override some of the default retry options.
102-
103-
### <a name="1.8.0"/>1.8.0
104-
* Added the support for multi-region database accounts.
105-
106-
### <a name="1.7.0"/>1.7.0
107-
* Added the support for Time To Live(TTL) feature for documents.
108-
109-
### <a name="1.6.1"/>1.6.1
110-
* Bug fixes related to server-side partitioning to allow special characters in partition key path.
111-
112-
### <a name="1.6.0"/>1.6.0
113-
* Implemented [partitioned collections](partition-data.md) and [user-defined performance levels](performance-levels.md).
114-
115-
### <a name="1.5.0"/>1.5.0
116-
* Add Hash & Range partition resolvers to assist with sharding applications across multiple partitions.
117-
118-
### <a name="1.4.2"/>1.4.2
119-
* Implement Upsert. New UpsertXXX methods added to support Upsert feature.
120-
* Implement ID Based Routing. No public API changes, all changes internal.
121-
122-
### <a name="1.2.0"/>1.2.0
123-
* Supports GeoSpatial index.
124-
* Validates id property for all resources. Ids for resources cannot contain ?, /, #, \, characters or end with a space.
125-
* Adds new header "index transformation progress" to ResourceResponse.
126-
127-
### <a name="1.1.0"/>1.1.0
128-
* Implements V2 indexing policy.
129-
130-
### <a name="1.0.1"/>1.0.1
131-
* Supports proxy connection.
132-
133-
### <a name="1.0.0"/>1.0.0
134-
* GA SDK.
36+
[!INCLUDE[Release notes](~/cosmosdb-python-sdk/azure-cosmos/CHANGELOG.md)]
13537

13638
## Release & retirement dates
137-
Microsoft provides notification at least **12 months** in advance of retiring an SDK in order to smooth the transition to a newer/supported version.
13839

139-
New features and functionality and optimizations are only added to the current SDK, as such it is recommend that you always upgrade to the latest SDK version as early as possible.
40+
Microsoft provides notification at least **12 months** in advance of retiring an SDK in order to smooth the transition to a newer/supported version. New features and functionality and optimizations are only added to the current SDK, as such it is recommend that you always upgrade to the latest SDK version as early as possible.
14041

141-
Any request to Cosmos DB using a retired SDK are rejected by the service.
142-
143-
> [!WARNING]
144-
> All versions of the Python SDK for SQL API prior to version **1.0.0** were retired on **February 29, 2016**.
145-
>
146-
>
42+
Any request to Azure Cosmos DB using a retired SDK are rejected by the service.
14743

14844
> [!WARNING]
149-
> All versions 1.x and 2.x of the Python SDK for SQL API will be retired on **August 30, 2020**.
150-
>
151-
>
152-
153-
<br/>
45+
> All versions of the Python SDK for SQL API prior to version **1.0.0** were retired on **February 29, 2016**. And, all versions 1.x and 2.x of the Python SDK for SQL API will be retired on **August 30, 2020**.
15446
15547
| Version | Release Date | Retirement Date |
15648
| --- | --- | --- |
@@ -184,8 +76,9 @@ Any request to Cosmos DB using a retired SDK are rejected by the service.
18476
| 0.9.0-prelease |August 21, 2014 |February 29, 2016 |
18577

18678
## FAQ
79+
18780
[!INCLUDE [cosmos-db-sdk-faq](../../includes/cosmos-db-sdk-faq.md)]
18881

189-
## See also
190-
To learn more about Cosmos DB, see [Microsoft Azure Cosmos DB](https://azure.microsoft.com/services/cosmos-db/) service page.
82+
## Next steps
19183

84+
To learn more about Cosmos DB, see [Microsoft Azure Cosmos DB](https://azure.microsoft.com/services/cosmos-db/) service page.

0 commit comments

Comments
 (0)