Document callback.nextQuery in query() #2174

Activity

1. stephenplusplus commented on Mar 31, 2017

   

   stephenplusplus

   on Mar 31, 2017

   Last edited by stephenplusplus

   Contributor

   More actions

   By default, nextQuery is not included in the response, which is why we don't include it in the documentation, instead using the example to demonstrate how it is meant to be used. That example for BigQuery is:

   To control how many API requests are made and page through the results manually, set autoPaginate to false.

   var callback = function(err, rows, nextQuery, apiResponse) {
     if (nextQuery) {
       bigquery.query(nextQuery, callback);
     }
   };
   
   bigquery.query({
     query: query,
     autoPaginate: false
   }, callback);

   The key part here is autoPaginate: false-- that's the argument which is true by default, and when disabled, will change the signature of the callback.

   Since it is not the default set of arguments to the function, I think we'd end up confusing more users by stating that their callback will receive the nextQuery argument.

   However, I do think we messed up-- we shouldn't show that the callback receives apiResponse, because that doesn't come by default either.

   @callmehiphop does all that sound correct?
2. stephenplusplus

   added

   api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.

   docs

   on Mar 31, 2017
3. smarigowda commented on Apr 3, 2017

   

   smarigowda

   on Apr 3, 2017

   More actions

   Thank you for the detail response. I am now able to get the apiResponse.
4. lukesneeringer

   added

   priority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.

   on Apr 4, 2017
5. stephenplusplus

   closed this as completedin #2220on Apr 13, 2017
6. JustinBeckwith

   assigned

   stephenplusplus

   on Feb 1, 2021
7. sofisl

   added a commit that references this issue on Feb 25, 2026

   chore(main): release 6.9.5 (#2174)

   ...

   53c316e
8. thiyaguk09

   added a commit that references this issue on Mar 18, 2026

   chore(main): release 6.9.5 (googleapis#2174)

   ...

   f09ff33