JDBC Driver for Magento

Build 22.0.8462

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Magento consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.magento.MagentoDriver
  • Provide the JDBC URL. For example:
    jdbc:magento:User=admin;Password=admin;Url=https://mymagentohost/magento2
    
    or
    
    jdbc:cdata:magento:User=admin;Password=admin;Url=https://mymagentohost/magento2

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:magento:" or "jdbc:cdata:magento:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Magento 2.x

To connect, set the URL; for example, http://yoursitename/magento2, and optionally provide the StoreCode of the store you are connecting to, if more than one are present.

Authenticating to Magento

To authenticate to Magento 2.x server versions, you can use either the Basic or the Token AuthScheme.

Basic

  • AuthScheme Set this to Basic.
  • User Set this to your user name in Magento.
  • Password Set this to your password in Magento.

Access Token

  • AuthScheme Set this to Token.
  • AccessToken Set this to your AccessToken in Magento.

To generate the AccessToken, Log in to the Magento Stores > Settings > Configuration > Services > OAuth > Access Token.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462