Ready to get started?

Learn more about the CData JDBC Driver for Magento or download a free trial:

Download Now

Connect to Magento Data in NetBeans

Connect to Magento data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for Magento integrates connectivity to live Magento data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Magento data in NetBeans. You will create a connection and edit and save Magento data in the Table Editor.

Create a JDBC Data Source for Magento in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.magento.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.magento.MagentoDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for Magento.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify the JDBC URL.

      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 the following:

      jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH

Query Magento Data

To connect to Magento data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.