Ready to get started?

Learn more about the CData ODBC Driver for Magento or download a free trial:

Download Now

Query Magento Data in MySQL Workbench

Execute MySQL queries against live Magento data from MySQL Workbench.

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

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

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".

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Magento 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.

Query Magento from MySQL Workbench

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

Connect to Magento through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Magento).
  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 SQL Gateway for Magento).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Magento data, like SELECT * FROM `CData Magento Sys`.Products;

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