How to Query Cosmos DB Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Cosmos DB to query Cosmos DB data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Cosmos DB data in MySQL Workbench.

Connect to Cosmos DB Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Cosmos DB data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Cosmos DB from MySQL Workbench

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

Connect to Cosmos DB through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Cosmos DB).
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.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Cosmos DB Data

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

With access to live Cosmos DB data from MySQL Workbench, you can easily work with Cosmos DB, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Cosmos DB and the CData SQL Gateway.