Query Cosmos DB Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Cosmos DB data as if it were a MySQL database. This article shows how to create a virtual database for Cosmos DB in Connect and work with live Cosmos DB data in MySQL Workbench.

Create a Virtual MySQL Database for Cosmos DB Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Cosmos DB" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Cosmos DB.

   To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

   • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
   • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Cosmos DB from MySQL Workbench.

Query Cosmos DB from MySQL Workbench

The steps below outline connecting to the virtual Cosmos DB database in Connect from MySQL Workbench and issuing basic queries to work with live Cosmos DB data.

Connect to Cosmos DB through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Cosmos DB Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Cosmos DB data, like SELECT * FROM cosmosdbdb.Customers;

With access to live Cosmos DB data from MySQL Workbench, you can easily query and update Cosmos DB, just like you would a MySQL database. Request a demo of the CData Connect and start working with Cosmos DB just like a MySQL database today.