Specifies whether queries return the contents of binary (base64) fields, such as Attachment.Body.

Data Type

bool

Default Value

true

Remarks

When set to true (the default), the provider requests binary fields from Salesforce whenever a query references them, and returns their values in the result set. Salesforce restricts how binary data can be retrieved, so such queries cannot run through the Bulk API. Because of these restrictions and the amount of data involved, queries that reference binary fields might run slower than other queries. If a query that references a binary field is submitted to Bulk API v1, the provider reports an error when the query is run through the QueryBatch stored procedure, and falls back to the SOAP API when it is run as a SELECT statement.

When set to false, binary fields remain visible in the data model, but the provider omits them from the queries it sends to Salesforce. Because no binary data is transferred, such queries can use the Bulk API when UseBulkAPI is enabled. Set this property to false when you need the other columns of a table that contains binary fields but not the binary content itself. This is also useful when a client application selects every column of such a table and you want to avoid the resulting slowdown.