Gestisci la conservazione dei dati con i criteri TTL

Questa pagina descrive come utilizzare la console Google Cloud e Google Cloud CLI per configurare i criteri di durata (TTL). Prima di leggere questa pagina, dovresti conoscere Modello dei dati Firestore.

Panoramica della durata

Usa i criteri TTL per eseguire automaticamente per rimuovere i dati inattivi dai tuoi database. Un criterio TTL designa un determinato campo come la scadenza dei documenti di un determinato gruppo di raccolte. Con il TTL, puoi ridurre i costi di archiviazione eliminando i dati obsoleti. In genere i dati vengono eliminati entro 24 ore dalla data di scadenza.

Prezzi

Le operazioni di eliminazione TTL vengono conteggiate ai fini dei costi di eliminazione dei documenti. Per i prezzi delle operazioni di eliminazione, consulta i prezzi di Firestore.

Limiti e vincoli

  • È possibile contrassegnare come campo TTL un solo campo per gruppo di raccolte.
  • È consentito un totale di 200 configurazioni a livello di campo. Configurazione in un campo può contenere più configurazioni per lo stesso campo. Ad esempio: un'esenzione dell'indicizzazione a campo singolo e un criterio TTL nello stesso campo vengono conteggiati come la configurazione di un campo per raggiungere il limite.
  • Per i clienti di Firestore in modalità Datastore, il TTL non può essere utilizzato con una modalità di contemporaneità di Ottimista con i gruppi di entità. Valuta la possibilità di cambiare la modalità di contemporaneità in Modalità di contemporaneità ottimistica.

Eliminazione TTL

Nota i seguenti comportamenti chiave dell'eliminazione basata su TTL:

  • L'eliminazione tramite TTL non è un processo istantaneo. Documenti scaduti continuano ad apparire nelle query e nelle richieste di ricerca finché il processo TTL le elimina. Il TTL scambia la tempestività dell'eliminazione a vantaggio di riduzione del costo totale di proprietà per le eliminazioni. In genere i dati vengono eliminati entro 24 ore dalla data di scadenza.

  • L'eliminazione di un documento tramite TTL non elimina le sottoraccolte al suo interno documento.

  • L'applicazione di un criterio TTL a un gruppo di raccolte esistente genera una raccolta collettiva Eliminazione di tutti i dati scaduti in base al nuovo criterio TTL. Nota che anche questa eliminazione collettiva non è istantanea e dipende dalla quantità di dati esiste per quel gruppo di raccolte.

  • Se un documento ha una data di scadenza già trascorsa e aggiungi un nuovo criterio TTL alla raccolta, il documento verrà eliminato entro 24 ore da quando il criterio TTL termina la configurazione e diventa attivo.

  • Il TTL non elimina necessariamente i documenti nello stesso ordine i timestamp di scadenza.

  • Le eliminazioni non vengono eseguite a livello transazionale. Documenti con la stessa scadenza non vengono necessariamente eliminati nello stesso momento. Per necessità esegui le eliminazioni utilizzando una libreria client.

  • Firestore rispetta sempre il campo TTL più recente per determinare la scadenza del periodo di conservazione. Ad esempio, se un documento scaduto ma non ancora eliminato presenta la sua campo TTL aggiornato a una data successiva, il documento non sarà scaduto e verrà utilizzata la nuova data.

  • Il TTL è progettato per ridurre al minimo l'impatto su altre attività di database. Eliminazioni basate su TTL vengono trattate con una priorità più bassa. Altre strategie sono per attenuare i picchi di traffico causati dalle eliminazioni basate su TTL.

  • Eliminazione tramite chiamate TTL tutte attive listener di snapshot e attiva le funzioni Cloud Functions Trigger di Firestore.

Campi e indici TTL

Un campo TTL può essere indicizzato o meno. Tuttavia, poiché un campo TTL è un timestamp, l'indicizzazione del campo può influire sulle prestazioni con frequenze di traffico più elevate. L'indicizzazione di un campo timestamp può creare hotspot, che vanno contro le best practice. Gli hotspot sono elevate velocità di lettura, scrittura ed eliminazione in un intervallo di documenti ristretto.

Per impostazione predefinita, Firestore crea un indice a campo singolo per tutti i campi. Puoi crea un'esenzione dell'indice a campo singolo per disabilitare gli indici in un campo TTL.

Autorizzazioni

L'entità che configura un criterio TTL richiede la seguente autorizzazione nel campo progetto:

  • La visualizzazione dei criteri TTL richiede datastore.indexes.list e datastore.indexes.get autorizzazioni.
  • La modifica dei criteri TTL richiede il datastore.indexes.update autorizzazione.
  • Il controllo dello stato delle operazioni TTL richiede datastore.operations.list e datastore.operations.get.

Per i ruoli che assegnano queste autorizzazioni, vedi Ruoli di Identity and Access Management di Firestore.

Prima di iniziare

Prima di utilizzare gcloud CLI per gestire i criteri TTL, utilizza gcloud components update per aggiornare i componenti all'ultima versione disponibile:

gcloud components update

Crea un criterio TTL

Quando crei un criterio TTL, designi un campo documento come scadenza per i documenti di un gruppo di raccolte.

Il TTL utilizza un campo specificato per identificare i documenti idonei per l'eliminazione. Questo campo TTL deve essere di tipo Date and time. Puoi selezionare un campo esiste già o puoi designare un campo che prevedi di aggiungere in un secondo momento.

Prima di impostare il valore del campo TTL, considera quanto segue:

  • Il valore del campo TTL può essere un'ora nel futuro, nel presente o nel passato. Se il valore è un'ora In passato, il documento risultava immediatamente idoneo per l'eliminazione. Ad esempio, potrebbe creare un criterio TTL con il campo expireAt, che in seguito aggiungerai documenti esistenti.

  • Se utilizzi qualsiasi altro tipo di dati o non imposti il valore del campo TTL, il TTL per il singolo documento verrà disabilitato.

Per creare un criterio TTL:

Google Cloud Console

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Durata.

  4. Fai clic su Crea criterio.

  5. Inserisci un nome per il gruppo di raccolte e un nome per il campo del timestamp.

  6. Fai clic su Crea.

La console torna alla pagina Durata. Se l'operazione viene avviato correttamente, la pagina aggiunge una voce alla tabella dei criteri TTL. Attivato l'errore, la pagina visualizza un messaggio di errore.

gcloud

  1. Nella console Google Cloud, attiva Cloud Shell.

    Attiva Cloud Shell

    Nella parte inferiore della console Google Cloud viene avviata una sessione di Cloud Shell che mostra un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installato e con valori già impostati per il progetto attuale. L'inizializzazione della sessione può richiedere alcuni secondi.

  2. Utilizza la firestore fields ttls update per configurare un criterio TTL. Aggiungi il flag --async per evitare che a gcloud CLI di non attendere il completamento dell'operazione.

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

Durata dell'abilitazione dei criteri TTL

Anche su un database vuoto, l'abilitazione di un TTL può richiedere 10 minuti o più . Una volta avviata un'operazione, la chiusura del terminale non annulla operativa.

Visualizza criteri TTL

Per visualizzare i criteri TTL e il relativo stato:

Google Cloud Console

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Durata.

La console elenca i criteri TTL per il tuo database e include i .

gcloud

  1. Nella console Google Cloud, attiva Cloud Shell.

    Attiva Cloud Shell

    Nella parte inferiore della console Google Cloud viene avviata una sessione di Cloud Shell che mostra un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installato e con valori già impostati per il progetto attuale. L'inizializzazione della sessione può richiedere alcuni secondi.

  2. Utilizza la firestore fields ttls list per configurare un criterio TTL. Il comando seguente elenca tutti i TTL criteri.

    gcloud firestore fields ttls list
    

    Per elencare i criteri TTL all'interno di un gruppo di raccolte specifico, utilizza quanto segue:

    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 risposta include una stima dell'avanzamento dell'operazione.

Disabilita un criterio TTL

Per disattivare un criterio TTL:

Google Cloud Console

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Durata.

  4. Nella tabella dei criteri TTL, individua la riga relativa al criterio TTL. All'interno di questo fai clic sul pulsante Elimina (cestino).

  5. Conferma facendo clic su Elimina.

La console torna alla pagina Durata. Se il successo è successo, Firestore rimuove il criterio TTL dalla tabella.

gcloud

  1. Nella console Google Cloud, attiva Cloud Shell.

    Attiva Cloud Shell

    Nella parte inferiore della console Google Cloud viene avviata una sessione di Cloud Shell che mostra un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installato e con valori già impostati per il progetto attuale. L'inizializzazione della sessione può richiedere alcuni secondi.

  2. Utilizza la firestore fields ttls update per configurare un criterio TTL. Aggiungi il flag --async per evitare che a gcloud CLI di non attendere il completamento dell'operazione.

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

Monitora le eliminazioni TTL

Puoi utilizzare Cloud Monitoring per visualizzare le metriche relative alle eliminazioni basate su TTL. Firestore fornisce le seguenti metriche per il TTL:

Tipo di metrica Nome metrica Descrizione della metrica
firestore.googleapis.com/document/ttl_deletion_count Conteggio eliminazioni time-to-live

Conteggio totale dei documenti eliminati dai criteri TTL.

firestore.googleapis.com/document/ttl_expiration_to_deletion_delays Scadenza della durata (TTL) per i ritardi di eliminazione

Tempo trascorso tra la scadenza di un documento in base a un TTL e quando è stato effettivamente eliminato.

Per configurare una dashboard con metriche Firestore, consulta gestire dashboard personalizzate e aggiungere widget della dashboard.