Module salesforce.bulk
ballerinax/salesforce.bulk Ballerina library
7.5.0
Overview
Salesforce Bulk API is a specialized asynchronous RESTful API for loading and querying bulk of data at once. This module provides bulk data operations for CSV, JSON, and XML data types.
This module supports Salesforce Bulk API v1.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create Salesforce account
- Obtain tokens - Follow the steps listed under OAuth 2.0 Web Server Flow for Web App Integration.
Quickstart
To use the Salesforce connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/salesforce.bulk
module into the Ballerina project.
import ballerinax/salesforce.bulk;
Step 2: Create a new connector instance
Create a ConnectionConfig
with the OAuth2 tokens obtained, and initialize the connector with it.
ulk:ConnectionConfig sfConfig = { baseUrl: <"EP_URL">, clientConfig: { clientId: <"CLIENT_ID">, clientSecret: <"CLIENT_SECRET">, refreshToken: <"REFRESH_TOKEN">, refreshUrl: <"REFRESH_URL"> } ; ulk:Client bulkClient = new (sfConfig);
Step 3: Invoke connector operation
- Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to insert bulk contacts using the connector.
son contacts = [ { description: "Created_from_Ballerina_Sf_Bulk_API", FirstName: "Morne", LastName: "Morkel", Title: "Professor Grade 03", Phone: "0442226670", Email: "morne89@gmail.com" } ; ublic function main() returns error? { bulk:BulkJob insertJob = check bulkClient->createJob("insert", "Contact", "JSON"); bulk:BatchInfo batch = check bulkClient->addBatch(insertJob, contacts);
- Use
bal run
command to compile and run the Ballerina program.