Query Adobe Commerce 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 Adobe Commerce data as if it were a MySQL database. This article shows how to create a virtual database for Adobe Commerce in Connect and work with live Adobe Commerce data in MySQL Workbench.

Create a Virtual MySQL Database for Adobe Commerce 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 "Adobe Commerce" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Adobe Commerce.

   Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

   You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

   • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

   • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

     If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

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 Adobe Commerce from MySQL Workbench.

Query Adobe Commerce from MySQL Workbench

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

Connect to Adobe Commerce 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 Adobe Commerce Data

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

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