AggregateColumnMode
Indicating how aggregate columns should be treated.
Possible Values
Ignore, List, ListAndRetrieveData Type
string
Default Value
"ListAndRetrieve"
Remarks
Aggregate columns are the columns that will appear on base tables which aggregate all of the data contained within child collections. Because these columns include all the data of a child collection, they can become very large. In some situations, such as writing the data to an offline database, it may be advisable to set AggregateColumnMode to either Ignore or List. Setting AggregateColumnMode to List will still cause aggregate columns to be listed for use with inserts and updates.
| Ignore | All aggregate will be ignored and will not show up as available columns in the table definition. |
| List | Aggregate columns will be listed in all tables, but on base tables such as Contacts, they will not retrieve data from Sugar CRM. |
| ListAndRetrieve | Aggregate columns will be listed and requested on all tables. Note that when this mode is activated, primitive columns which are also part of the aggregates will be retuned as NULL. I.e. on the Accounts table the Team_Id column which is also part of the Team_Name aggregate, will be returned as NULL. |