Method patchField

src/firestore/api.ts:457–498

* Update the configuration of a field. Note that this kicks off a long-running * operation for index creation/deletion so the update is complete when this * method returns. * @param project the Firebase project. * @param spec the new field override specification.

(
    project: string,
    spec: Spec.FieldOverride,
    databaseId = "(default)",
  )

   * @param spec the new field override specification.
   */
  async patchField(
    project: string,
    spec: Spec.FieldOverride,
    databaseId = "(default)",
  ): Promise<any> {
    const url = `/projects/${project}/databases/${databaseId}/collectionGroups/${spec.collectionGroup}/fields/${spec.fieldPath}`;

    const indexes = spec.indexes.map((index) => {
      return {
        queryScope: index.queryScope,
        apiScope: index.apiScope,
        density: index.density,
        multikey: index.multikey,
        unique: index.unique,
        fields: [
          {
            fieldPath: spec.fieldPath,
            arrayConfig: index.arrayConfig,
            order: index.order,
          },
        ],
      };
    });

    let data = {
      indexConfig: {
        indexes,
      },
    };

    if (spec.ttl) {
      data = Object.assign(data, {
        ttlConfig: {},
      });
    }

    if (typeof spec.ttl !== "undefined") {
      await this.apiClient.patch(url, data);
    } else {
      await this.apiClient.patch(url, data, { queryParams: { updateMask: "indexConfig" } });
    }
  }

  /**
   * Delete an existing field overrides on the specified project.