Skip to content

Client

IngestResult dataclass

Bulk API 2.0 ingest operation result.

Source code in src/aiosalesforce/bulk/v2/client.py 
15
16
17
18
19
20
21
22
@dataclasses.dataclass
class IngestResult:
    """Bulk API 2.0 ingest operation result."""

    jobs: list[JobInfo]
    successful_results: list[dict[str, str]]
    failed_results: list[dict[str, str]]
    unprocessed_records: list[dict[str, str]]

BulkClientV2

Salesforce Bulk API 2.0 client.

Use this client to execute bulk ingest and query operations.

Parameters:

Name Type Description Default
salesforce_client Salesforce

Salesforce client.

 required
Source code in src/aiosalesforce/bulk/v2/client.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
class BulkClientV2:
    """
    Salesforce Bulk API 2.0 client.

    Use this client to execute bulk ingest and query operations.

    Parameters
    ----------
    salesforce_client : Salesforce
        Salesforce client.

    """

    salesforce_client: "Salesforce"
    base_url: str
    """Base URL in the format https://[subdomain(s)].my.salesforce.com/services/data/v[version]/jobs"""

    def __init__(self, salesforce_client: "Salesforce") -> None:
        self.salesforce_client = salesforce_client
        self.base_url = "/".join(
            [
                self.salesforce_client.base_url,
                "services",
                "data",
                f"v{self.salesforce_client.version}",
                "jobs",
            ]
        )

    @cached_property
    def ingest(self) -> BulkIngestClient:
        """Manage ingest jobs at a low level."""
        return BulkIngestClient(self)

    async def __perform_operation(
        self,
        operation: OperationType,
        sobject: str,
        data: Iterable[dict[str, Any]],
        external_id_field: str | None = None,
        assignment_rule_id: str | None = None,
    ) -> IngestResult:
        result = IngestResult([], [], [], [])
        async for job_result in self.ingest.perform_operation(
            operation=operation,
            sobject=sobject,
            data=data,
            external_id_field=external_id_field,
            assignment_rule_id=assignment_rule_id,
        ):
            result.jobs.append(job_result.job_info)
            result.successful_results.extend(job_result.successful_results)
            result.failed_results.extend(job_result.failed_results)
            result.unprocessed_records.extend(job_result.unprocessed_records)
        return result

    async def insert(
        self,
        sobject: str,
        data: Iterable[dict[str, Any]],
        assignment_rule_id: str | None = None,
    ) -> IngestResult:
        """
        Create new records in Salesforce.

        Parameters
        ----------
        sobject : str
            Salesforce object name.
        data : Iterable[dict[str, Any]]
            Records to create.
        assignment_rule_id : str | None, default None
            The ID of an assignment rule to run for a Case or a Lead.

        Returns
        -------
        IngestResult
            Bulk API 2.0 ingest job results.

        """
        return await self.__perform_operation(
            "insert",
            sobject=sobject,
            data=data,
            assignment_rule_id=assignment_rule_id,
        )

    async def update(
        self,
        sobject: str,
        data: Iterable[dict[str, Any]],
        assignment_rule_id: str | None = None,
    ) -> IngestResult:
        """
        Update existing records in Salesforce.

        Parameters
        ----------
        sobject : str
            Salesforce object name.
        data : Iterable[dict[str, Any]]
            Records to update.
        assignment_rule_id : str | None, default None
            The ID of an assignment rule to run for a Case or a Lead.

        Returns
        -------
        IngestResult
            Bulk API 2.0 ingest job results.

        """
        return await self.__perform_operation(
            "update",
            sobject=sobject,
            data=data,
            assignment_rule_id=assignment_rule_id,
        )

    async def upsert(
        self,
        sobject: str,
        data: Iterable[dict[str, Any]],
        external_id_field: str,
        assignment_rule_id: str | None = None,
    ) -> IngestResult:
        """
        Create or update records in Salesforce.

        Parameters
        ----------
        sobject : str
            Salesforce object name.
        data : Iterable[dict[str, Any]]
            Records to create or update.
        external_id_field : str
            External ID field name.
        assignment_rule_id : str | None, default None
            The ID of an assignment rule to run for a Case or a Lead.

        Returns
        -------
        IngestResult
            Bulk API 2.0 ingest job results.

        """
        return await self.__perform_operation(
            "upsert",
            sobject=sobject,
            data=data,
            external_id_field=external_id_field,
            assignment_rule_id=assignment_rule_id,
        )

    async def delete(
        self,
        sobject: str,
        data: Iterable[dict[str, Any]],
        hard: bool = False,
    ) -> IngestResult:
        """
        Delete records from Salesforce.

        Parameters
        ----------
        sobject : str
            Salesforce object name.
        data : Iterable[dict[str, Any]]
            Records to delete.
        hard : bool, default False
            Whether to hard delete records.

        Returns
        -------
        IngestResult
            Bulk API 2.0 ingest job results.

        """
        return await self.__perform_operation(
            "hardDelete" if hard else "delete",
            sobject=sobject,
            data=data,
            assignment_rule_id=None,
        )

base_url: str = '/'.join([self.salesforce_client.base_url, 'services', 'data', f'v{self.salesforce_client.version}', 'jobs']) instance-attribute

Base URL in the format https://[subdomain(s)].my.salesforce.com/services/data/v[version]/jobs

ingest: BulkIngestClient cached property

Manage ingest jobs at a low level.

insert(sobject, data, assignment_rule_id=None) async

Create new records in Salesforce.

Parameters:

Name Type Description Default
sobject str

Salesforce object name.

 required
data Iterable[dict[str, Any]]

Records to create.

 required
assignment_rule_id str | None

The ID of an assignment rule to run for a Case or a Lead.

 None

Returns:

Type Description
IngestResult

Bulk API 2.0 ingest job results.
Source code in src/aiosalesforce/bulk/v2/client.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
async def insert(
    self,
    sobject: str,
    data: Iterable[dict[str, Any]],
    assignment_rule_id: str | None = None,
) -> IngestResult:
    """
    Create new records in Salesforce.

    Parameters
    ----------
    sobject : str
        Salesforce object name.
    data : Iterable[dict[str, Any]]
        Records to create.
    assignment_rule_id : str | None, default None
        The ID of an assignment rule to run for a Case or a Lead.

    Returns
    -------
    IngestResult
        Bulk API 2.0 ingest job results.

    """
    return await self.__perform_operation(
        "insert",
        sobject=sobject,
        data=data,
        assignment_rule_id=assignment_rule_id,
    )

update(sobject, data, assignment_rule_id=None) async

Update existing records in Salesforce.

Parameters:

Name Type Description Default
sobject str

Salesforce object name.

 required
data Iterable[dict[str, Any]]

Records to update.

 required
assignment_rule_id str | None

The ID of an assignment rule to run for a Case or a Lead.

 None

Returns:

Type Description
IngestResult

Bulk API 2.0 ingest job results.
Source code in src/aiosalesforce/bulk/v2/client.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
async def update(
    self,
    sobject: str,
    data: Iterable[dict[str, Any]],
    assignment_rule_id: str | None = None,
) -> IngestResult:
    """
    Update existing records in Salesforce.

    Parameters
    ----------
    sobject : str
        Salesforce object name.
    data : Iterable[dict[str, Any]]
        Records to update.
    assignment_rule_id : str | None, default None
        The ID of an assignment rule to run for a Case or a Lead.

    Returns
    -------
    IngestResult
        Bulk API 2.0 ingest job results.

    """
    return await self.__perform_operation(
        "update",
        sobject=sobject,
        data=data,
        assignment_rule_id=assignment_rule_id,
    )

upsert(sobject, data, external_id_field, assignment_rule_id=None) async

Create or update records in Salesforce.

Parameters:

Name Type Description Default
sobject str

Salesforce object name.

 required
data Iterable[dict[str, Any]]

Records to create or update.

 required
external_id_field str

External ID field name.

 required
assignment_rule_id str | None

The ID of an assignment rule to run for a Case or a Lead.

 None

Returns:

Type Description
IngestResult

Bulk API 2.0 ingest job results.
Source code in src/aiosalesforce/bulk/v2/client.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
async def upsert(
    self,
    sobject: str,
    data: Iterable[dict[str, Any]],
    external_id_field: str,
    assignment_rule_id: str | None = None,
) -> IngestResult:
    """
    Create or update records in Salesforce.

    Parameters
    ----------
    sobject : str
        Salesforce object name.
    data : Iterable[dict[str, Any]]
        Records to create or update.
    external_id_field : str
        External ID field name.
    assignment_rule_id : str | None, default None
        The ID of an assignment rule to run for a Case or a Lead.

    Returns
    -------
    IngestResult
        Bulk API 2.0 ingest job results.

    """
    return await self.__perform_operation(
        "upsert",
        sobject=sobject,
        data=data,
        external_id_field=external_id_field,
        assignment_rule_id=assignment_rule_id,
    )

delete(sobject, data, hard=False) async

Delete records from Salesforce.

Parameters:

Name Type Description Default
sobject str

Salesforce object name.

 required
data Iterable[dict[str, Any]]

Records to delete.

 required
hard bool

Whether to hard delete records.

 False

Returns:

Type Description
IngestResult

Bulk API 2.0 ingest job results.
Source code in src/aiosalesforce/bulk/v2/client.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
async def delete(
    self,
    sobject: str,
    data: Iterable[dict[str, Any]],
    hard: bool = False,
) -> IngestResult:
    """
    Delete records from Salesforce.

    Parameters
    ----------
    sobject : str
        Salesforce object name.
    data : Iterable[dict[str, Any]]
        Records to delete.
    hard : bool, default False
        Whether to hard delete records.

    Returns
    -------
    IngestResult
        Bulk API 2.0 ingest job results.

    """
    return await self.__perform_operation(
        "hardDelete" if hard else "delete",
        sobject=sobject,
        data=data,
        assignment_rule_id=None,
    )