Pagination

It is recommended to use AQL instead, see the LIMIT operation.

If, for example, you display the result of a user search, then you are ingeneral not interested in the completed result set, but only the first 10 or sodocuments. Or maybe the next 10 documents for the second page. In this case, youcan the skip and limit operators. These operators work like LIMIT inMySQL.

skip used together with limit can be used to implement pagination.The skip operator skips over the first n documents. So, in order to createresult pages with 10 result documents per page, you can useskip(n * 10).limit(10) to access the 10 documents on the _n_th page. This resultshould be sorted, so that the pagination works in a predicable way.

Limit

limitquery.limit(number)

Limits a result to the first number documents. Specifying a limit of0 will return no documents at all. If you do not need a limit, just donot add the limit operator. The limit must be non-negative.

In general the input to limit should be sorted. Otherwise it will beunclear which documents will be included in the result set.

Examples

arangosh> db.five.all().toArray();
arangosh> db.five.all().limit(2).toArray();

Show execution results

[ 
  { 
    "_key" : "87465", 
    "_id" : "five/87465", 
    "_rev" : "_ZP4PZdm---", 
    "name" : "one" 
  }, 
  { 
    "_key" : "87467", 
    "_id" : "five/87467", 
    "_rev" : "_ZP4PZdm--A", 
    "name" : "two" 
  }, 
  { 
    "_key" : "87469", 
    "_id" : "five/87469", 
    "_rev" : "_ZP4PZdq---", 
    "name" : "three" 
  }, 
  { 
    "_key" : "87471", 
    "_id" : "five/87471", 
    "_rev" : "_ZP4PZdq--A", 
    "name" : "four" 
  }, 
  { 
    "_key" : "87473", 
    "_id" : "five/87473", 
    "_rev" : "_ZP4PZdu---", 
    "name" : "five" 
  } 
]
[ 
  { 
    "_key" : "87465", 
    "_id" : "five/87465", 
    "_rev" : "_ZP4PZdm---", 
    "name" : "one" 
  }, 
  { 
    "_key" : "87467", 
    "_id" : "five/87467", 
    "_rev" : "_ZP4PZdm--A", 
    "name" : "two" 
  } 
]

Hide execution results

Skip

skipquery.skip(number)

Skips the first number documents. If number is positive, then thisnumber of documents are skipped before returning the query results.

In general the input to skip should be sorted. Otherwise it will beunclear which documents will be included in the result set.

Note: using negative skip values is deprecated as of ArangoDB 2.6 and will not be supported in future versions of ArangoDB.

Examples

arangosh> db.five.all().toArray();
arangosh> db.five.all().skip(3).toArray();

Show execution results

[ 
  { 
    "_key" : "87486", 
    "_id" : "five/87486", 
    "_rev" : "_ZP4PZeK--A", 
    "name" : "one" 
  }, 
  { 
    "_key" : "87488", 
    "_id" : "five/87488", 
    "_rev" : "_ZP4PZeO---", 
    "name" : "two" 
  }, 
  { 
    "_key" : "87490", 
    "_id" : "five/87490", 
    "_rev" : "_ZP4PZeO--A", 
    "name" : "three" 
  }, 
  { 
    "_key" : "87492", 
    "_id" : "five/87492", 
    "_rev" : "_ZP4PZeS---", 
    "name" : "four" 
  }, 
  { 
    "_key" : "87494", 
    "_id" : "five/87494", 
    "_rev" : "_ZP4PZeS--A", 
    "name" : "five" 
  } 
]
[ 
  { 
    "_key" : "87492", 
    "_id" : "five/87492", 
    "_rev" : "_ZP4PZeS---", 
    "name" : "four" 
  }, 
  { 
    "_key" : "87494", 
    "_id" : "five/87494", 
    "_rev" : "_ZP4PZeS--A", 
    "name" : "five" 
  } 
]

Hide execution results

Ignore any limit with count:

arangosh> db.five.all().limit(2).count();

Show execution results

null

Hide execution results

Counting any limit or skip:

arangosh> db.five.all().limit(2).count(true);

Show execution results

null

Hide execution results