Index

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.
Copied!
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

Parameter 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

  1. The following query gets a reference to the index named "spells_by_element" in the current database:

    Copied!
    Index('spells_by_element')
    Index("spells_by_element")
    Query metrics:

    •    bytesIn:  29

    •   bytesOut:  87

    • computeOps:   1

    •    readOps:   0

    •   writeOps:   0

    •  readBytes:   0

    • writeBytes:   0

    •  queryTime: 4ms

    •    retries:   0

  2. The following query gets a Reference to the index named "spells_by_element" in a child database named "child_db":

    Copied!
    Index('spells_by_element', Database('child_db'))
    Index("spells_by_element", Database("child_db"))
    Query metrics:

    •    bytesIn:  61

    •   bytesOut: 166

    • computeOps:   1

    •    readOps:   0

    •   writeOps:   0

    •  readBytes: 155

    • writeBytes:   0

    •  queryTime: 8ms

    •    retries:   0

\