Query X-Cart Data in MySQL Workbench

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart ODBC Driver

The X-Cart ODBC Driver is a powerful tool that allows you to connect with live data from X-Cart, directly from any applications that support ODBC connectivity.

Access X-Cart data like you would a database - read, write, and update X-Cart Orders, Products, Items, etc. through a standard ODBC Driver interface.

Execute MySQL queries against live X-Cart data from MySQL Workbench.

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

Connect to X-Cart 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.

An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

  • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
  • Search for REST API Module. Install the Module.
  • After the module has been installed, you need to set it up.
    • Go to the Settings section for the REST API Module.
    • On the settings page specify the API Key (only read)
  • Set the ApiKey and Url to the connection property to connect to data.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to X-Cart 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 X-Cart from MySQL Workbench

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

Connect to X-Cart through the SQL Gateway

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

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

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