config-example.yaml

# Salesforce Data Extraction Configuration
#
# Usage:
#   1. Login:  sf org login web --alias my-org
#   2. Run:    python extract.py
#   3. Override mode: python extract.py --mode incremental

# Salesforce org alias (from sf org login web --alias <alias>)
org_alias: "my-org"

# Output directory — CSV files are written directly to this path.
output_dir: "./output"

# Mode: "full" (all records) | "incremental" (since last run)
mode: "full"

# Record limit per object for "verify" task (mise run verify)
verify_limit: 10

# Objects to extract
# - name: Salesforce API name of the object
# - fields: optional field list; omit to fetch all fields
# - include: optional relationship fields (dot notation, e.g. CreatedBy.Name)
objects:
  - name: Account
    fields:
      - Id
      - Name
      - Industry
      - BillingCity
      - BillingCountry
      - CreatedDate
      - LastModifiedDate
    include:
      - CreatedBy.Name
      - LastModifiedBy.Name

  - name: Contact
    fields:
      - Id
      - FirstName
      - LastName
      - Email
      - Phone
      - AccountId
      - LastModifiedDate

  - name: Opportunity
    fields:
      - Id
      - Name
      - StageName
      - Amount
      - CloseDate
      - AccountId
      - LastModifiedDate

  # Example custom object — no field list specified (will fetch all fields)
  # - name: Custom_Object__c

  # Example with approval history export
  # Produces an additional ApprovalHistory_<ObjectName>.csv with
  # denormalized ProcessInstance + ProcessInstanceNode data.
  # - name: Account
  #   approval_history: true