# The MIT License (MIT)
# Copyright (c) 2014 Microsoft Corporation
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Create, read, and delete databases in the Azure Cosmos DB SQL API service.
"""
from typing import Any, Dict, Iterable, List, Mapping, Optional, Union, cast
import warnings
from azure.core import MatchConditions
from azure.core.tracing.decorator import distributed_trace
from azure.core.paging import ItemPaged
from azure.core.credentials import TokenCredential
from ._cosmos_client_connection import CosmosClientConnection, CredentialDict
from ._base import build_options, _set_throughput_options
from .offer import ThroughputProperties
from ._retry_utility import ConnectionRetryPolicy
from .database import DatabaseProxy, _get_database_link
from .documents import ConnectionPolicy, DatabaseAccount
from .exceptions import CosmosResourceNotFoundError
__all__ = ("CosmosClient",)
CredentialType = Union[
TokenCredential, CredentialDict, str, Mapping[str, Any], Iterable[Mapping[str, Any]]
]
def _parse_connection_str(conn_str: str, credential: Optional[Any]) -> Dict[str, str]:
conn_str = conn_str.rstrip(";")
conn_settings = dict([s.split("=", 1) for s in conn_str.split(";")])
if 'AccountEndpoint' not in conn_settings:
raise ValueError("Connection string missing setting 'AccountEndpoint'.")
if not credential and 'AccountKey' not in conn_settings:
raise ValueError("Connection string missing setting 'AccountKey'.")
return conn_settings
def _build_auth(credential: CredentialType) -> CredentialDict:
auth: CredentialDict = {}
if isinstance(credential, str):
auth['masterKey'] = credential
elif isinstance(credential, Mapping):
if any(k for k in credential.keys() if k in ['masterKey', 'resourceTokens', 'permissionFeed']):
return cast(CredentialDict, credential) # Backwards compatible
auth['resourceTokens'] = credential
elif isinstance(credential, Iterable):
auth['permissionFeed'] = cast(Iterable[Mapping[str, Any]], credential)
elif isinstance(credential, TokenCredential):
auth['clientSecretCredential'] = credential
else:
raise TypeError(
"Unrecognized credential type. Please supply the master key as a string "
"or a dictionary, or resource tokens, or a list of permissions, or any instance of a class implementing"
" TokenCredential (see azure.identity module for specific implementations such as ClientSecretCredential).")
return auth
def _build_connection_policy(kwargs: Dict[str, Any]) -> ConnectionPolicy:
# pylint: disable=protected-access
policy = kwargs.pop('connection_policy', ConnectionPolicy())
# Connection config
# `request_timeout` is supported as a legacy parameter later replaced by `connection_timeout`
if 'request_timeout' in kwargs:
policy.RequestTimeout = kwargs.pop('request_timeout') / 1000.0
else:
policy.RequestTimeout = kwargs.pop('connection_timeout', policy.RequestTimeout)
policy.ConnectionMode = kwargs.pop('connection_mode', policy.ConnectionMode)
policy.ProxyConfiguration = kwargs.pop('proxy_config', policy.ProxyConfiguration)
policy.EnableEndpointDiscovery = kwargs.pop('enable_endpoint_discovery', policy.EnableEndpointDiscovery)
policy.PreferredLocations = kwargs.pop('preferred_locations', policy.PreferredLocations)
policy.UseMultipleWriteLocations = kwargs.pop('multiple_write_locations', policy.UseMultipleWriteLocations)
# SSL config
verify = kwargs.pop('connection_verify', None)
policy.DisableSSLVerification = not bool(verify if verify is not None else True)
ssl = kwargs.pop('ssl_config', policy.SSLConfiguration)
if ssl:
ssl.SSLCertFile = kwargs.pop('connection_cert', ssl.SSLCertFile)
ssl.SSLCaCerts = verify or ssl.SSLCaCerts
policy.SSLConfiguration = ssl
# Retry config
retry_options = kwargs.pop('retry_options', None)
if retry_options is not None:
warnings.warn(
"'retry_options' has been deprecated and will be removed from the SDK in a future release.",
DeprecationWarning
)
retry_options = policy.RetryOptions
total_retries = kwargs.pop('retry_total', None)
retry_options._max_retry_attempt_count = total_retries or retry_options._max_retry_attempt_count
retry_options._fixed_retry_interval_in_milliseconds = kwargs.pop('retry_fixed_interval', None) or \
retry_options._fixed_retry_interval_in_milliseconds
max_backoff = kwargs.pop('retry_backoff_max', None)
retry_options._max_wait_time_in_seconds = max_backoff or retry_options._max_wait_time_in_seconds
policy.RetryOptions = retry_options
connection_retry = kwargs.pop('connection_retry_policy', None)
if connection_retry is not None:
warnings.warn(
"'connection_retry_policy' has been deprecated and will be removed from the SDK in a future release.",
DeprecationWarning
)
if not connection_retry:
connection_retry = ConnectionRetryPolicy(
retry_total=total_retries,
retry_connect=kwargs.pop('retry_connect', None),
retry_read=kwargs.pop('retry_read', None),
retry_status=kwargs.pop('retry_status', None),
retry_backoff_max=max_backoff,
retry_on_status_codes=kwargs.pop('retry_on_status_codes', []),
retry_backoff_factor=kwargs.pop('retry_backoff_factor', 0.8),
)
policy.ConnectionRetryConfiguration = connection_retry
policy.ResponsePayloadOnWriteDisabled = kwargs.pop('no_response_on_write', False)
return policy
[docs]
class CosmosClient: # pylint: disable=client-accepts-api-version-keyword
"""A client-side logical representation of an Azure Cosmos DB account.
Use this client to configure and execute requests to the Azure Cosmos DB service.
It's recommended to maintain a single instance of CosmosClient per lifetime of the application which enables
efficient connection management and performance.
CosmosClient initialization is a heavy operation - don't use initialization CosmosClient instances as
credentials or network connectivity validations.
:param str url: The URL of the Cosmos DB account.
:param credential: Can be the account key, or a dictionary of resource tokens.
:type credential: Union[str, Dict[str, str], ~azure.core.credentials.TokenCredential]
:param str consistency_level: Consistency level to use for the session. The default value is None (Account level).
More on consistency levels and possible values: https://aka.ms/cosmos-consistency-levels
:keyword int timeout: An absolute timeout in seconds, for the combined HTTP request and response processing.
:keyword int connection_timeout: The HTTP request timeout in seconds.
:keyword str connection_mode: The connection mode for the client - currently only supports 'Gateway'.
:keyword proxy_config: Connection proxy configuration.
:paramtype proxy_config: ~azure.cosmos.ProxyConfiguration
:keyword ssl_config: Connection SSL configuration.
:paramtype ssl_config: ~azure.cosmos.SSLConfiguration
:keyword bool connection_verify: Whether to verify the connection, default value is True.
:keyword str connection_cert: An alternative certificate to verify the connection.
:keyword int retry_total: Maximum retry attempts.
:keyword int retry_backoff_max: Maximum retry wait time in seconds.
:keyword int retry_fixed_interval: Fixed retry interval in milliseconds.
:keyword int retry_read: Maximum number of socket read retry attempts.
:keyword int retry_connect: Maximum number of connection error retry attempts.
:keyword int retry_status: Maximum number of retry attempts on error status codes.
:keyword list[int] retry_on_status_codes: A list of specific status codes to retry on.
:keyword float retry_backoff_factor: Factor to calculate wait time between retry attempts.
:keyword bool enable_endpoint_discovery: Enable endpoint discovery for
geo-replicated database accounts. (Default: True)
:keyword list[str] preferred_locations: The preferred locations for geo-replicated database accounts.
:keyword bool enable_diagnostics_logging: Enable the CosmosHttpLogging policy.
Must be used along with a logger to work.
:keyword ~logging.Logger logger: Logger to be used for collecting request diagnostics. Can be passed in at client
level (to log all requests) or at a single request level. Requests will be logged at INFO level.
:keyword bool no_response_on_write: Indicates whether service should be instructed to skip sending
response payloads on rite operations for items.
.. admonition:: Example:
.. literalinclude:: ../samples/examples.py
:start-after: [START create_client]
:end-before: [END create_client]
:language: python
:dedent: 0
:caption: Create a new instance of the Cosmos DB client:
"""
def __init__(
self,
url: str,
credential: Union[TokenCredential, str, Dict[str, Any]],
consistency_level: Optional[str] = None,
**kwargs
) -> None:
"""Instantiate a new CosmosClient."""
auth = _build_auth(credential)
connection_policy = _build_connection_policy(kwargs)
self.client_connection = CosmosClientConnection(
url, auth=auth, consistency_level=consistency_level, connection_policy=connection_policy, **kwargs
)
def __repr__(self) -> str:
return "<CosmosClient [{}]>".format(self.client_connection.url_connection)[:1024]
def __enter__(self):
self.client_connection.pipeline_client.__enter__()
return self
def __exit__(self, *args):
return self.client_connection.pipeline_client.__exit__(*args)
[docs]
@classmethod
def from_connection_string(
cls,
conn_str: str,
credential: Optional[Union[TokenCredential, str, Dict[str, Any]]] = None,
consistency_level: Optional[str] = None,
**kwargs
) -> 'CosmosClient':
"""Create a CosmosClient instance from a connection string.
This can be retrieved from the Azure portal.For full list of optional
keyword arguments, see the CosmosClient constructor.
:param str conn_str: The connection string.
:param credential: Alternative credentials to use instead of the key
provided in the connection string.
:type credential: Union[str, Dict[str, str]]
:param str consistency_level:
Consistency level to use for the session. The default value is None (Account level).
:returns: A CosmosClient instance representing the new client.
:rtype: ~azure.cosmos.CosmosClient
"""
settings = _parse_connection_str(conn_str, credential)
return cls(
url=settings['AccountEndpoint'],
credential=credential or settings['AccountKey'],
consistency_level=consistency_level,
**kwargs
)
[docs]
@distributed_trace
def create_database( # pylint:disable=docstring-missing-param
self,
id: str,
populate_query_metrics: Optional[bool] = None,
offer_throughput: Optional[Union[int, ThroughputProperties]] = None,
*,
session_token: Optional[str] = None,
initial_headers: Optional[Dict[str, str]] = None,
etag: Optional[str] = None,
match_condition: Optional[MatchConditions] = None,
**kwargs: Any
) -> DatabaseProxy:
"""
Create a new database with the given ID (name).
:param str id: ID (name) of the database to create.
:param offer_throughput: The provisioned throughput for this offer.
:type offer_throughput: Union[int, ~azure.cosmos.ThroughputProperties]
:keyword str session_token: Token for use with Session consistency.
:keyword Dict[str, str] initial_headers: Initial headers to be sent as part of the request.
:keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource
has changed, and act according to the condition specified by the `match_condition` parameter.
:keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag.
:keyword Callable response_hook: A callable invoked with the response metadata.
:returns: A DatabaseProxy instance representing the new database.
:rtype: ~azure.cosmos.DatabaseProxy
:raises ~azure.cosmos.exceptions.CosmosResourceExistsError: Database with the given ID already exists.
.. admonition:: Example:
.. literalinclude:: ../samples/examples.py
:start-after: [START create_database]
:end-before: [END create_database]
:language: python
:dedent: 0
:caption: Create a database in the Cosmos DB account:
"""
response_hook = kwargs.pop('response_hook', None)
if session_token is not None:
kwargs["session_token"] = session_token
if initial_headers is not None:
kwargs["initial_headers"] = initial_headers
if etag is not None:
kwargs["etag"] = etag
if match_condition is not None:
kwargs["match_condition"] = match_condition
request_options = build_options(kwargs)
if populate_query_metrics is not None:
warnings.warn(
"the populate_query_metrics flag does not apply to this method and will be removed in the future",
UserWarning,
)
request_options["populateQueryMetrics"] = populate_query_metrics
_set_throughput_options(offer=offer_throughput, request_options=request_options)
result = self.client_connection.CreateDatabase(database={"id": id}, options=request_options, **kwargs)
if response_hook:
response_hook(self.client_connection.last_response_headers)
return DatabaseProxy(self.client_connection, id=result["id"], properties=result)
[docs]
@distributed_trace
def create_database_if_not_exists( # pylint:disable=docstring-missing-param
self,
id: str,
populate_query_metrics: Optional[bool] = None,
offer_throughput: Optional[Union[int, ThroughputProperties]] = None,
*,
session_token: Optional[str] = None,
initial_headers: Optional[Dict[str, str]] = None,
etag: Optional[str] = None,
match_condition: Optional[MatchConditions] = None,
**kwargs: Any
) -> DatabaseProxy:
"""
Create the database if it does not exist already.
If the database already exists, the existing settings are returned.
..note::
This function does not check or update existing database settings or
offer throughput if they differ from what is passed in.
:param str id: ID (name) of the database to read or create.
:param bool populate_query_metrics: Enable returning query metrics in response headers.
:param offer_throughput: The provisioned throughput for this offer.
:type offer_throughput: Union[int, ~azure.cosmos.ThroughputProperties]
:keyword str session_token: Token for use with Session consistency.
:keyword Dict[str, str] initial_headers: Initial headers to be sent as part of the request.
:keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource
has changed, and act according to the condition specified by the `match_condition` parameter.
:keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag.
:keyword Callable response_hook: A callable invoked with the response metadata.
:returns: A DatabaseProxy instance representing the database.
:rtype: ~azure.cosmos.DatabaseProxy
:raises ~azure.cosmos.exceptions.CosmosHttpResponseError: The database read or creation failed.
"""
if session_token is not None:
kwargs["session_token"] = session_token
if initial_headers is not None:
kwargs["initial_headers"] = initial_headers
if etag is not None:
kwargs["etag"] = etag
if match_condition is not None:
kwargs["match_condition"] = match_condition
try:
database_proxy = self.get_database_client(id)
database_proxy.read(
populate_query_metrics=populate_query_metrics,
**kwargs
)
return database_proxy
except CosmosResourceNotFoundError:
return self.create_database(
id,
populate_query_metrics=populate_query_metrics,
offer_throughput=offer_throughput,
**kwargs
)
[docs]
def get_database_client(self, database: Union[str, DatabaseProxy, Mapping[str, Any]]) -> DatabaseProxy:
"""Retrieve an existing database with the ID (name) `id`.
:param database: The ID (name), dict representing the properties or
`DatabaseProxy` instance of the database to read.
:type database: str or dict(str, str) or ~azure.cosmos.DatabaseProxy
:returns: A `DatabaseProxy` instance representing the retrieved database.
:rtype: ~azure.cosmos.DatabaseProxy
"""
if isinstance(database, DatabaseProxy):
id_value = database.id
elif isinstance(database, str):
id_value = database
else:
id_value = database["id"]
return DatabaseProxy(self.client_connection, id_value)
[docs]
@distributed_trace
def list_databases( # pylint:disable=docstring-missing-param
self,
max_item_count: Optional[int] = None,
populate_query_metrics: Optional[bool] = None,
*,
session_token: Optional[str] = None,
initial_headers: Optional[Dict[str, str]] = None,
**kwargs: Any
) -> ItemPaged[Dict[str, Any]]:
"""List the databases in a Cosmos DB SQL database account.
:param int max_item_count: Max number of items to be returned in the enumeration operation.
:keyword str session_token: Token for use with Session consistency.
:keyword Dict[str, str] initial_headers: Initial headers to be sent as part of the request.
:keyword Callable response_hook: A callable invoked with the response metadata.
:returns: An Iterable of database properties (dicts).
:rtype: Iterable[Dict[str, str]]
"""
response_hook = kwargs.pop('response_hook', None)
if session_token is not None:
kwargs["session_token"] = session_token
if initial_headers is not None:
kwargs["initial_headers"] = initial_headers
feed_options = build_options(kwargs)
if max_item_count is not None:
feed_options["maxItemCount"] = max_item_count
if populate_query_metrics is not None:
warnings.warn(
"the populate_query_metrics flag does not apply to this method and will be removed in the future",
UserWarning,
)
feed_options["populateQueryMetrics"] = populate_query_metrics
result = self.client_connection.ReadDatabases(options=feed_options, **kwargs)
if response_hook:
response_hook(self.client_connection.last_response_headers)
return result
[docs]
@distributed_trace
def query_databases( # pylint:disable=docstring-missing-param
self,
query: Optional[str] = None,
parameters: Optional[List[Dict[str, Any]]] = None,
enable_cross_partition_query: Optional[bool] = None,
max_item_count: Optional[int] = None,
populate_query_metrics: Optional[bool] = None,
*,
session_token: Optional[str] = None,
initial_headers: Optional[Dict[str, str]] = None,
**kwargs: Any
) -> ItemPaged[Dict[str, Any]]:
"""Query the databases in a Cosmos DB SQL database account.
:param str query: The Azure Cosmos DB SQL query to execute.
:param List[Dict[str, Any]] parameters: Optional array of parameters to the query.
Ignored if no query is provided.
:param bool enable_cross_partition_query: Allow scan on the queries which couldn't be
served as indexing was opted out on the requested paths.
:param int max_item_count: Max number of items to be returned in the enumeration operation.
:keyword str session_token: Token for use with Session consistency.
:keyword Dict[str, str] initial_headers: Initial headers to be sent as part of the request.
:keyword Callable response_hook: A callable invoked with the response metadata.
:returns: An Iterable of database properties (dicts).
:rtype: Iterable[Dict[str, str]]
"""
response_hook = kwargs.pop('response_hook', None)
if session_token is not None:
kwargs["session_token"] = session_token
if initial_headers is not None:
kwargs["initial_headers"] = initial_headers
feed_options = build_options(kwargs)
if enable_cross_partition_query is not None:
feed_options["enableCrossPartitionQuery"] = enable_cross_partition_query
if max_item_count is not None:
feed_options["maxItemCount"] = max_item_count
if populate_query_metrics is not None:
warnings.warn(
"the populate_query_metrics flag does not apply to this method and will be removed in the future",
UserWarning,
)
feed_options["populateQueryMetrics"] = populate_query_metrics
if query:
# This is currently eagerly evaluated in order to capture the headers
# from the call.
# (just returning a generator did not initiate the first network call, so
# the headers were misleading)
# This needs to change for "real" implementation
result = self.client_connection.QueryDatabases(
query=query if parameters is None else {'query': query, 'parameters': parameters},
options=feed_options,
**kwargs
)
else:
result = self.client_connection.ReadDatabases(options=feed_options, **kwargs)
if response_hook:
response_hook(self.client_connection.last_response_headers)
return result
[docs]
@distributed_trace
def delete_database( # pylint:disable=docstring-missing-param
self,
database: Union[str, DatabaseProxy, Mapping[str, Any]],
populate_query_metrics: Optional[bool] = None,
*,
session_token: Optional[str] = None,
initial_headers: Optional[Dict[str, str]] = None,
etag: Optional[str] = None,
match_condition: Optional[MatchConditions] = None,
**kwargs: Any
) -> None:
"""Delete the database with the given ID (name).
:param database: The ID (name), dict representing the properties or :class:`DatabaseProxy`
instance of the database to delete.
:type database: Union[str, Dict[str, str], ~azure.cosmos.DatabaseProxy]
:keyword str session_token: Token for use with Session consistency.
:keyword Dict[str, str] initial_headers: Initial headers to be sent as part of the request.
:keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource
has changed, and act according to the condition specified by the `match_condition` parameter.
:keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag.
:keyword Callable response_hook: A callable invoked with the response metadata.
:raises ~azure.cosmos.exceptions.CosmosHttpResponseError: If the database couldn't be deleted.
:rtype: None
"""
response_hook = kwargs.pop('response_hook', None)
if session_token is not None:
kwargs["session_token"] = session_token
if initial_headers is not None:
kwargs["initial_headers"] = initial_headers
if etag is not None:
kwargs["etag"] = etag
if match_condition is not None:
kwargs["match_condition"] = match_condition
request_options = build_options(kwargs)
if populate_query_metrics is not None:
warnings.warn(
"the populate_query_metrics flag does not apply to this method and will be removed in the future",
UserWarning,
)
request_options["populateQueryMetrics"] = populate_query_metrics
database_link = _get_database_link(database)
self.client_connection.DeleteDatabase(database_link, options=request_options, **kwargs)
if response_hook:
response_hook(self.client_connection.last_response_headers)
[docs]
@distributed_trace
def get_database_account(self, **kwargs) -> DatabaseAccount:
"""Retrieve the database account information.
:keyword Callable response_hook: A callable invoked with the response metadata.
:returns: A `DatabaseAccount` instance representing the Cosmos DB Database Account.
:rtype: ~azure.cosmos.DatabaseAccount
"""
response_hook = kwargs.pop('response_hook', None)
result = self.client_connection.GetDatabaseAccount(**kwargs)
if response_hook:
response_hook(self.client_connection.last_response_headers)
return result