| services | platforms | author |
|---|---|---|
cosmos-db |
python |
luisbosquez |
Azure Cosmos DB is a globally distributed multi-model database. One of the supported APIs is the Graph (Gremlin) API, which provides a graph data model with Gremlin query/traversals. This sample shows you how to use the Azure Cosmos DB with the Graph API to store and access data from a Python application.
-
Before you can run this sample, you must have the following prerequisites:
- An active Azure account. If you don't have one, you can sign up for a free account.
- Python version v3.4 or newer. In order for this sample to work with Python 2.7, change all references from
input()toraw_input(). - pip package manager
- Git
- Python Driver for Gremlin
-
Then, clone this repository using
git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-python-getting-started.git -
Next, substitute the endpoint and authorization key in the
connect.py, on line 105, with your Cosmos DB account's values:
client = client.Client('wss://<YOUR_ENDPOINT>:443/','g',
username="/dbs/<YOUR_DATABASE>/colls/<YOUR_COLLECTION_OR_GRAPH>",
password="<YOUR_PASSWORD>")| Setting | Suggested Value | Description |
|---|---|---|
| YOUR_ENDPOINT | [***.graphs.azure.com] | This is the Gremlin URI value on the Overview page of the Azure portal, in square brackets, with the trailing :443/ removed. This value can also be retrieved from the Keys tab, using the URI value by removing https://, changing documents to graphs, and removing the trailing :443/. |
| port | 443 | Set the port to 443 |
| username | /dbs/<db>/colls/<coll> |
The resource of the form /dbs/<db>/colls/<coll> where <db> is your database name and <coll> is your collection name. |
| password | Your primary key | This is your primary key, which you can retrieve from the Keys page of the Azure portal, in the Primary Key box. Use the copy button on the left side of the box to copy the value. |
-
From a command prompt or shell, run
pip install -r requirements.txtto get and resolve dependencies. -
From a command prompt or shell, run
python connect.pyto run the application.
The code included in this sample is intended to get you quickly started with a Python application that connects to Azure Cosmos DB with the Graph (Gremlin) API.