Index

Index( name, [database] )
Index( name, [database] )
Index( name, [database] )
Index( name, [database] )
index( name, [database] )
Index( 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

The name of an index.

database

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 following query gets a reference to the index named "spells_by_element":

try
{
    Value result = await client.Query(
        Index("spells_by_element")
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
RefV(id = "spells_by_element", collection = RefV(id = "indexes"))
result, err := client.Query(
	f.Index("spells_by_element"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
{spells_by_element 0xc00017c090 0xc00017c090 <nil>}
System.out.println(
    client.query(
        Index(Value("spells_by_element"))
    ).get());
ref(id = "spells_by_element", collection = ref(id = "indexes"))
client.query(
  q.Index('spells_by_element')
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
Index("spells_by_element")
result = client.query(
  q.index("spells_by_element")
)
print(result)
Ref(id=spells_by_element, collection=Ref(id=indexes))
try {
  println(Await.result(
    client.query(Index("spells_by_element")),
    5.seconds
  ))
} catch {
  case unknown: Throwable => println("Error: " + unknown.getMessage())
}
ref(id = "spells_by_element", collection = ref(id = "indexes"))

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!