Connect to X-Cart Data in IntelliJ

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with X-Cart.



Integrate connectivity to X-Cart data with wizards in IntelliJ.

The CData JDBC Driver for X-Cart enables you to access X-Cart as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to X-Cart data in IntelliJ.

Create a JBDC Data Source for X-Cart

Follow the steps below to add the driver JAR and define connection properties required to connect to X-Cart data.

  1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.
  2. In the Data Source Properties dialog that appears, the following properties are required:

    • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.xcart.jar, located in the installation directory.
    • JDBC Driver Class: In this menu, select cdata.jdbc.xcart.XCartDriver from the list.
    • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:xcart: and includes connection properties separated with semicolons.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the X-Cart JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.xcart.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is the following:

      jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;

Edit and Save X-Cart Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.