Replicate X-Cart Data from PowerShell

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.



Write a quick PowerShell script to query X-Cart data. Use connectivity to the live data to replicate X-Cart data to SQL Server.



The CData ODBC Driver for X-Cart enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real X-Cart data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating X-Cart data to other databases. This article shows how to replicate X-Cart data to SQL Server in 5 lines of code.

You can also write PowerShell code to download X-Cart data. See the examples below.

Create an ODBC Data Source for X-Cart

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Connect to X-Cart

The code below shows how to use the DSN to initialize the connection to X-Cart data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection $conn.ConnectionString = "DSN=CData XCart Source x64"

Back Up X-Cart Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

  • CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

  • CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

    Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open() # Create and execute the SQL Query $SQL = "CACHE DROP EXISTING SELECT * FROM " + $PROFILES $cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn) $count = $cmd.ExecuteNonQuery() $conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve X-Cart data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to X-Cart through the .NET Framework Provider for ODBC:

Retrieve X-Cart Data

$sql="SELECT ProfileId, FirstName from PROFILES" $da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { $dt.Columns | foreach ($col in dt{ Write-Host $1[$_] } }