Welcome to Salesforce Toolkit documentation!

Salesforce Toolkit is a Python library designed to simplify interactions with the Salesforce API. It provides a clean, object-oriented interface for connecting to Salesforce instances and working with Salesforce data through native Python data structures.

Contents:

• Installation
  • Requirements
  • Installing with pip
  • Installing from source
• Quickstart
  • Basic Usage
  • Authentication
  • Working with SObjects
  • Querying Records
  • Creating Records
  • Updating Records
  • Next Steps
• Salesforce Client
  • Client Types
  • Basic Usage
  • Asynchronous Usage
  • Authentication Methods
  • Working with multiple connections
• Authentication
  • Quick Reference
  • Lazy Authentication (Auto-selection)
  • CLI-based Authentication
  • OAuth 2.0 Authentication
  • SOAP Authentication
  • Using Tokens Directly
  • Token Refresh and Callbacks
  • Best Practices
  • Authentication Classes
• Working with SObjects
  • Defining SObjects
  • Field Types
  • Field Flags
  • Default Field Values
  • CRUD Operations
  • Dynamic SObject Creation
• Querying Records
  • Basic Queries
  • Implicit Query Execution
  • Multiple Iterations of `QueryResult`s
  • Filtering Records
  • Combining Conditions
  • Complex Conditions
  • Raw WHERE Clauses
  • Grouping and Aggregates
  • Sorting Results
  • Pagination
  • Handling Results
  • Counting Records
  • Tooling API Queries
  • Date and DateTime Values
• Bulk API
  • Overview
  • When to Use Bulk API
  • Basic Usage
  • Bulk Insert
  • Bulk Update
  • Bulk Upsert
  • Working with BulkApiIngestJob Directly
  • Bulk Job States
  • Monitoring Job Status
  • Performance Considerations
  • Error Handling
  • Advanced Configuration
  • Limitations
• Bulk Query API
  • When to Use Bulk Query
  • Basic Usage with select(…).execute_bulk()
  • Asynchronous Usage
  • Working with BulkApiQueryJob Directly
  • Streaming and Pagination
  • Job States for Query
  • Error Handling
  • Performance Tips
  • Limitations
  • Example: Filtering and Streaming
  • Async Example with Early Break
  • Comparing Standard vs Bulk Query
• Advanced Topics
  • Async Operations
  • Batch Operations
  • Error Handling
  • API Limits & Usage Monitoring
  • Custom Field Types
• API Reference
  • Client Module
  • Authentication
  • SObject Classes
  • SObject Fields
  • Salesforce API Calls
  • Local Data Storage
  • Query Builder
  • API Models
  • Exceptions
  • Utilities

Indices and tables

• Index

• Module Index

• Search Page