LinkColumnsMode
Determines whether 'link' type columns are exposed by the provider.
Possible Values
Ignore, IncludeData Type
string
Default Value
"Ignore"
Remarks
Link columns are special relationship fields returned by the SugarCRM API with type LINK. Unlike standard data fields, link columns represent relationships between modules and are used to create parent-child associations between records during INSERT operations.
The available options are:
| Ignore | Link columns are not exposed in the table schema and cannot be used in queries or INSERT statements. When set to Ignore, only standard data fields are available for each module. This is the default setting and is recommended if you do not need to create relationships between modules programmatically. |
| Include | Link columns are exposed in the table schema and can be used in INSERT statements to establish relationships between modules. When set to Include, relationship fields become available alongside standard data fields.
For example, to associate a comment with a case, use the commentlog_link column with the ID of the CommentLog record:
INSERT INTO Cases (Name, commentlog_link)
VALUES ('Test Case from CData Connector', '435d10fa-5356-11ef-bc7e-068962c7e2c7')
This creates a parent-child relationship, allowing the comment to appear associated with the case in the SugarCRM UI. |
Note: Link columns are write-only fields used exclusively for INSERT operations. When querying records, link columns return NULL. To view related record information, query the corresponding module view. For example, after creating the relationship above, query the CommentLog view to see comments associated with the case.