Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Complex Types > QueryOptions

QueryOptions

Table of contents

The QueryOptions object is used to define the batch size and case-sensitivity options for the query() and queryMore() calls. This complex type is  valid as of WSDL version 6.0.

Fields

All field names are case sensitive.

Field Description

batchSize

Defines the batch size of the query result.

Type: Integer

Range: 1 - 2000 (inclusive). If a value higher than 2000 is submitted, only 2000 results are returned.

caseSensitive

Indicates if the query filter results returned consider case-sensitivity. If True, the query results must match the filter and the letter case. If False, the query must match the filter but ignores the letter case.

Type: Boolean: True or False

WSDL: Version 14.0+

Example:

Suppose you have three active accounts:

ID Name
1 mybigbusiness
2 MyBigBusiness
3 MYBIGBUSINESS

Using a SOAP API call, you send the query request:

...
  select *from Account where name = 'mybigbusiness'
...

The query result returns the following when the caseSensitive option is:

  • True: Only one account, ID 1
  • False: All three accounts, IDs 1, 2, and 3

fastQuery

If True, Zuora will execute the query on a READ ONLY database. This option improves query performance.

Type: Boolean, True or False

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support



 

Last modified
16:09, 28 Dec 2015

Tags

Classifications

(not set)