Skip to content

README.md

Latest commit

 

History

History
191 lines (143 loc) · 7.67 KB

README.md

File metadata and controls

191 lines (143 loc) · 7.67 KB

Data Cloud Custom Code SDK

license

This package provides a development kit for creating custom data transformations in Data Cloud. It allows you to write your own data processing logic in Python while leveraging Data Cloud's infrastructure for data access and running data transformations, mapping execution into Data Cloud data structures like Data Model Objects and Data Lake Objects.

More specifically, this codebase gives you ability to test code locally before pushing to Data Cloud's remote execution engine, greatly reducing how long it takes to develop.

Use of this project with Salesforce is subject to the TERMS OF USE

Prerequisites

Installation

The SDK can be downloaded directly from PyPI with pip:

pip install salesforce-data-customcode

You can verify it was properly installed via CLI:

datacustomcode version

Quick start

Ensure you have all the prerequisites prepared on your machine.

To get started, create a directory and initialize a new project with the CLI:

mkdir datacloud && cd datacloud
python3.11 -m venv .venv
source .venv/bin/activate
pip install salesforce-data-customcode
datacustomcode init my_package

This will yield all necessary files to get started:

.
├── Dockerfile
├── README.md
├── requirements.txt
├── requirements-dev.txt
├── payload
│   ├── config.json
│   ├── entrypoint.py
├── jupyterlab.sh
└── requirements.txt
  • Dockerfile (Do not update) – Development container emulating the remote execution environment.
  • requirements-dev.txt (Do not update) – These are the dependencies for the development environment.
  • jupyterlab.sh (Do not update) – Helper script for setting up Jupyter.
  • requirements.txt – Here you define the requirements that you will need for your script.
  • payload – This folder will be compressed and deployed to the remote execution environment.
    • config.json – This config defines permissions on the back and can be generated programmatically with scan CLI method.
    • entrypoint.py – The script that defines the data transformation logic.

A functional entrypoint.py is provided so you can run once you've configured your connected app:

cd my_package
datacustomcode configure
datacustomcode run ./payload/entrypoint.py

Important

The example entrypoint.py requires a Account_Home__dll DLO to be present. And in order to deploy the script (next step), the output DLO (which is Account_Home_copy__dll in the example entrypoint.py) also needs to exist and be in the same dataspace as Account_Home__dll.

After modifying the entrypoint.py as needed, using any dependencies you add in the .venv virtual environment, you can run this script in Data Cloud:

datacustomcode scan ./payload/entrypoint.py
datacustomcode deploy --path ./payload --name my_custom_script

Tip

The deploy process can take several minutes. If you'd like more feedback on the underlying process, you can add --debug to the command like datacustomcode --debug deploy --path ./payload --name my_custom_script

API

You entry point script will define logic using the Client object which wraps data access layers.

You should only need the following methods:

  • read_dlo(name) – Read from a Data Lake Object by name
  • read_dmo(name) – Read from a Data Model Object by name
  • write_to_dlo(name, spark_dataframe, write_mode) – Write to a Data Model Object by name with a Spark dataframe
  • write_to_dmo(name, spark_dataframe, write_mode) – Write to a Data Lake Object by name with a Spark dataframe

For example:

from datacustomcode import Client

client = Client()

sdf = client.read_dlo('my_DLO')
# some transformations
# ...
client.write_to_dlo('output_DLO')

Warning

Currently we only support reading from DMOs and writing to DMOs or reading from DLOs and writing to DLOs, but they cannot mix.

CLI

The Data Cloud Custom Code SDK provides a command-line interface (CLI) with the following commands:

Global Options

  • --debug: Enable debug-level logging

Commands

datacustomcode version

Display the current version of the package.

datacustomcode configure

Configure credentials for connecting to Data Cloud.

Options:

  • --profile TEXT: Credential profile name (default: "default")
  • --username TEXT: Salesforce username
  • --password TEXT: Salesforce password
  • --client-id TEXT: Connected App Client ID
  • --client-secret TEXT: Connected App Client Secret
  • --login-url TEXT: Salesforce login URL

datacustomcode zip

Zip a transformation job in preparation to upload to Data Cloud.

Options:

  • --path TEXT: Path to the code directory (default: ".")

datacustomcode deploy

Deploy a transformation job to Data Cloud.

Options:

  • --profile TEXT: Credential profile name (default: "default")
  • --path TEXT: Path to the code directory (default: ".")
  • --name TEXT: Name of the transformation job [required]
  • --version TEXT: Version of the transformation job (default: "0.0.1")
  • --description TEXT: Description of the transformation job (default: "")

datacustomcode init

Initialize a new development environment with a template.

Argument:

  • DIRECTORY: Directory to create project in (default: ".")

datacustomcode scan

Scan a Python file to generate a Data Cloud configuration.

Argument:

  • FILENAME: Python file to scan

Options:

  • --config TEXT: Path to save the configuration file (default: same directory as FILENAME)
  • --dry-run: Preview the configuration without saving to a file

datacustomcode run

Run an entrypoint file locally for testing.

Argument:

  • ENTRYPOINT: Path to entrypoint Python file

Options:

  • --config-file TEXT: Path to configuration file
  • --dependencies TEXT: Additional dependencies (can be specified multiple times)

Prerequisite details

Creating a connected app

  1. Log in to salesforce as an admin. In the top right corner, click on the gear icon and go to Setup
  2. In the left hand side, search for "App Manager" and select the App Manager underneath Apps
  3. Click on New Connected App in the upper right
  4. Fill in the required fields within the Basic Information section
  5. Under the API (Enable OAuth Settings) section:
    1. Click on the checkbox to Enable OAuth Settings.
    2. Provide a callback URL like http://localhost:55555/callback
    3. In the Selected OAuth Scopes, make sure that refresh_token, api, cdp_query_api, cdp_profile_api is selected.
    4. Click on Save to save the connected app
  6. From the detail page that opens up afterwards, click the "Manage Consumer Details" button to find your client id and client secret
  7. Go back to Setup, then OAuth and OpenID Connect Settings, and enable the "Allow OAuth Username-Password Flows" option

You now have all fields necessary for the datacustomcode configure command.