JDBC Driver for SugarCRM

Build 24.0.9175

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
PagesizeThe maximum number of results to return per page from SugarCRM.
AggregateColumnModeControls how aggregate columns are treated by the provider.
LinkColumnsModeControls how the 'link' type columns are exposed by the provider provider.
UseDisplayNamesSet this to true to use the table and column names from the UI. By default, the provider displays the API names for tables and columns.
DisplayLanguageThe language used with the provider. This affects table names, view names and column names.
IncludeRelationshipsSet this to true if you want to expose relationship columns, which give you the ability to query objects in relation to other objects.
IncludeFiltersAsViewsSet this to true if you want to expose filters for the modules as views.
ModulesFiltersListEach SugarCRM module has named filters. This property enables you to control the list of filters that the provider exposes (as a view) for each module.
IncludeReportsSet this to true if you want to expose reports as views.
ReportModulesListIn SugarCRM, each report is built upon a specific module. This connection property enables you to control the list of reports the provider exposes as Views.
FlattenReportObjectsSpecifies whether or not to flatten the objects' data for report views.
FlattenReportsArrayDepthSpecifies the maximum depth of array elements to flatten for report views.
IncludeDeletedSpecify whether to get deleted records.
ServerSideOrderBySet this to true if you want to perform the order by operation server-side. Keep in mind that having or creating indexes results in the best query performance.
BatchSizeSpecifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit.
ConnectOnOpenSpecifies whether the provider establishes a connection to SugarCRM immediately upon opening the connection. The default value is false. Enable this property only if immediate connectivity verification is necessary.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling.
PoolMinSizeSpecifies the minimum number of connections maintained in the connection pool. The default value is 1.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. The default is 60 seconds.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
ReadonlyToggles read-only access to SugarCRM from the provider.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175