ODBC Driver for SugarCRM

Build 26.0.9655

Miscellaneous

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


PropertyDescription
PagesizeThe maximum number of results to return per page from SugarCRM.
AggregateColumnModeControls how aggregate columns are treated by the provider.
UseDisplayNamesSpecifies whether the provider uses display names from the SugarCRM UI instead of API names for tables and columns.
DisplayLanguageThe language used with the provider. This affects table names, view names, and column names.
IncludeRelationshipsSpecifies whether the provider exposes relationship columns, which allow you to query objects in relation to other objects.
IncludeFiltersAsViewsSpecifies whether saved module filters are exposed as views in the provider.
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.
IncludeReportsSpecifies whether the provider exposes SugarCRM 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 object properties in report views are flattened into individual columns.
FlattenReportsArrayDepthSpecifies how many elements of nested arrays are flattened into individual columns for report views.
IncludeDeletedSpecifies whether the provider retrieves deleted records from SugarCRM.
ServerSideOrderBySpecifies whether the provider performs ORDER BY operations server-side.
LinkColumnsModeDetermines whether 'link' type columns are exposed by the provider.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations.
ConnectOnOpenSpecifies whether the provider establishes a connection to SugarCRM immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
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. This property is only required 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.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655