Query Options Header
Specifies options used in a query, such as the query results batch
size. Use this request header with the Query
resource.
Header Field Name and Values
- Field name
- Sforce-Query-Options
- Field values
-
-
batchSize—A numeric value that specifies the
number of records returned for a query request. Child objects count toward the number of
records for the batch size. For example, in relationship queries, multiple child
objects are returned per parent row returned.
The default is 2,000; the minimum is 200, and the maximum is 2,000. There is no guarantee that the requested batch size is the actual batch size. Changes are made as necessary to maximize performance.
-
batchSize—A numeric value that specifies the
number of records returned for a query request. Child objects count toward the number of
records for the batch size. For example, in relationship queries, multiple child
objects are returned per parent row returned.
- Example
- Sforce-Query-Options: batchSize=1000