Index interface

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Em vez de criar índices de cache manualmente, considere usar enablePersistentCacheIndexAutoCreation() para permitir que o SDK decida se deseja criar índices de cache para consultas executadas localmente.

A definição do SDK de um índice do Firestore.

Assinatura:

export declare interface Index 

Propriedades

Propriedade Tipo Descrição
grupo de coleção corda (BETA) O ID da coleção a ser indexada.
Campos CampoIndex [] (BETA) Uma lista de campos a serem indexados.

Index.collectionGroup

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

O ID da coleção a ser indexada.

Assinatura:

readonly collectionGroup: string;

Campos de índice

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Uma lista de campos a serem indexados.

Assinatura:

readonly fields?: IndexField[];