Index

Copied!
( name, [database] )

Description

The Index function returns a valid Reference for the specified index name in the specified child database. If a child database is not specified, the returned index reference belongs to the current database.

When a child database is specified, an admin key must be used to call Index (server or client keys, or ABAC tokens, cannot be used to access a child database).

Parameters

Argument Type Definition and Requirements

name

String

The name of an index.

database

Reference

Optional - A reference to a child database. If not specified, the current database is used.

Returns

A reference to an index with the specified name, in the specified child database (or the current database if database is not specified).

Examples

The query below gets a reference to the index named "spells_by_element".

Copied!
client.query(q.('spells_by_element'))
.then((ret) => console.log(ret))
(id=spells_by_element, collection=(id=indexes))

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!