Query Magento Data in ColdFusion

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Magento including Customers, Inventory, Products, Orders, and more!



Write standard ColdFusion data access code to connect to Magento data.

The CData JDBC Driver for Magento seamlessly integrates connectivity to Magento data with the rapid development tools in ColdFusion. This article shows how to connect to Magento data in ColdFusion and query Magento tables.

Create a JDBC Data Source for Magento in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:magento: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

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

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

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

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.magento.jar

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

      A typical JDBC URL is below:

      jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.magento.MagentoDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Magento data source in the Actions column. After reporting a status of OK, the Magento data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Magento, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="MagentoQuery" dataSource="CDataMagento"> SELECT * FROM Products WHERE Style = <cfqueryparam value="#Style#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#MagentoQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Products WHERE Style = ?", 
  [
    { value="High Tech", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataMagento" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Style=High Tech