Cosmos DB

Overview

This example defines an Cosmos DB implementation for DocumentDB

{
	"cosmos_db": {
		"name": "cosmos-pepega-{env}",
		"default_consistency_level": "Session",
		"geo_redundant_locations": [
			{ "name": "northeurope", "priority": 0, "redundant": false }
		],
		"mode": "Provisioned",
		"databases": [
			{
				"name": "workge",
				"containers": [
					{
						"name": "ci-bzgdesign",
						"partition_key": "/partner_Id",
						"unique_keys": ["/skills", "/account"],
						"autoscale_throughput": { "max": 1000 },
						"indexing_policy": {
							"automatic": true,
							"included_paths": ["/*"],
							"excluded_paths": [
								"/partner_Id",
								"/skills",
								"/account"
							],
							"mode": "Consistent"
						}
					}
				]
			}
		],

		"system_managed_failover": true,
		"location": "northeurope",
		"external": false,
		"resource_group_name": "my-rg-name",
		"tags": { "example": "S0" }
	}
}

Cosmos DB Reference

DefaultConsistencyLevel

For a better understanding about the consistency levels, see this link

GeoRedundantLocations

This example defines only one location for redundancy

{
	"cosmos_db": {
		"geo_redundant_locations": [
			{ "name": "northeurope", "priority": 0, "redundant": true }
		]
	}
}

This example defines two locations for redundancy

{
	"cosmos_db": {
		"geo_redundant_locations": [
			{ "name": "northeurope", "priority": 0, "redundant": true },
			{ "name": "westeurope", "priority": 1, "redundant": false }
		]
	}
}

Mode

Databases

Containers

IndexingPolicy

Every container has an indexing policy that dictates how the container’s items should be indexed. The default indexing policy for newly created containers indexes every property of every item and enforces range indexes for any string or number. (See detailed information about indexing policies here)

ContainerMode

BoundedStaleness

SingleRegionBoundedStaleness

For a single-region account, Bounded Staleness provides the same write consistency guarantees as Session and Eventual Consistency. With Bounded Staleness, data is replicated to a local majority (three replicas in a four replica set) in the single region

This example defines only one region for the Bounded Staleness

{
	"cosmos_db": {
		"default_consistency_level": {
			"SingleRegionBoundedStaleness": {
				"max_interval": 5,
				"max_prefix": 10
			}
		},
		"geo_redundant_locations": [
			{ "name": "northeurope", "priority": 0, "redundant": true }
		]
	}
}

MultiRegionBoundedStaleness

For multi-region write accounts with two or more regions, application servers should direct reads and writes to the same region in which the application servers are hosted

This example defines two regions for the Bounded Staleness

{
	"cosmos_db": {
		"default_consistency_level": {
			"MultiRegionBoundedStaleness": {
				"max_interval": 300,
				"max_prefix": 100000
			}
		},
		"geo_redundant_locations": [
			{ "name": "northeurope", "priority": 0, "redundant": true },
			{ "name": "westeurope", "priority": 1, "redundant": true }
		]
	}
}