gcloud beta firestore fields ttls update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta firestore fields ttls update - update the TTL configuration of the given field
- SYNOPSIS
gcloud beta firestore fields ttls update(FIELD:--collection-group=COLLECTION_GROUP--database=DATABASE)(--disable-ttl|--enable-ttl)[--async][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Update the TTL configuration of the given field.This enables or disables using a field as the TTL field for its collection groupor kind. Note that only one field can be the TTL field for a collection group.
- EXAMPLES
- The following command sets the
expiryfield of theEventscollection group (kind) to be the TTL field:gcloudbetafirestorefieldsttlsupdateexpiry--collection-group=Events--enable-ttlThe following command disables the
expiryfield so it is no longerthe TTL for theEventscollection group (kind):gcloudbetafirestorefieldsttlsupdateexpiry--collection-group=Events--disable-ttl - POSITIONAL ARGUMENTS
- Field resource - Field to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
fieldon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
FIELD- ID of the field or fully qualified identifier for the field.
To set the
fieldattribute:- provide the argument
fieldon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--collection-group=COLLECTION_GROUP- Collection group of the field.To set the
collection-groupattribute:- provide the argument
fieldon the command line with a fullyspecified name; - provide the argument
--collection-groupon the command line.
- provide the argument
--database=DATABASE- Database of the field.To set the
databaseattribute:- provide the argument
fieldon the command line with a fullyspecified name; - provide the argument
--databaseon the command line; - the default value of argument [--database] is
(default).
- provide the argument
- provide the argument
- Field resource - Field to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- REQUIRED FLAGS
- Exactly one of these must be specified:
--disable-ttl- Set to make this field no longer the TTL for its collection group.
--enable-ttl- Set to enable this field as the TTL for its collection group.
- Exactly one of these must be specified:
- OPTIONAL FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
firestore/v1API. The full documentation forthis API can be found at:https://cloud.google.com/firestore - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudfirestorefieldsttlsupdategcloudalphafirestorefieldsttlsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.