Learn more
 

Ready to get started?

Download a free trial of the Adobe Commerce ODBC Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce ODBC Driver

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

Access Adobe Commerce like you would a database - read, write, and update Customers, Inventory, Products, Orders, etc. through a standard ODBC Driver interface.

In this article

Related articles

Replicate Adobe Commerce Data from PowerShell


Write a quick PowerShell script to query Adobe Commerce data. Use connectivity to the live data to replicate Adobe Commerce data to SQL Server.



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

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

You can also write PowerShell code to execute create, read, update, and delete (CRUD) operations. See the examples below.

Create an ODBC Data Source for Adobe Commerce

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.

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce 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 Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

  • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

  • Administrator: To access Adobe Commerce 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".

Connect to Adobe Commerce

The code below shows how to use the DSN to initialize the connection to Adobe Commerce data in PowerShell:

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

Back Up Adobe Commerce 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 " + $Products $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 Adobe Commerce 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 CRUD commands to Adobe Commerce through the .NET Framework Provider for ODBC:

Retrieve Adobe Commerce Data

$sql="SELECT Name, Price from Products" $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[$_] } }

Update Adobe Commerce Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("UPDATE Products SET Style='High Tech' WHERE EntityId = @myEntityId", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myEntityId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()

Insert Adobe Commerce Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("INSERT INTO Products SET Style='High Tech' WHERE EntityId = @myEntityId", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myEntityId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()

Delete Adobe Commerce Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("DELETE FROM Products WHERE EntityId = @myid", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myEntityId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()