Query Magento Data in MySQL Workbench

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Create a virtual MySQL database for Magento data in CData Connect (or Connect Cloud) and work with live Magento 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 Cloud), you get live access to Magento data as if it were a MySQL database. This article shows how to create a virtual database for Magento in Connect and work with live Magento data in MySQL Workbench.

Create a Virtual MySQL Database for Magento Data

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

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

    Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento 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 Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

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

    • Administrator: To access Magento 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 Test Database.
  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 Magento from MySQL Workbench.

Query Magento from MySQL Workbench

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

Connect to Magento 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 Magento Data

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

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