ADO.NET Provider for SugarCRM

Build 23.0.8839

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.
BatchSizeThe maximum size of each batch operation to submit.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to SugarCRM from the provider.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPoolingThis property enables connection pooling.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839