Ready to get started?

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

Download Now

Connect to Magento Data in DBArtisan

Use wizards in DBArtisan to configure Magento data as a data source.

The CData ODBC Driver for Magento seamlessly integrates Magento data into database management tools like DBArtisan by enabling you to access Magento data as a database. This article shows how to create an data source for Magento in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Magento Data into DBArtisan Projects

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.

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".

You can then follow the steps below to register Magento data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to Magento data. Magento entities are displayed in the Datasource Explorer.

You can now work with Magento data as you work with any other database. See the driver help documentation for more information on the queries supported by the Magento API.