FieldOperationMetadata

{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}

enum (ChangeType)

指定索引的更改方式。

object (Index)

更改的索引。

{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

仅限输出。服务器为此索引定义的名称。复合索引此名称的格式为：projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}。对于单字段索引，此字段将为空。

enum (QueryScope)

指定了集合查询范围的索引允许针对作为特定文档子项、在查询时指定且具有相同集合 ID 的集合进行查询。

指定了集合组查询范围的索引允许查询来自特定文档、在查询时指定且与此索引具有相同集合 ID 的所有集合。

enum (ApiScope)

此索引支持的 API 范围。

object (IndexField)

此索引支持的字段。

对于复合索引，至少需要 2 个字段，最多 100 个字段。最后一个字段条目始终针对字段路径 __name__。如果在创建时，没有将 __name__ 指定为最后一个字段，系统会自动按照所定义的最后一个字段的方向添加该字段。如果复合索引中的最后一个字段没有方向性，则 __name__ 将按升序排序（除非明确指定）。

对于单字段索引，这始终是且只有一个条目，其字段路径等于关联字段的字段路径。

enum (State)

仅限输出。索引的服务状态。

{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}

string

可以是 name。对于单字段索引，此字段必须与字段的名称匹配，也可以省略。

enum (Order)

表示此字段支持按指定顺序排序或使用 =、!=、<、<=、>、>= 进行比较。

enum (ArrayConfig)

表示此字段支持对 arrayValue 执行操作。

object (VectorConfig)

表示此字段支持矢量的最近邻和距离运算。

{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}

integer

必需。此配置适用的矢量维度。

生成的索引将仅包含该维度的向量，并且可用于具有相同维度的向量搜索。

object (FlatIndex)

表示矢量索引是平面索引。

{
  "changeType": enum (ChangeType)
}

enum (ChangeType)

指定 TTL 配置的更改方式。