getSize()

Returns the total number of items in the query results.

 var db = ScriptDb.getMyDb();
 var results = db.query({type: 'person'});
 Logger.log('Number of people: ' + results.getSize());
 

Return

Integer — the total number of items in the query results

hasNext()

Returns true if there are more items left in the query results.

 var db = ScriptDb.getMyDb();
 var results = db.query({type: 'person'});
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Return

Boolean — true if there are more items left in the query results, false if all items have been retrieved

limit(number)

Limits the number of items in the query results.

 var db = ScriptDb.getMyDb();
 // Get the first ten people.
 var results = db.query({type: 'person'}).limit(10);
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining

next()

Returns the next item in the query results. Once this method called it's not possible to go back to a previous item.

 var db = ScriptDb.getMyDb();
 var results = db.query({type: 'person'});
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Return

ScriptDbMap — the next item in the query results

paginate(pageNumber, pageSize)

Limits the query results to a single page of items, using the passed in page number and size. Please note that page numbers start at zero.

 var db = ScriptDb.getMyDb();
 var pageNumber = 0;
 var pageSize = 10;
 var page;
 do {
   page = db.query({type: 'person'}).paginate(pageNumber, pageSize);
   var items = [];
   while (page.hasNext()) {
     items.push(page.next());
   }
   // Do something with the page of items.
   pageNumber++;
 } while (page.getSize() == pageSize);
 

Parameters

Return

ScriptDbResult — the results, for chaining

sortBy(fieldPath)

Sorts the query results by the specified field, lexically and ascending. To sort by an inner field specify the dot-separated path to the field (for example "business.address.city").

 var db = ScriptDb.getMyDb();
 // Get people sorted by name.
 var results = db.query({type: 'person'}).sortBy('name');
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining

sortBy(fieldPath, direction)

Sorts the query results by the specified field, lexically and using the passed in direction.

 var db = ScriptDb.getMyDb();
 // Get people sorted by name, in reverse alphabetical order.
 var results = db.query({type: 'person'}).sortBy('name', db.DESCENDING);
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining

sortBy(fieldPath, direction, strategy)

Sorts the query results by the specified field, using the passed in direction and strategy.

 var db = ScriptDb.getMyDb();
 // Get people sorted by age, oldest to youngest.
 var results = db.query({type: 'person'}).sortBy('age', db.DESCENDING, db.NUMERIC);
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining

sortBy(fieldPath, strategy)

Sorts the query results by the specified field, ascending and using the passed in strategy.

 var db = ScriptDb.getMyDb();
 // Get people sorted by age.
 var results = db.query({type: 'person'}).sortBy('age', db.NUMERIC);
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining

startAt(number)

Starts the query results with the item at the passed in index.

 var db = ScriptDb.getMyDb();
 // Get all but the first ten people.
 var results = db.query({type: 'person'}).startAt(10);
 while (results.hasNext()) {
   var item = results.next();
   // Do something with the item.
 }
 

Parameters

Return

ScriptDbResult — the results, for chaining