Administra índices

Firestore garantiza el rendimiento de las consultas, ya que usa índices en todas ellas. Los índices necesarios para las consultas más básicas se crean de forma automática. A medida que usas y pruebas tu app, Cloud Firestore genera mensajes de error que te ayudan a crear los índices adicionales necesarios. En esta página, se describe cómo administrar los índices de campo único y compuestos.

Crea un índice faltante a través de un mensaje de error

Si intentas realizar una consulta compuesta con una cláusula de rango que no corresponda a un índice existente, recibirás un error. En el mensaje de error, se incluye un vínculo directo para crear el índice que falta en Firebase console.

Usa el vínculo generado para ir a Firebase console, revisa la información que se propagó deforma automática y haz clic en Crear.

Usa Google Cloud Platform Console

Desde Google Cloud Platform Console, puedes administrar las exenciones para la indexación de los campos únicos y los índices compuestos.

Crea un índice compuesto

Para crear manualmente un índice compuesto nuevo desde GCP Console, sigue estos pasos:

  1. Ve a la sección Índices compuestos.

    Ir a la sección Índices compuestos

  2. Haz clic en Crear índice.

  3. Ingresa un ID de colección. Agrega los nombres de los campos que deseas indexar y un modo de índice para cada campo. Haz clic en Guardar índice.

Tu índice nuevo aparecerá en la lista de índices compuestos y Firestore comenzará a crear el índice. Cuando termine de crearse, verás una marca de verificación verde junto al índice.

Cómo borrar un índice compuesto

Para borrar un índice compuesto, sigue estos pasos:

  1. Ve a la sección Índices compuestos.

    Ir a la sección Índices compuestos

  2. En la lista de índices compuestos, haz clic en la entrada del índice que quieres borrar. Haz clic en Borrar.

  3. Para confirmar que deseas borrar este índice, haz clic en Borrar índice en la alerta.

Agrega una exención de índice de campo único

Las exenciones de índices de campo único te permiten anular la configuración automática de los índices en campos específicos de una colección. Para agregar exenciones de campo único desde la consola, sigue estos pasos:

  1. Ve a la sección Índices de campo único.

    Ir a la página Índices de campo único

  2. Haz clic en Agregar exención.

  3. Ingresa un ID de colección y una ruta de campo.

  4. Selecciona una configuración de indexación nueva para este campo. Habilita o inhabilita automáticamente los índices ascendentes, descendentes y de campo único de arreglos actualizados para este campo.

  5. Haz clic en Guardar exención.

Borra una exención de índice de campo único

Para borrar una exención de índice de campo único, sigue estos pasos:

  1. En el visor de Firestore, ve a la sección Índices de campo único.

    Ir a la página Índices de campo único

  2. Haz clic en Agregar exención.

  3. Ingresa un ID de colección y una nombre de campo.

  4. En la lista de exenciones de índice de campo único, haz clic en la entrada de la exención que deseas borrar. Haz clic en Borrar.

  5. Para confirmar que deseas borrar esta exención, haz clic en Eliminar exención en la alerta.

Cuando borras una exención de campo único, el subcampo o campo especificado usará la configuración de indexación heredada. Los campos de documentos vuelven a la configuración automática de índice de la base de datos. Los subcampos de un mapa heredan las exenciones de los campos superiores antes de heredar la configuración automática de índice.

Usa Firebase CLI

También puedes implementar índices con Firebase CLI. Para comenzar, ejecuta firebase init firestore en el directorio de tu proyecto. Durante la configuración, Firebase CLI genera un archivo JSON con los índices predeterminados en el formato correcto. Edita el archivo para agregar más índices y, luego, impleméntalo con el comando firebase deploy. Si solo deseas implementar índices, agrega la marca --only firestore:indexes. Si haces modificaciones en los índices con Firebase console, asegúrate de actualizar también tu archivo de índices local. Consulta la referencia de definición de índice JSON.

Tiempo de compilación de índices

Para compilar un índice, Firestore debe configurar el índice y, luego, reabastecerlo con los datos existentes. El tiempo de compilación del índice es la suma del tiempo de configuración y el tiempo de reabastecimiento:

  • La configuración de un índice tarda unos minutos. El tiempo de compilación mínimo de un índice es de unos minutos, incluso para una base de datos vacía.

  • El tiempo de reabastecimiento depende de la cantidad de datos existentes en el índice nuevo. Cuantos más valores de campo coincidan con la definición del índice, más tiempo tardará en reabastecerse el índice.

Las compilaciones de índices son operaciones de larga duración.

Después de iniciar una compilación de índice, Firestore le asigna un nombre único a la operación. Los nombres de las operaciones incluyen el prefijo projects/[PROJECT_ID]/databases/(default)/operations/. Por ejemplo:

projects/project-id/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Sin embargo, puedes omitir el prefijo cuando especifiques el nombre de una operación para el comando describe.

Enumera todas las operaciones de larga duración

Para enumerar las operaciones de larga duración, usa el comando gcloud firestore operations list. Este comando enumera las operaciones en curso y las que se completaron recientemente. Las operaciones se enumeran durante algunos días luego de completarse:

gcloud firestore operations list

Verifica el estado de la operación

En lugar de enumerar todas las operaciones de larga duración, puedes enumerar los detalles de una sola operación:

gcloud firestore operations describe operation-name

Estima la hora de finalización

A medida que se ejecuta tu operación, mira el valor del campo state para conocer el estado general.

Una solicitud del estado de una operación de larga duración también muestra las métricas workEstimated y workCompleted. Estas métricas se muestran para la cantidad de documentos. workEstimated muestra la cantidad total estimada de documentos que procesará una operación. workCompleted muestra la cantidad de documentos procesados hasta el momento. Una vez que se completa la operación, workCompleted refleja la cantidad total de documentos que se procesaron, que podría ser diferente del valor de workEstimated.

Divide workCompleted entre workEstimated para obtener una estimación aproximada del progreso. Es posible que la estimación sea inexacta, ya que depende de la demora en la recopilación de estadísticas.

Por ejemplo, este es el estado de progreso de una compilación de índice:

{
  "operations": [
    {
      "name": "projects/project-id/operations/AyAyMDBiM2U5NTgwZDAtZGIyYi0zYjc0LTIzYWEtZjg1ZGdWFmZWQHEjF0c2Flc3UtcmV4ZWRuaS1uaW1kYRUKSBI",
      "metadata": {
        "@type": "type.googleapis.com/google.firestore.admin.v1.IndexOperationMetadata",
        "common": {
          "operationType": "CREATE_INDEX",
          "startTime": "2020-06-23T16:52:25.697539Z",
          "state": "PROCESSING"
        },
        "progressDocuments": {
          "workCompleted": "219327",
          "workEstimated": "2198182"
        }
       },
    },
    ...

Cuando se realiza una operación, su descripción contendrá "done": true. Consulta el valor del campo state para ver el resultado de la operación. Si el campo done no está establecido en la respuesta, su valor es false. No dependas de la existencia del valor done para las operaciones en curso.

Errores en la compilación de índices

Es posible que encuentres errores en la compilación de los índices cuando administres índices compuestos y exenciones de índices de campo único. Una operación de indexación puede fallar si Firestore encuentra un problema en los datos que se están indexando. Por lo general, esto quiere decir que alcanzaste el límite de índices. Por ejemplo, es posible que la operación haya alcanzado la cantidad máxima de entradas permitidas en un índice de un documento.

Si falla la creación de los índices, aparecerá un mensaje de error en la consola. Luego de verificar que no alcanzaste ningún límite de índices, reintenta la operación de índices.