Specifies a point buffer used to increase the calculated wait time for throttling prevention.

Data Type

int

Default Value

0

Remarks

Shopify’s GraphQL API manages usage with a budget of "cost points" that refill over time. To avoid running out of points, the driver intelligently calculates when to pause before making its next request.

This property makes the driver more cautious by increasing the number of points required before making a request. The driver then waits for the amount of time that would be required to recover a number of points equal to the query's cost plus the buffer size. This provides a "safe spot" that helps prevent throttling errors from other concurrent connections sharing the same API quota.

For example, if a query costs 200 points and you set this property to 100, the driver will calculate the time required to restore a total of 300 points and will wait for that duration before sending the request.

Using any buffer may cause the driver to pause more often, but it increases safety. A smaller buffer provides a good safety margin without significantly affecting speed. A larger buffer offers more protection but may impact performance more noticeably. A value of 0 (the default) is suitable when you do not have multiple connections sharing the same API quota.