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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE.txt in the project root for
# license information.
# -------------------------------------------------------------------------
import azure.cosmos.cosmos_client as cosmos_client
import azure.cosmos.exceptions as exceptions
from azure.cosmos.partition_key import PartitionKey
from azure.cosmos import ThroughputProperties
import config
# ----------------------------------------------------------------------------------------------------------
# Prerequisites -
#
# 1. An Azure Cosmos account -
# https://azure.microsoft.com/documentation/articles/documentdb-create-account/
#
# 2. Microsoft Azure Cosmos PyPi package -
# https://pypi.python.org/pypi/azure-cosmos/
# ----------------------------------------------------------------------------------------------------------
# Sample - demonstrates the basic CRUD operations on a Container resource for Azure Cosmos
#
# 1. Query for Container
#
# 2. Create Container
# 2.1 - Basic Create
# 2.2 - Create container with custom IndexPolicy
# 2.3 - Create container with provisioned throughput set
# 2.4 - Create container with unique key
# 2.5 - Create Container with partition key V2
# 2.6 - Create Container with partition key V1
# 2.7 - Create Container with analytical store enabled
#
# 3. Manage Container Provisioned Throughput
# 3.1 - Get Container provisioned throughput (RU/s)
# 3.2 - Change provisioned throughput (RU/s)
#
# 4. Get a Container by its Id property
#
# 5. List all Container resources in a Database
#
# 6. Delete Container
# ----------------------------------------------------------------------------------------------------------
# Note -
#
# Running this sample will create (and delete) multiple Containers on your 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']
DATABASE_ID = config.settings['database_id']
CONTAINER_ID = config.settings['container_id']
def find_container(db, id):
print('1. Query for Container')
containers = list(db.query_containers(
{
"query": "SELECT * FROM r WHERE r.id=@id",
"parameters": [
{ "name":"@id", "value": id }
]
}
))
if len(containers) > 0:
print('Container with id \'{0}\' was found'.format(id))
else:
print('No container with id \'{0}\' was found'. format(id))
def create_container(db, id):
""" Execute basic container creation.
This will create containers with 400 RUs with different indexing, partitioning, and storage options """
partition_key = PartitionKey(path='/id', kind='Hash')
print("\n2.1 Create Container - Basic")
try:
db.create_container(id=id, partition_key=partition_key)
print('Container with id \'{0}\' created'.format(id))
except exceptions.CosmosResourceExistsError:
print('A container with id \'{0}\' already exists'.format(id))
print("\n2.2 Create Container - With custom index policy")
try:
coll = {
"id": id+"_container_custom_index_policy",
"indexingPolicy": {
"automatic": False
}
}
container = db.create_container(
id=coll['id'],
partition_key=partition_key,
indexing_policy=coll['indexingPolicy']
)
properties = container.read()
print('Container with id \'{0}\' created'.format(container.id))
print('IndexPolicy Mode - \'{0}\''.format(properties['indexingPolicy']['indexingMode']))
print('IndexPolicy Automatic - \'{0}\''.format(properties['indexingPolicy']['automatic']))
except exceptions.CosmosResourceExistsError:
print('A container with id \'{0}\' already exists'.format(coll['id']))
print("\n2.3 Create Container - With custom provisioned throughput")
try:
container = db.create_container(
id=id+"_container_custom_throughput",
partition_key=partition_key,
offer_throughput=400
)
print('Container with id \'{0}\' created'.format(container.id))
except exceptions.CosmosResourceExistsError:
print('A container with id \'{0}\' already exists'.format(coll['id']))
print("\n2.4 Create Container - With Unique keys")
try:
container = db.create_container(
id= id+"_container_unique_keys",
partition_key=partition_key,
unique_key_policy={'uniqueKeys': [{'paths': ['/field1/field2', '/field3']}]}
)
properties = container.read()
unique_key_paths = properties['uniqueKeyPolicy']['uniqueKeys'][0]['paths']
print('Container with id \'{0}\' created'.format(container.id))
print('Unique Key Paths - \'{0}\', \'{1}\''.format(unique_key_paths[0], unique_key_paths[1]))
except exceptions.CosmosResourceExistsError:
print('A container with id \'container_unique_keys\' already exists')
print("\n2.5 Create Container - With Partition key V2 (Default)")
try:
container = db.create_container(
id=id+"_container_partition_key_v2",
partition_key=PartitionKey(path='/id', kind='Hash')
)
properties = container.read()
print('Container with id \'{0}\' created'.format(container.id))
print('Partition Key - \'{0}\''.format(properties['partitionKey']))
except exceptions.CosmosResourceExistsError:
print('A container with id \'container_partition_key_v2\' already exists')
print("\n2.6 Create Container - With Partition key V1")
try:
container = db.create_container(
id=id+"_container_partition_key_v1",
partition_key=PartitionKey(path='/id', kind='Hash', version=1)
)
properties = container.read()
print('Container with id \'{0}\' created'.format(container.id))
print('Partition Key - \'{0}\''.format(properties['partitionKey']))
except exceptions.CosmosResourceExistsError:
print('A container with id \'container_partition_key_v1\' already exists')
print("\n2.7 Create Container - With analytical store enabled")
try:
container = db.create_container(
id=id+"_container_analytical_store",
partition_key=PartitionKey(path='/id', kind='Hash'), analytical_storage_ttl=None
)
"""A value of None leaves analytical storage off and a value of -1 turns analytical storage on with no TTL.
Please note that analytical storage can only be enabled on Synapse Link enabled accounts."""
properties = container.read()
print('Container with id \'{0}\' created'.format(container.id))
print('Partition Key - \'{0}\''.format(properties['partitionKey']))
except exceptions.CosmosResourceExistsError:
print('A container with id \'_container_analytical_store\' already exists')
print("\n2.8 Create Container - With autoscale settings")
try:
container = db.create_container(
id=id+"_container_auto_scale_settings",
partition_key=partition_key,
offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=0)
)
print('Container with id \'{0}\' created'.format(container.id))
except exceptions.CosmosResourceExistsError:
print('A container with id \'{0}\' already exists'.format(coll['id']))
def manage_provisioned_throughput(db, id):
print("\n3.1 Get Container provisioned throughput (RU/s)")
#A Container's Provisioned Throughput determines the performance throughput of a container.
#A Container is loosely coupled to Offer through the Offer's offerResourceId
#Offer.offerResourceId == Container._rid
#Offer.resource == Container._self
try:
# read the container, so we can get its _self
container = db.get_container_client(container=id)
# now use its _self to query for Offers
offer = container.get_throughput()
print('Found Offer \'{0}\' for Container \'{1}\' and its throughput is \'{2}\''.format(offer.properties['id'], container.id, offer.properties['content']['offerThroughput']))
except exceptions.CosmosResourceExistsError:
print('A container with id \'{0}\' does not exist'.format(id))
print("\n3.2 Change Provisioned Throughput of Container")
#The Provisioned Throughput of a container controls the throughput allocated to the Container
#The following code shows how you can change Container's throughput
offer = container.replace_throughput(offer.offer_throughput + 100)
print('Replaced Offer. Provisioned Throughput is now \'{0}\''.format(offer.properties['content']['offerThroughput']))
def read_Container(db, id):
print("\n4. Get a Container by id")
try:
container = db.get_container_client(id)
container.read()
print('Container with id \'{0}\' was found, it\'s link is {1}'.format(container.id, container.container_link))
except exceptions.CosmosResourceNotFoundError:
print('A container with id \'{0}\' does not exist'.format(id))
def list_Containers(db):
print("\n5. List all Container in a Database")
print('Containers:')
containers = list(db.list_containers())
if not containers:
return
for container in containers:
print(container['id'])
def delete_Container(db, id):
print("\n6. Delete Container")
try:
db.delete_container(id)
print('Container with id \'{0}\' was deleted'.format(id))
except exceptions.CosmosResourceNotFoundError:
print('A container with id \'{0}\' does not exist'.format(id))
def run_sample():
client = cosmos_client.CosmosClient(HOST, {'masterKey': MASTER_KEY} )
try:
# setup database for this sample
try:
db = client.create_database(id=DATABASE_ID)
except exceptions.CosmosResourceExistsError:
db = client.get_database_client(DATABASE_ID)
# query for a container
find_container(db, CONTAINER_ID)
# create a container
create_container(db, CONTAINER_ID)
# get & change Provisioned Throughput of container
manage_provisioned_throughput(db, CONTAINER_ID)
# get a container using its id
read_Container(db, CONTAINER_ID)
# list all container on an account
list_Containers(db)
# delete container by id
delete_Container(db, CONTAINER_ID)
# cleanup database after sample
try:
client.delete_database(db)
except exceptions.CosmosResourceNotFoundError:
pass
except exceptions.CosmosHttpResponseError as e:
print('\nrun_sample has caught an error. {0}'.format(e.message))
finally:
print("\nrun_sample done")
if __name__ == '__main__':
run_sample()
|