The Salesforce driver automatically maps Salesforce data source objects and fields to tables and columns the first time it connects to a data source instance. The driver maps both standard and custom objects and includes any relationships defined between objects. You can use the getPrimaryKey(), getExportedKeys(), and getImportedKeys() methods to report relationships among objects.

By default, the Salesforce driver does not include audit columns in table definitions when mapping Salesforce objects to tables. The ConfigOptions connection property can be used to include audit columns. The following columns can be included or excluded:

  • CreatedById
  • CreatedByDate
  • LastModifiedId
  • LastModifiedDate
  • SystemModestamp
  • MasterRecordId

When mapping custom objects and fields, the Salesforce driver strips the standard "__c" suffix from the names of the custom objects and fields by default. You can set the CustomSuffix key of the ConfigOptions connection property to prevent the driver from stripping the "__c" suffix. When mapping Salesforce system fields to columns in a table, the driver changes the column name to make it evident that the column is a system column. If you do not want the driver to change the names of system columns, set the MapSystemColumnNames key of the ConfigOptions connection property to 0.

The Create DB connection property allows you to update or re-create the embedded database that defines and handles the object-to-table mapping.