Class ArrayCursor<T>

Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.

example

const cursor = await db.query(aql`
  FOR user IN users
  FILTER user.isActive
  RETURN user
`);
for await (const user of cursor) {
  console.log(user.email, user.isAdmin);
}

example

const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.all(); // [1, 2, 3, 4, 5]
console.log(cursor.hasNext); // false

Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.

example

const cursor = await db.query(aql`FOR x IN 1..3 RETURN x`);
const one = await cursor.next(); // 1
const two = await cursor.next(); // 2
const three = await cursor.next(); // 3
const empty = await cursor.next(); // undefined

Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.

example

const cursor = await db.query(
  aql`FOR i IN 1..10 RETURN i`,
  { batchSize: 5 }
);
const firstBatch = await cursor.nextBatch(); // [1, 2, 3, 4, 5]
await cursor.next(); // 6
const lastBatch = await cursor.nextBatch(); // [7, 8, 9, 10]
console.log(cursor.hasNext); // false