A PostgreSQL Interface for X-Cart Data

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.



Use the Remoting features of the X-Cart JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access X-Cart data as a PostgreSQL database, use the CData JDBC Driver for X-Cart and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query X-Cart data from PostgreSQL Server.

Connect to X-Cart Data as a JDBC Data Source

To connect to X-Cart as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class: cdata.jdbc.xcart.XCartDriver

  • JDBC URL: The URL must start with "jdbc:xcart:" and can include any of the connection properties in name-value pairs 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 below:

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

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example: ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
  2. Start the build: make install USE_PGXS=1

Query X-Cart Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to X-Cart data:

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for X-Cart: CREATE SERVER XCart FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.xcart.XCartDriver', url 'jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.xcart.jar');
  4. Create a user mapping for the username and password of a user known to the MySQL daemon. CREATE USER MAPPING for postgres SERVER XCart OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE profiles ( profiles_id text, profiles_ProfileId text, profiles_FirstName numeric) SERVER XCart OPTIONS ( table_name 'profiles');
You can now execute SELECT commands to X-Cart: postgres=# SELECT * FROM profiles;