Skip to main content

Loading Salesforce Data to Local Filesystem using python dlt

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Violetta.

Salesforce is a cloud platform that streamlines business operations and customer relationship management, encompassing sales, marketing, and customer service. This documentation explains how to load data from Salesforce to The Local Filesystem using the open-source Python library dlt. The Local Filesystem destination stores data in a local folder, allowing you to easily create data lakes. You can store the data in formats like JSONL, Parquet, or CSV. For more information about Salesforce, visit their website.

dlt Key Features

  • Scalability via iterators, chunking, and parallelization: dlt offers scalable data extraction by leveraging iterators, chunking, and parallelization techniques, allowing efficient processing of large datasets. Learn more
  • Implicit extraction DAGs: dlt automatically generates an extraction DAG based on the dependencies identified between the data sources and their transformations, ensuring data consistency and integrity. Learn more
  • Configurable normalization engine: The normalization engine in dlt recursively unpacks nested structures into relational tables, making the data ready to be loaded. Learn more
  • Idempotent and atomic loads: dlt uses configurable, idempotent, atomic loads that ensure data safely ends up in your chosen destination, allowing safe retries without creating errors. Learn more
  • Extensive destination support: dlt supports various destinations for storing data, including Google BigQuery, AWS S3, and Azure Blob Storage. Learn more

Getting started with your pipeline locally

0. Prerequisites

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt

First you need to install the dlt library with the correct extras for The Local Filesystem:

pip install "dlt[filesystem]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Salesforce to The Local Filesystem. You can run the following commands to create a starting point for loading data from Salesforce to The Local Filesystem:

# create a new directory
mkdir salesforce_pipeline
cd salesforce_pipeline
# initialize a new pipeline with your source and destination
dlt init salesforce filesystem
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:


simple-salesforce>=1.12.4
dlt[filesystem]>=0.3.5

You now have the following folder structure in your project:

salesforce_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── salesforce/ # folder with source specific files
│ └── ...
├── salesforce_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)

2. Configuring your source and destination credentials

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline. The automatically created version of these files look like this:

generated config.toml

# put your configuration values here

[runtime]
log_level="WARNING" # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

generated secrets.toml

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.salesforce]
user_name = "user_name" # please set me up!
password = "password" # please set me up!
security_token = "security_token" # please set me up!

[destination.filesystem]
dataset_name = "dataset_name" # please set me up!
bucket_url = "bucket_url" # please set me up!

[destination.filesystem.credentials]
aws_access_key_id = "aws_access_key_id" # please set me up!
aws_secret_access_key = "aws_secret_access_key" # please set me up!

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations
  • Read more about setting up the Salesforce source in our docs.
  • Read more about setting up the The Local Filesystem destination in our docs.

The default filesystem destination is configured to connect to AWS S3. To load to a local directory, remove the [destination.filesystem.credentials] section from your secrets.toml and provide a local filepath as the bucket_url.

[destination.filesystem] # in ./dlt/secrets.toml
bucket_url="file://path/to/my/output"

By default, the filesystem destination will store your files as JSONL. You can tell your pipeline to choose a different format with the loader_file_format property that you can set directly on the pipeline or via your config.toml. Available values are jsonl, parquet and csv:

[pipeline] # in ./dlt/config.toml
loader_file_format="parquet"

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at salesforce_pipeline.py, as well as a folder salesforce that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:


#!/usr/bin/env python3
"""Pipeline to load Salesforce data."""
import dlt
from salesforce import salesforce_source


def load() -> None:
"""Execute a pipeline from Salesforce."""

pipeline = dlt.pipeline(
pipeline_name="salesforce", destination='filesystem', dataset_name="salesforce_data"
)
# Execute the pipeline
load_info = pipeline.run(salesforce_source())

# Print the load info
print(load_info)


if __name__ == "__main__":
load()

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python salesforce_pipeline.py

4. Inspecting your load result

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline salesforce info

You can also use streamlit to inspect the contents of your The Local Filesystem destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline salesforce show

5. Next steps to get your pipeline running in production

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to

  • Deploy with GitHub Actions: Learn how to deploy a pipeline using GitHub Actions for CI/CD. Follow the step-by-step guide here.
  • Deploy with Airflow and Google Composer: Set up your pipeline with Airflow and Google Composer by following this comprehensive guide here.
  • Deploy with Google Cloud Functions: Discover how to use Google Cloud Functions to deploy your pipeline with detailed instructions here.
  • Explore other deployment options: Find additional methods and guides for deploying your pipeline here.

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline in production to ensure smooth operations and quickly identify any issues. Read more here.
  • Set up alerts: Set up alerts to stay informed about the status of your dlt pipeline and react promptly to any problems. Detailed instructions can be found here.
  • Set up tracing: Implement tracing to gain deep insights into your pipeline's performance and identify bottlenecks. Find out how here.

Available Sources and Resources

For this verified source the following sources and resources are available

Source salesforce

"Salesforce source provides comprehensive business data, covering customer details, sales opportunities, product pricing, and marketing campaigns."

Resource NameWrite DispositionDescription
accountmergeRepresents an individual or organization that interacts with your business
campaignreplaceRepresents a marketing initiative or project designed to achieve specific goals
contactreplaceRepresents an individual person associated with an account or organization
leadreplaceRepresents a prospective customer/individual/org. that has shown interest in a company's products/services
opportunitymergeRepresents a sales opportunity for a specific account or contact
pricebook_2replaceUsed to manage product pricing and create price books
pricebook_entryreplaceRepresents a specific price for a product in a price book
product_2replaceUsed for managing and organizing your product-related data within the Salesforce ecosystem
sf_userreplaceRepresents an individual who has access to a Salesforce org or instance
user_rolereplaceRepresents a role within the organization's hierarchy

Additional pipeline guides

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.