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 in general not interested in the completed result set, but only the first 10 or so documents. Or maybe the next 10 documents for the second page. In this case, you can the skip and limit operators. These operators work like LIMIT in MySQL.

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

Limit

limit query.limit(number)

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

In general the input to limit should be sorted. Otherwise it will be unclear 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

Hide execution results

[ 
  { 
    "_key" : "91765", 
    "_id" : "five/91765", 
    "_rev" : "_dAzP4Y6---", 
    "name" : "one" 
  }, 
  { 
    "_key" : "91767", 
    "_id" : "five/91767", 
    "_rev" : "_dAzP4Y6--A", 
    "name" : "two" 
  }, 
  { 
    "_key" : "91769", 
    "_id" : "five/91769", 
    "_rev" : "_dAzP4Z----", 
    "name" : "three" 
  }, 
  { 
    "_key" : "91771", 
    "_id" : "five/91771", 
    "_rev" : "_dAzP4Z---A", 
    "name" : "four" 
  }, 
  { 
    "_key" : "91773", 
    "_id" : "five/91773", 
    "_rev" : "_dAzP4ZC---", 
    "name" : "five" 
  } 
]
[ 
  { 
    "_key" : "91765", 
    "_id" : "five/91765", 
    "_rev" : "_dAzP4Y6---", 
    "name" : "one" 
  }, 
  { 
    "_key" : "91767", 
    "_id" : "five/91767", 
    "_rev" : "_dAzP4Y6--A", 
    "name" : "two" 
  } 
]

Skip

skip query.skip(number)

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

In general the input to skip should be sorted. Otherwise it will be unclear 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

Hide execution results

[ 
  { 
    "_key" : "91788", 
    "_id" : "five/91788", 
    "_rev" : "_dAzP4Zi---", 
    "name" : "one" 
  }, 
  { 
    "_key" : "91790", 
    "_id" : "five/91790", 
    "_rev" : "_dAzP4Zm---", 
    "name" : "two" 
  }, 
  { 
    "_key" : "91792", 
    "_id" : "five/91792", 
    "_rev" : "_dAzP4Zm--A", 
    "name" : "three" 
  }, 
  { 
    "_key" : "91794", 
    "_id" : "five/91794", 
    "_rev" : "_dAzP4Zq---", 
    "name" : "four" 
  }, 
  { 
    "_key" : "91796", 
    "_id" : "five/91796", 
    "_rev" : "_dAzP4Zq--A", 
    "name" : "five" 
  } 
]
[ 
  { 
    "_key" : "91794", 
    "_id" : "five/91794", 
    "_rev" : "_dAzP4Zq---", 
    "name" : "four" 
  }, 
  { 
    "_key" : "91796", 
    "_id" : "five/91796", 
    "_rev" : "_dAzP4Zq--A", 
    "name" : "five" 
  } 
]

Ignore any limit with count:

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

Show execution results

Hide execution results

null

Counting any limit or skip:

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

Show execution results

Hide execution results

null