gcloud beta firestore fields ttls update

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 theexpiry field of theEvents collection group (kind) to be the TTL field:
gcloudbetafirestorefieldsttlsupdateexpiry--collection-group=Events--enable-ttl

The following command disables theexpiry field so it is no longerthe TTL for theEvents collection 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 theproject attribute:

  • provide the argumentfield on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

FIELD
ID of the field or fully qualified identifier for the field.

To set thefield attribute:

  • provide the argumentfield on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--collection-group=COLLECTION_GROUP
Collection group of the field.To set thecollection-group attribute:
  • provide the argumentfield on the command line with a fullyspecified name;
  • provide the argument--collection-group on the command line.
--database=DATABASE
Database of the field.To set thedatabase attribute:
  • provide the argumentfield on the command line with a fullyspecified name;
  • provide the argument--database on the command line;
  • the default value of argument [--database] is(default).
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.
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 help for details.

API REFERENCE
This command uses thefirestore/v1 API. 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:
gcloudfirestorefieldsttlsupdate
gcloudalphafirestorefieldsttlsupdate

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.