Take

Take( num, array )
Take( num, array )
Take( num, array )
Take( num, array )
take( num, array )
Take( num, array )

Description

The Take function returns a new array of the same type that contains num elements from the head of the provided array. If num is zero or negative, the resulting array is empty.

When applied to a Page, the returned page’s "after" cursor is adjusted to only cover the taken elements. As special cases:

  • If num is negative, after is set to the same value as the original page’s "before".

  • If all elements from the original page were taken, after does not change.

Parameters

Argument Type Definition and Requirements

array

Array or Page

Extract elements from this array.

num

Integer

The number of elements to extract from the beginning of the array.

Returns

A new array of the same type with the first num elements.

Examples

The query below creates a new array containing copies of the first two elements of the array’s argument.

client.Query(Take(2, Arr(1, 2, 3)));
[ 1, 2 ]
curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{ "take": 2, "collection": [ 1, 2, 3 ] }'
HTTP/1.1 200 OK
{ "resource": [ 1, 2 ] }
result, _ := client.Query(f.Take(2, f.Arr{1, 2, 3}))

fmt.Println(result)
[1 2]
System.out.println(
        client.query(
                Take(Value(2), Arr(Value(1), Value(2), Value(3))
                )
        ).get());
[1, 2]
client.query(
  q.Take(2, [1, 2, 3])
)
.then((ret) => console.log(ret))
[ 1, 2 ]
client.query(q.take(2, [1, 2, 3]))
[ 1, 2 ]
client.query(Take(2, Arr(1, 2, 3)))
[ 1, 2 ]

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!