datahub/metadata-ingestion/docs/sources/salesforce/salesforce_pre.md

Prerequisites

In order to ingest metadata from Salesforce, you will need one of:

• Salesforce username, password, security token
• Salesforce username, consumer key and private key for JSON web token access
• Salesforce instance url and access token/session id (suitable for one-shot ingestion only, as access token typically expires after 2 hours of inactivity)

The account used to access Salesforce requires the following permissions for this integration to work:

• View Setup and Configuration
• View All Data

Integration Details

This plugin extracts Salesforce Standard and Custom Objects and their details (fields, record count, etc) from a Salesforce instance. Python library simple-salesforce is used for authenticating and calling Salesforce REST API to retrive details from Salesforce instance.

REST API Resources used in this integration

• Versions
• Tooling API Query on objects EntityDefinition, EntityParticle, CustomObject, CustomField
• Record Count

Concept Mapping

This ingestion source maps the following Source System Concepts to DataHub Concepts:

Source Concept	DataHub Concept	Notes
Salesforce	Data Platform
Standard Object	Dataset	subtype "Standard Object"
Custom Object	Dataset	subtype "Custom Object"

Caveats

• This connector has only been tested with Salesforce Developer Edition.
• This connector only supports table level profiling (Row and Column counts) as of now. Row counts are approximate as returned by Salesforce RecordCount REST API.
• This integration does not support ingesting Salesforce External Objects