Metadata-Version: 2.1
Name: azure-cosmos
Version: 4.0.0b2
Summary: Microsoft Azure Cosmos Client Library for Python
Home-page: https://github.com/Azure/azure-sdk-for-python
Author: Microsoft Corporation
Author-email: askdocdb@microsoft.com
Maintainer: Microsoft
Maintainer-email: askdocdb@microsoft.com
License: MIT License
Description: # Azure Cosmos DB SQL API client library for Python
        
        Azure Cosmos DB is a globally distributed, multi-model database service that supports document, key-value, wide-column, and graph databases.
        
        Use the Azure Cosmos DB SQL API SDK for Python to manage databases and the JSON documents they contain in this NoSQL database service.
        
        * Create Cosmos DB **databases** and modify their settings
        * Create and modify **containers** to store collections of JSON documents
        * Create, read, update, and delete the **items** (JSON documents) in your containers
        * Query the documents in your database using **SQL-like syntax**
        
        Looking for source code or API reference?
        
        * [SDK source code][source_code]
        * [SDK reference documentation][ref_cosmos_sdk]
        
        ## Getting started
        
        * Azure subscription - [Create a free account][azure_sub]
        * Azure [Cosmos DB account][cosmos_account] - SQL API
        * [Python 2.7 or 3.5.3+][python]
        
        
        If you need a Cosmos DB SQL API account, you can create one with this [Azure CLI][azure_cli] command:
        
        ```Bash
        az cosmosdb create --resource-group <resource-group-name> --name <cosmos-account-name>
        ```
        
        ## Installation
        
        ```bash
        pip install --pre azure-cosmos
        ```
        
        ### Configure a virtual environment (optional)
        
        Although not required, you can keep your your base system and Azure SDK environments isolated from one another if you use a virtual environment. Execute the following commands to configure and then enter a virtual environment with [venv][venv]:
        
        ```Bash
        python3 -m venv azure-cosmosdb-sdk-environment
        source azure-cosmosdb-sdk-environment/bin/activate
        ```
        
        ## Key concepts
        
        Interaction with Cosmos DB starts with an instance of the [CosmosClient][ref_cosmosclient] class. You need an **account**, its **URI**, and one of its **account keys** to instantiate the client object.
        
        ### Get credentials
        
        Use the Azure CLI snippet below to populate two environment variables with the database account URI and its primary master key (you can also find these values in the Azure portal). The snippet is formatted for the Bash shell.
        
        ```Bash
        RES_GROUP=<resource-group-name>
        ACCT_NAME=<cosmos-db-account-name>
        
        export ACCOUNT_URI=$(az cosmosdb show --resource-group $RES_GROUP --name $ACCT_NAME --query documentEndpoint --output tsv)
        export ACCOUNT_KEY=$(az cosmosdb list-keys --resource-group $RES_GROUP --name $ACCT_NAME --query primaryMasterKey --output tsv)
        ```
        
        ### Create client
        
        Once you've populated the `ACCOUNT_URI` and `ACCOUNT_KEY` environment variables, you can create the [CosmosClient][ref_cosmosclient].
        
        ```Python
        from azure.cosmos import CosmosClient, Container, Database, PartitionKey, errors
        
        import os
        url = os.environ['ACCOUNT_URI']
        key = os.environ['ACCOUNT_KEY']
        client = CosmosClient(url, credential=key)
        ```
        
        ## Usage
        
        Once you've initialized a [CosmosClient][ref_cosmosclient], you can interact with the primary resource types in Cosmos DB:
        
        * [Database][ref_database]: A Cosmos DB account can contain multiple databases. When you create a database, you specify the API you'd like to use when interacting with its documents: SQL, MongoDB, Gremlin, Cassandra, or Azure Table. Use the [DatabaseProxy][ref_database] object to manage its containers.
        
        * [Container][ref_container]: A container is a collection of JSON documents. You create (insert), read, update, and delete items in a container by using methods on the [ContainerProxy][ref_container] object.
        
        * Item: An Item is the dictionary-like representation of a JSON document stored in a container. Each Item you add to a container must include an `id` key with a value that uniquely identifies the item within the container.
        
        For more information about these resources, see [Working with Azure Cosmos databases, containers and items][cosmos_resources].
        
        ## Examples
        
        The following sections provide several code snippets covering some of the most common Cosmos DB tasks, including:
        
        * [Create a database](#create-a-database)
        * [Create a container](#create-a-container)
        * [Get an existing container](#get-an-existing-container)
        * [Insert data](#insert-data)
        * [Delete data](#delete-data)
        * [Query the database](#query-the-database)
        * [Get database properties](#get-database-properties)
        * [Modify container properties](#modify-container-properties)
        
        ### Create a database
        
        After authenticating your [CosmosClient][ref_cosmosclient], you can work with any resource in the account. The code snippet below creates a SQL API database, which is the default when no API is specified when [create_database][ref_cosmosclient_create_database] is invoked.
        
        ```Python
        database_name = 'testDatabase'
        try:
            database = client.create_database(database_name)
        except errors.CosmosResourceExistsError:
            database = client.get_database_client(database_name)
        ```
        
        ### Create a container
        
        This example creates a container with default settings. If a container with the same name already exists in the database (generating a `409 Conflict` error), the existing container is obtained instead.
        
        ```Python
        container_name = 'products'
        try:
            container = database.create_container(id=container_name, partition_key=PartitionKey(path="/productName"))
        except errors.CosmosResourceExistsError:
            container = database.get_container_client(container_name)
        except errors.CosmosHttpResponseError:
            raise
        ```
        
        The preceding snippet also handles the [CosmosHttpResponseError][ref_httpfailure] exception if the container creation failed. For more information on error handling and troubleshooting, see the [Troubleshooting](#troubleshooting) section.
        
        ### Get an existing container
        
        Retrieve an existing container from the database:
        
        ```Python
        database = client.get_database_client(database_name)
        container = database.get_container_client(container_name)
        ```
        
        ### Insert data
        
        To insert items into a container, pass a dictionary containing your data to [ContainerProxy.upsert_item][ref_container_upsert_item]. Each item you add to a container must include an `id` key with a value that uniquely identifies the item within the container.
        
        This example inserts several items into the container, each with a unique `id`:
        
        ```Python
        database_client = client.get_database_client(database_name)
        container_client = database.get_container_client(container_name)
        
        for i in range(1, 10):
            container_client.upsert_item({
                    'id': 'item{0}'.format(i),
                    'productName': 'Widget',
                    'productModel': 'Model {0}'.format(i)
                }
            )
        ```
        
        ### Delete data
        
        To delete items from a container, use [ContainerProxy.delete_item][ref_container_delete_item]. The SQL API in Cosmos DB does not support the SQL `DELETE` statement.
        
        ```Python
        for item in container.query_items(query='SELECT * FROM products p WHERE p.productModel = "DISCONTINUED"',
                                          enable_cross_partition_query=True):
            container.delete_item(item, partition_key='Pager')
        ```
        
        ### Query the database
        
        A Cosmos DB SQL API database supports querying the items in a container with [ContainerProxy.query_items][ref_container_query_items] using SQL-like syntax.
        
        This example queries a container for items with a specific `id`:
        
        ```Python
        database = client.get_database_client(database_name)
        container = database.get_container_client(container_name)
        
        # Enumerate the returned items
        import json
        for item in container.query_items(
                        query='SELECT * FROM mycontainer r WHERE r.id="item3"',
                        enable_cross_partition_query=True):
            print(json.dumps(item, indent=True))
        ```
        
        > NOTE: Although you can specify any value for the container name in the `FROM` clause, we recommend you use the container name for consistency.
        
        Perform parameterized queries by passing a dictionary containing the parameters and their values to [ContainerProxy.query_items][ref_container_query_items]:
        
        ```Python
        discontinued_items = container.query_items(
            query='SELECT * FROM products p WHERE p.productModel = @model',
            parameters=[
                dict(name='@model', value='Model 7')
            ],
            enable_cross_partition_query=True
        )
        for item in discontinued_items:
            print(json.dumps(item, indent=True))
        ```
        
        For more information on querying Cosmos DB databases using the SQL API, see [Query Azure Cosmos DB data with SQL queries][cosmos_sql_queries].
        
        ### Get database properties
        
        Get and display the properties of a database:
        
        ```Python
        database = client.get_database_client(database_name)
        properties = database.read()
        print(json.dumps(properties))
        ```
        
        ### Modify container properties
        
        Certain properties of an existing container can be modified. This example sets the default time to live (TTL) for items in the container to 10 seconds:
        
        ```Python
        database = client.get_database_client(database_name)
        container = database.get_container_client(container_name)
        database.replace_container(container,
                                   partition_key=PartitionKey(path="/productName"),
                                   default_ttl=10,
                                   )
        # Display the new TTL setting for the container
        container_props = container.read()
        print(json.dumps(container_props['defaultTtl']))
        ```
        
        For more information on TTL, see [Time to Live for Azure Cosmos DB data][cosmos_ttl].
        
        ## Troubleshooting
        
        ### General
        
        When you interact with Cosmos DB using the Python SDK, errors returned by the service correspond to the same HTTP status codes returned for REST API requests:
        
        [HTTP Status Codes for Azure Cosmos DB][cosmos_http_status_codes]
        
        For example, if you try to create a container using an ID (name) that's already in use in your Cosmos DB database, a `409` error is returned, indicating the conflict. In the following snippet, the error is handled gracefully by catching the exception and displaying additional information about the error.
        
        ```Python
        try:
            database.create_container(id=container_name, partition_key=PartitionKey(path="/productName")
        except errors.CosmosResourceExistsError:
            print("""Error creating container
        HTTP status code 409: The ID (name) provided for the container is already in use.
        The container name must be unique within the database.""")
        
        ```
        
        ## More sample code
        
        Coming soon...
        
        ## Next steps
        
        For more extensive documentation on the Cosmos DB service, see the [Azure Cosmos DB documentation][cosmos_docs] on docs.microsoft.com.
        
        <!-- LINKS -->
        [azure_cli]: https://docs.microsoft.com/cli/azure
        [azure_portal]: https://portal.azure.com
        [azure_sub]: https://azure.microsoft.com/free/
        [cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview
        [cosmos_account_create]: https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account
        [cosmos_account]: https://docs.microsoft.com/azure/cosmos-db/account-overview
        [cosmos_container]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-containers
        [cosmos_database]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-databases
        [cosmos_docs]: https://docs.microsoft.com/azure/cosmos-db/
        [cosmos_http_status_codes]: https://docs.microsoft.com/rest/api/cosmos-db/http-status-codes-for-cosmosdb
        [cosmos_item]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-items
        [cosmos_request_units]: https://docs.microsoft.com/azure/cosmos-db/request-units
        [cosmos_resources]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items
        [cosmos_sql_queries]: https://docs.microsoft.com/azure/cosmos-db/how-to-sql-query
        [cosmos_ttl]: https://docs.microsoft.com/azure/cosmos-db/time-to-live
        [python]: https://www.python.org/downloads/
        [ref_container_delete_item]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.container.html#azure.cosmos.container.ContainerProxy.delete_item
        [ref_container_query_items]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.container.html#azure.cosmos.container.ContainerProxy.query_items
        [ref_container_upsert_item]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.container.html#azure.cosmos.container.ContainerProxy.upsert_item
        [ref_container]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.container.html
        [ref_cosmos_sdk]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.html
        [ref_cosmosclient_create_database]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.cosmos_client.html#azure.cosmos.cosmos_client.CosmosClient.create_database
        [ref_cosmosclient]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.cosmos_client.html
        [ref_database]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.database.html
        [ref_httpfailure]: https://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.errors.html#azure.cosmos.errors.CosmosHttpResponseError
        [sample_database_mgmt]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/DatabaseManagement
        [sample_document_mgmt]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/DocumentManagement
        [sample_examples_misc]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/examples.py
        [source_code]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos
        [venv]: https://docs.python.org/3/library/venv.html
        [virtualenv]: https://virtualenv.pypa.io
        
        
        # Contributing
        
        This project welcomes contributions and suggestions.  Most contributions require you to agree to a
        Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
        the rights to use your contribution. For details, visit https://cla.microsoft.com.
        
        When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
        a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
        provided by the bot. You will only need to do this once across all repos using our CLA.
        
        This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
        For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
        contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
        
        # Change Log azure-cosmos
        
        ## Version 4.0.0b2:
        
        Version 4.0.0b2 is the second iteration in our efforts to build a more Pythonic client library.
        
        **Breaking changes**
        
        - The client connection has been adapted to consume the HTTP pipeline defined in `azure.core.pipeline`.
        - Interactive objects have now been renamed as proxies. This includes:
            - `Database` -> `DatabaseProxy`
            - `User` -> `UserProxy`
            - `Container` -> `ContainerProxy`
            - `Scripts` -> `ScriptsProxy`
        - The constructor of `CosmosClient` has been updated:
            - The `auth` parameter has been renamed to `credential` and will now take an authentication type directly. This means the master key value, a dictionary of resource tokens, or a list of permissions can be passed in. However the old dictionary format is still supported.
            - The `connection_policy` parameter has been made a keyword only parameter, and while it is still supported, each of the individual attributes of the policy can now be passed in as explicit keyword arguments:
                - `request_timeout`
                - `media_request_timeout`
                - `connection_mode`
                - `media_read_mode`
                - `proxy_config`
                - `enable_endpoint_discovery`
                - `preferred_locations`
                - `multiple_write_locations`
        - A new classmethod constructor has been added to `CosmosClient` to enable creation via a connection string retrieved from the Azure portal.
        - Some `read_all` operations have been renamed to `list` operations:
            - `CosmosClient.read_all_databases` -> `CosmosClient.list_databases`
            - `Container.read_all_conflicts` -> `ContainerProxy.list_conflicts`
            - `Database.read_all_containers` -> `DatabaseProxy.list_containers`
            - `Database.read_all_users` -> `DatabaseProxy.list_users`
            - `User.read_all_permissions` -> `UserProxy.list_permissions`
        - All operations that take `request_options` or `feed_options` parameters, these have been moved to keyword only parameters. In addition, while these options dictionaries are still supported, each of the individual options within the dictionary are now supported as explicit keyword arguments.
        - The error heirarchy is now inherited from `azure.core.AzureError` instead of `CosmosError` which has been removed.
            - `HTTPFailure` has been renamed to `CosmosHttpResponseError`
            - `JSONParseFailure` has been removed and replaced by `azure.core.DecodeError`
            - Added additional errors for specific response codes:
                - `CosmosResourceNotFoundError` for status 404
                - `CosmosResourceExistsError` for status 409
                - `CosmosAccessConditionFailedError` for status 412
        - `CosmosClient` can now be run in a context manager to handle closing the client connection.
        - Iterable responses (e.g. query responses and list responses) are now of type `azure.core.paging.ItemPaged`. The method `fetch_next_block` has been replaced by a secondary iterator, accessed by the `by_page` method.
        
        ## Version 4.0.0b1:
        
        Version 4.0.0b1 is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Cosmos. For more information about this, and preview releases of other Azure SDK libraries, please visit https://aka.ms/azure-sdk-preview1-python.
        
        **Breaking changes: New API design**
        
        - Operations are now scoped to a particular client:
            - `CosmosClient`: This client handles account-level operations. This includes managing service properties and listing the databases within an account.
            - `Database`: This client handles database-level operations. This includes creating and deleting containers, users and stored procedurs. It can be accessed from a `CosmosClient` instance by name.
            - `Container`: This client handles operations for a particular container. This includes querying and inserting items and managing properties.
            - `User`: This client handles operations for a particular user. This includes adding and deleting permissions and managing user properties.
            
            These clients can be accessed by navigating down the client hierarchy using the `get_<child>_client` method. For full details on the new API, please see the [reference documentation](http://azure.github.io/azure-sdk-for-python/ref/azure.cosmos.html).
        - Clients are accessed by name rather than by Id. No need to concatenate strings to create links.
        - No more need to import types and methods from individual modules. The public API surface area is available directly in the `azure.cosmos` package.
        - Individual request properties can be provided as keyword arguments rather than constructing a separate `RequestOptions` instance.
        
        ## Changes in 3.0.2 : ##
        
        - Added Support for MultiPolygon Datatype
        - Bug Fix in Session Read Retry Policy
        - Bug Fix for Incorrect padding issues while decoding base 64 strings
        
        ## Changes in 3.0.1 : ##
        
        - Bug fix in LocationCache
        - Bug fix endpoint retry logic
        - Fixed documentation
        
        ## Changes in 3.0.0 : ##
        
        - Multi-region write support added
        - Naming changes
          - DocumentClient to CosmosClient
          - Collection to Container
          - Document to Item
          - Package name updated to "azure-cosmos"
          - Namespace updated to "azure.cosmos"
        
        ## Changes in 2.3.3 : ##
        
        - Added support for proxy
        - Added support for reading change feed
        - Added support for collection quota headers
        - Bugfix for large session tokens issue
        - Bugfix for ReadMedia API
        - Bugfix in partition key range cache
        
        ## Changes in 2.3.2 : ##
        
        - Added support for default retries on connection issues.
        
        ## Changes in 2.3.1 : ##
        
        - Updated documentation to reference Azure Cosmos DB instead of Azure DocumentDB.
        
        ## Changes in 2.3.0 : ##
        
        - This SDK version requires the latest version of Azure Cosmos DB Emulator available for download from https://aka.ms/cosmosdb-emulator.
        
        ## Changes in 2.2.1 : ##
        
        - bugfix for aggregate dict
        - bugfix for trimming slashes in the resource link
        - tests for unicode encoding
        
        ## Changes in 2.2.0 : ##
        
        - Added support for Request Unit per Minute (RU/m) feature.
        - Added support for a new consistency level called ConsistentPrefix.
        
        ## Changes in 2.1.0 : ##
        
        - Added support for aggregation queries (COUNT, MIN, MAX, SUM, and AVG).
        - Added an option for disabling SSL verification when running against DocumentDB Emulator.
        - Removed the restriction of dependent requests module to be exactly 2.10.0.
        - Lowered minimum throughput on partitioned collections from 10,100 RU/s to 2500 RU/s.
        - Added support for enabling script logging during stored procedure execution.
        - REST API version bumped to '2017-01-19' with this release.
        
        ## Changes in 2.0.1 : ##
        
        - Made editorial changes to documentation comments.
        
        ## Changes in 2.0.0 : ##
        
        - Added support for Python 3.5.
        - Added support for connection pooling using the requests module.
        - Added support for session consistency.
        - Added support for TOP/ORDERBY queries for partitioned collections.
        
        ## Changes in 1.9.0 : ##
        
        - Added retry policy support for throttled requests. (Throttled requests receive a request rate too large exception, error code 429.)
          By default, DocumentDB 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.
          DocumentDB 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 overriden in the RetryOptions property on ConnectionPolicy object.
        
        - DocumentDB 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 cummulative time the request waited between the retries.
        
        - 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.
        
        ## Changes in 1.8.0 : ##
        
        - Added the support for geo-replicated database accounts.
        - Test fixes to move the global host and masterKey into the individual test classes.
        
        ## Changes in 1.7.0 : ##
        
        - Added the support for Time To Live(TTL) feature for documents.
        
        ## Changes in 1.6.1 : ##
        
        - Bug fixes related to server side partitioning to allow special characters in partitionkey path.
        
        ## Changes in 1.6.0 : ##
        
        - Added the support for server side partitioned collections feature.
        
        ## Changes in 1.5.0 : ##
        
        - Added Client-side sharding framework to the SDK. Implemented HashPartionResolver and RangePartitionResolver classes.
        
        ## Changes in 1.4.2 : ##
        
        - Implement Upsert. New UpsertXXX methods added to support Upsert feature.
        - Implement ID Based Routing. No public API changes, all changes internal.
        
        ## Changes in 1.3.0 : ##
        
        - Release skipped to bring version number in alignment with other SDKs
        
        ## Changes in 1.2.0 : ##
        
        - Supports GeoSpatial index.
        - Validates id property for all resources. Ids for resources cannot contain ?, /, #, \\, characters or end with a space.
        - Adds new header "index transformation progress" to ResourceResponse.
        
        ## Changes in 1.1.0 : ##
        
        - Implements V2 indexing policy
        
        ## Changes in 1.0.1 : ##
        
        - Supports proxy connection
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
