1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE.txt in the project root for
# license information.
# -------------------------------------------------------------------------
from azure.cosmos import CosmosClient
from azure.cosmos.partition_key import PartitionKey
import config
# ----------------------------------------------------------------------------------------------------------
# Prerequisites -
#
# 1. An Azure Cosmos account -
# https://learn.microsoft.com/azure/cosmos-db/create-sql-api-python#create-a-database-account
#
# 2. Microsoft Azure Cosmos
# pip install azure-cosmos>=4.3.0b4
#
# 3. Configure Azure Cosmos account to add 3+ regions, such as 'West US 3', 'West US', 'East US 2'.
# If you added other regions, update L1~L3 with the regions in your account.
# ----------------------------------------------------------------------------------------------------------
# Sample - demonstrates how to use excluded locations in client level and request level
# ----------------------------------------------------------------------------------------------------------
# Note:
# This sample creates a Container to your database account.
# Each time a Container is created the account will be billed for 1 hour of usage based on
# the provisioned throughput (RU/s) of that account.
# ----------------------------------------------------------------------------------------------------------
HOST = config.settings["host"]
MASTER_KEY = config.settings["master_key"]
TENANT_ID = config.settings["tenant_id"]
CLIENT_ID = config.settings["client_id"]
CLIENT_SECRET = config.settings["client_secret"]
DATABASE_ID = config.settings["database_id"]
CONTAINER_ID = config.settings["container_id"]
PARTITION_KEY = PartitionKey(path="/pk")
L1, L2, L3 = 'West US 3', 'West US', 'East US 2'
def get_test_item(num):
test_item = {
'id': 'Item_' + str(num),
'pk': 'PartitionKey_' + str(num),
'test_object': True,
'lastName': 'Smith'
}
return test_item
def clean_up_db(client):
try:
client.delete_database(DATABASE_ID)
except Exception as e:
pass
def excluded_locations_client_level_sample():
preferred_locations = [L1, L2, L3]
excluded_locations = [L1, L2]
client = CosmosClient(
HOST,
MASTER_KEY,
preferred_locations=preferred_locations,
excluded_locations=excluded_locations
)
clean_up_db(client)
db = client.create_database(DATABASE_ID)
container = db.create_container(id=CONTAINER_ID, partition_key=PARTITION_KEY)
# For write operations with single master account, write endpoint will be the default endpoint,
# since preferred_locations or excluded_locations are ignored and used
created_item = container.create_item(get_test_item(0))
# For read operations, read endpoints will be 'preferred_locations' - 'excluded_locations'.
# In our sample, ['West US 3', 'West US', 'East US 2'] - ['West US 3', 'West US'] => ['East US 2'],
# therefore 'East US 2' will be the read endpoint, and items will be read from 'East US 2' location
item = container.read_item(item=created_item['id'], partition_key=created_item['pk'])
clean_up_db(client)
def excluded_locations_request_level_sample():
preferred_locations = [L1, L2, L3]
excluded_locations_on_client = [L1, L2]
excluded_locations_on_request = [L1]
client = CosmosClient(
HOST,
MASTER_KEY,
preferred_locations=preferred_locations,
excluded_locations=excluded_locations_on_client
)
clean_up_db(client)
db = client.create_database(DATABASE_ID)
container = db.create_container(id=CONTAINER_ID, partition_key=PARTITION_KEY)
# For write operations with single master account, write endpoint will be the default endpoint,
# since preferred_locations or excluded_locations are ignored and used
created_item = container.create_item(get_test_item(0), excluded_locations=excluded_locations_on_request)
# For read operations, read endpoints will be 'preferred_locations' - 'excluded_locations'.
# However, in our sample, since the excluded_locations` were passed with the read request, the `excluded_location`
# will be replaced with the locations from request, ['West US 3']. The `excluded_locations` on request always takes
# the highest priority!
# With the excluded_locations on request, the read endpoints will be ['West US', 'East US 2']
# ['West US 3', 'West US', 'East US 2'] - ['West US 3'] => ['West US', 'East US 2']
# Therefore, items will be read from 'West US' or 'East US 2' location
item = container.read_item(item=created_item['id'], partition_key=created_item['pk'], excluded_locations=excluded_locations_on_request)
clean_up_db(client)
if __name__ == "__main__":
# excluded_locations_client_level_sample()
excluded_locations_request_level_sample()
|
