Administra la retención de datos con políticas de TTL

En esta página, se describe cómo usar la consola de Google Cloud y Google Cloud CLI para configurar las políticas de tiempo de actividad (TTL). Antes de leer esta página, deberías comprender Modelo de datos de Firestore.

Descripción general del tiempo de actividad

Usa políticas de TTL para quitar automáticamente los datos inactivos de tus bases de datos. Una política de TTL designa un campo determinado como la hora de vencimiento de los documentos en un grupo de colecciones determinado. Con el TTL, puedes disminuir los costos de almacenamiento borrando los datos obsoletos. Por lo general, los datos se borran en un plazo de 24 horas después de su fecha de vencimiento.

Precios

Las operaciones de eliminación de TTL se tienen en cuenta para los costos de eliminación de documentos. Para conocer los precios de las operaciones de eliminación, consulta los precios de Firestore.

Límites y restricciones

  • Solo se puede marcar un campo por grupo de colecciones como campo TTL.
  • Se permite un total de 200 configuraciones a nivel de campo. La configuración de un campo puede contener múltiples configuraciones para el mismo campo. Por ejemplo, una exención de la indexación de campo único y una política de TTL en el mismo campo cuentan como una sola configuración para el límite.
  • Para los clientes de Firestore en modo Datastore, el TTL no se puede usar con un modo de simultaneidad Optimista con grupos de entidades. Considera cambiar el modo de simultaneidad al modo de simultaneidad optimista.

Eliminación del TTL

Ten en cuenta los siguientes comportamientos clave de la eliminación basada en el TTL:

  • La eliminación mediante el TTL no es un proceso instantáneo. Los documentos vencidos seguirán apareciendo en consultas y solicitudes de búsqueda hasta que el proceso del TTL los borre. El TTL cambia la puntualidad de la eliminación por el beneficio de un costo total de propiedad disminuido para las eliminaciones. Por lo general, los datos se borran en un plazo de 24 horas después de su fecha de vencimiento.

  • Si borras un documento a través del TTL, no se borrarán las subcolecciones de ese documento.

  • Aplicar una política de TTL en un grupo de colecciones existente genera una eliminación masiva de todos los datos vencidos de acuerdo con la política de TTL nueva. Ten en cuenta que esta eliminación masiva no es instantánea y depende de la cantidad de datos que existen para ese grupo de colecciones.

  • Si un documento tiene una fecha de vencimiento en el pasado y agregas una política TTL nueva a la colección, el documento se borrará en un plazo de 24 horas después de que la política TTL finalice la configuración y esté activa.

  • El TTL no necesariamente borra los documentos en el mismo orden que sus marcas de tiempo de vencimiento.

  • Las eliminaciones no se realizan de forma transaccional. Los documentos con el mismo tiempo de vencimiento no necesariamente se borran a la vez. Si necesitas este comportamiento, realiza las eliminaciones mediante una biblioteca cliente.

  • Firestore siempre respetará el último campo TTL para determinar el vencimiento. Por ejemplo, si se actualiza a una fecha posterior el campo TTL de un documento caducado, pero que aún no se borró, el documento no caducará y se utilizará la fecha nueva.

  • El TTL está diseñado para minimizar el impacto en otras actividades de la base de datos. Las eliminaciones que genera el TTL se tratan con una prioridad más baja. También se implementaron otras estrategias para limitar los aumentos repentinos de tráfico provenientes de las eliminaciones basadas en el TTL.

  • La eliminación a través del TTL llama a todos los objetos de escucha de instantáneas activos y enciende los activadores para Cloud Run de Firestore.

Índices y campos del TTL

Los campos del TTL se pueden indexar o no. Sin embargo, debido a que corresponden a marcas de tiempo, la indexación de los campos puede afectar el rendimiento cuando las tasas de tráfico son más altas. La indexación de un campo de marca de tiempo puede crear hotspots, lo que va en contra de las prácticas recomendadas. Los hotspots generan tasas altas de lectura, escritura y eliminación en un rango pequeño de documentos.

Según la configuración predeterminada, Firestore crea un índice de campo único para todos los campos. Puedes crear una exención de índice de campo único para inhabilitar los índices en un campo del TTL.

Permisos

La principal que configura una política de TTL requiere el siguiente permiso en el proyecto:

  • La visualización de las políticas de TTL requiere los permisos datastore.indexes.list y datastore.indexes.get.
  • La modificación de las políticas de TTL requiere el permiso datastore.indexes.update.
  • Verificar el estado de las operaciones del TTL requiere datastore.operations.list y datastore.operations.get.

Para conocer los roles que asignan estos permisos, consulta Roles de Identity and Access Management Firestore.

Antes de comenzar

Antes de usar la gcloud CLI para administrar las políticas de TTL, usa el comando gcloud components update a fin de actualizar los componentes a la última versión disponible:

gcloud components update

Crea una política de TTL

Cuando creas una política de TTL, designas un campo de documento como la hora de vencimiento para los documentos de un grupo de colecciones.

El TTL usa un campo especificado a fin de identificar los documentos aptos para borrarse. Este campo del TTL debe ser del tipo Date and time. Puedes seleccionar un campo que ya exista o designar un campo que planeas agregar más adelante.

Antes de configurar el valor del campo de TTL, ten en cuenta lo siguiente:

  • El valor del campo del TTL puede ser una hora actual, del futuro o del pasado. Si el valor es una hora del pasado, el documento es apto de inmediato para su eliminación. Por ejemplo, puedes crear una política de TTL con el campo expireAt, para luego agregarlo a los documentos existentes.

  • Si usas cualquier otro tipo de datos o no configuras el valor del campo del TTL, se inhabilitará el TTL del documento individual.

Para crear una nueva política de respuesta, sigue estos pasos:

Consola de Google Cloud

  1. En la consola de Google Cloud, ve a la página Bases de datos.

    Ir a Bases de datos

  2. Selecciona la base de datos requerida de la lista.

  3. En el menú de navegación, haz clic en Tiempo de actividad.

  4. Haz clic en Crear política.

  5. Ingresa un nombre para el grupo de colecciones y otro para el campo de la marca de tiempo.

  6. Haz clic en Crear.

La consola regresa a la página Tiempo de actividad. Si la operación se inicia correctamente, la página agrega una entrada a la tabla de políticas de TTL. Si se produce un error, la página muestra un mensaje de error.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Usa el comando firestore fields ttls update para configurar una política de TTL. Agrega la marca --async para evitar que la gcloud CLI espere a que se complete la operación.

     gcloud firestore fields ttls update
ttl_field --collection-group=collection_group_name
--enable-ttl

Duración de la habilitación de la política de TTL

Incluso en una base de datos vacía, la política de TTL puede tardar diez minutos o más en habilitarse. Cuando inicies la operación, esta no se cancelará si cierras la terminal.

Ve las políticas de TTL

Para ver las políticas de TTL y sus estados, sigue estos pasos:

Consola de Google Cloud

  1. En la consola de Google Cloud, ve a la página Bases de datos.

    Ir a Bases de datos

  2. Selecciona la base de datos requerida de la lista.

  3. En el menú de navegación, haz clic en Tiempo de actividad.

La consola enumera las políticas de TTL para tu base de datos y, además, incluye el estado de cada política.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Usa el comando firestore fields ttls list para configurar una política de TTL. El siguiente comando enumera todas las políticas de TTL.

    gcloud firestore fields ttls list

    Para enumerar las políticas de TTL de un grupo de colecciones específico, usa el siguiente código:

    gcloud firestore fields ttls list  --collection-group=collection_group_name

View operation details

You can use the gcloud CLI to view more details about a TTL policy that is in the CREATING state.

Use the operations list command to see all running and recently completed operations:

gcloud firestore operations list

La respuesta incluye una estimación del progreso de la operación.

Inhabilita una política de TTL

Para inhabilitar una política de TTL, sigue estos pasos:

Consola de Google Cloud

  1. En la consola de Google Cloud, ve a la página Bases de datos.

    Ir a Bases de datos

  2. Selecciona la base de datos requerida de la lista.

  3. En el menú de navegación, haz clic en Tiempo de actividad.

  4. En la tabla de políticas de TTL, busca la fila correspondiente. En esta fila de la tabla, haz clic en el botón Borrar (papelera).

  5. Haz clic en Borrar para confirmar la acción.

La consola regresa a la página Tiempo de actividad. Si se ejecuta de forma correcta, Firestore quita la política de TTL de la tabla.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Usa el comando firestore fields ttls update para configurar una política de TTL. Agrega la marca --async para evitar que la gcloud CLI espere a que se complete la operación.

    gcloud firestore fields ttls update ttl_field --collection-group=collection_group_name --disable-ttl

Supervisa las eliminaciones del TTL

Puedes usar Cloud Monitoring para ver las métricas sobre las eliminaciones basadas en el TTL. Firestore proporciona las siguientes métricas para el TTL:

Tipo de métrica Nombre de la métrica Descripción de la métrica
firestore.googleapis.com/document/ttl_deletion_count Recuento de eliminaciones del tiempo de actividad

Recuento total de documentos borrados por las políticas de TTL.
firestore.googleapis.com/document/ttl_expiration_to_deletion_delays Retrasos entre el vencimiento del tiempo de actividad y la eliminación

Tiempo transcurrido entre el vencimiento de un documento conforme a la política de TTL y el momento en que se borró.

Para configurar un panel con las métricas de Firestore, consulta Cómo administrar un panel personalizado y Cómo agregar widgets al panel.