Connect to Sugar CRM Data in DBeaver

The CData ODBC Driver for Sugar enables access to live data from Sugar CRM under the ODBC standard, allowing you work with Sugar CRM data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Sugar CRM data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Sugar CRM data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to Sugar CRM, the driver pushes supported SQL operations, like filters and aggregations, directly to Sugar CRM and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze Sugar CRM data.

Connect to Sugar CRM

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

Connecting to the Sugar CRM ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
   
2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
   
3. In the Database/Schema field, enter the DSN name (CData Sugar CRM Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful. 👁 Successfully tested connection
   

Query Sugar CRM Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

Free Trial & More Information

At this point, you have connected to live Sugar CRM data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Sugar CRM data DBeaver today.