FieldOperationMetadata

来自 FirestoreAdmin.UpdateFieldgoogle.longrunning.Operation 结果的元数据。

JSON 表示法
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
字段
startTime

string (Timestamp format)

此操作开始的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

endTime

string (Timestamp format)

此操作完成的时间。如果操作仍在进行中,则取消设置。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

field

string

此操作对的字段资源。例如:projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

IndexConfigDelta 列表,用于描述此操作的意图。

state

enum (OperationState)

操作的状态。

progressDocuments

object (Progress)

此操作的进度(以文档为单位)。

progressBytes

object (Progress)

此操作的进度(以字节为单位)。

ttlConfigDelta

object (TtlConfigDelta)

描述 TTL 配置的增量。

索引配置增量

索引配置更改的相关信息。

JSON 表示法
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
字段
changeType

enum (ChangeType)

指定索引的更改方式。

index

object (Index)

更改的索引。

索引

Cloud Firestore 索引支持对数据库中的文档执行简单和复杂的查询。

JSON 表示法
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
字段
name

string

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

queryScope

enum (QueryScope)

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

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

apiScope

enum (ApiScope)

此索引支持的 API 范围。

fields[]

object (IndexField)

此索引支持的字段。

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

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

state

enum (State)

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

IndexField

索引中的字段。fieldPath 用于说明哪个字段已编入索引,而 value_mode 用于说明将字段值编入索引的方式。

JSON 表示法
{
  "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.
}
字段
fieldPath

string

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

联合字段 value_mode。如何将字段值编入索引。value_mode 只能是下列其中一项:
order

enum (Order)

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

arrayConfig

enum (ArrayConfig)

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

vectorConfig

object (VectorConfig)

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

VectorConfig

用于支持矢量搜索操作的索引配置

JSON 表示法
{
  "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.
}
字段
dimension

integer

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

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

联合字段 type。所用索引的类型。type 只能是下列其中一项:
flat

object (FlatIndex)

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

平面索引

此类型没有字段。

一种索引,用于将向量存储在平面数据结构中,并支持详尽搜索。

TtlConfigDelta

有关 TTL 配置更改的信息。

JSON 表示法
{
  "changeType": enum (ChangeType)
}
字段
changeType

enum (ChangeType)

指定 TTL 配置的更改方式。