JDBC Driver for SuiteCRM

Build 21.0.8137

Data Model

CData JDBC Driver for SuiteCRM models SuiteCRM modules as relational .

Tables

Table definitions are dynamically retrieved. The driver connects to SuiteCRM and gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your SuiteCRM account, such as adding a new table, or adding new columns, or changing the data type of a column, will immediately be reflected when you connect using the driver.

The driver can also expose custom modules on your SuiteCRM account that are not mentioned in the . You can query against these custom modules as with any other table. Additionally, you can query against custom fields of standard modules.

This section shows the sample table definitions that are included in the SuiteCRM development environment.

Collaborative Query Processing

The driver offloads as much of the SELECT statement processing as possible to SuiteCRM and then processes the rest of the query in memory; API limitations and requirements are documented in this section.

See SupportEnhancedSQL for more information on how the driver circumvents API limitations with in-memory client-side processing.

The CData JDBC Driver for SuiteCRM models your account as relational databases through two APIs, the SuiteCRM V4.1 API and the SuiteCRM V8 API. The Data Models described in this chapter provide examples of what your SuiteCRM environment might look like. The actual data model will be obtained dynamically based on your SuiteCRM account.

Key Features

  • The driver models SuiteCRM Products, Customers, Inventory, and more as relational tables, allowing you to write SQL to query SuiteCRM data.
  • Stored procedures allow you to execute operations to SuiteCRM, including downloading and uploading objects.
  • Live connectivity to these objects means any changes to your SuiteCRM account are immediately reflected when using the driver.

Collaborative Query Processing

The driver offloads as much of the SELECT statement processing as possible to SuiteCRM and then processes the rest of the query in memory. API limitations and requirements are also documented in this section.

See SupportEnhancedSQL for more information on how the driver circumvents API limitations with in-memory client-side processing.

SuiteCRM V4.1 Data Model

See SuiteCRM V4.1 Data Model for the entities available when connecting to SuiteCRM 1 instances.

SuiteCRM V8 Data Model

See SuiteCRM V8 Data Model for the entities available when connecting to SuiteCRM 2 instances.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137