HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/lib/surface/firestore/indexes/fields/describe.yaml
- release_tracks: [ALPHA, BETA, GA]
  help_text:
    brief: Describe the index configuration of the given field.
    description: Describe the index configuration of the given field.
    examples: |
      The following command describes the database-wide default index settings:

        $ {command}

        $ {command} --database=(default)

      The following command describes the index configuration of the `timestamp` field in the
      `Events` collection group.

        $ {command} timestamp --collection-group=Events

  request:
    collection: firestore.projects.databases.collectionGroups.fields
    modify_request_hooks:
    - googlecloudsdk.command_lib.firestore.util:ValidateFieldArg

  arguments:
    resource:
      help_text: |
        Field to describe.

        This can be omitted to describe the database-wide default index settings.
      spec: !REF googlecloudsdk.command_lib.firestore.resources:field_with_default

  output:
    # Note the .yesno() here allows us to handle a field with all indexes disabled by explicitly
    # showing an empty table, as opposed to omitting the table from the display.
    format: |
      table[box](
        name.segment(-1):label=FIELD,
        name.segment(-3):label=COLLECTION_GROUP,
        indexConfig:format="table[box](
          ancestorField)",
        indexConfig.indexes.yesno(no="{}"):format="table[title=INDEXES,box](
          fields.order.flatten(),fields.arrayConfig.flatten(),queryScope,state)")