指数
FirestoreAdmin
(界面)-
CreateIndexRequest
(消息) -
DeleteIndexRequest
(消息) -
ExportDocumentsMetadata
(消息) -
ExportDocumentsRequest
(消息) -
ExportDocumentsResponse
(消息) -
Field
(消息) -
Field.IndexConfig
(消息) -
FieldOperationMetadata
(消息) -
FieldOperationMetadata.IndexConfigDelta
(消息) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(枚举) -
GetFieldRequest
(消息) -
GetIndexRequest
(消息) -
ImportDocumentsMetadata
(消息) -
ImportDocumentsRequest
(消息) -
Index
(消息) -
Index.IndexField
(消息) -
Index.IndexField.ArrayConfig
(枚举) -
Index.IndexField.Order
(枚举) -
Index.QueryScope
(枚举) -
Index.State
(枚举) -
IndexOperationMetadata
(消息) -
ListFieldsRequest
(消息) -
ListFieldsResponse
(消息) -
ListIndexesRequest
(消息) -
ListIndexesResponse
(消息) -
OperationState
(枚举) -
Progress
(消息) -
UpdateFieldRequest
(消息)
Firestore管理员
操作由服务FirestoreAdmin
创建,但通过服务google.longrunning.Operations
访问。
创建索引 |
---|
创建复合索引。这会返回一个
|
删除索引 |
---|
删除复合索引。
|
出口单据 |
---|
将全部或部分文档的副本从 Google Cloud Firestore 导出到另一个存储系统,例如 Google Cloud Storage。最近对文档的更新可能不会反映在导出中。导出在后台进行,可以通过创建的操作资源监视和管理其进度。导出的输出只能在相关操作完成后才能使用。如果导出操作在完成之前取消,则可能会在 Google Cloud Storage 中留下部分数据。
|
获取字段 |
---|
获取字段的元数据和配置。
|
获取索引 |
---|
获取复合索引。
|
进口文件 |
---|
将文档导入 Google Cloud Firestore。现有的同名文档将被覆盖。导入在后台进行,可以通过创建的操作资源监视和管理其进度。如果取消 ImportDocuments 操作,则数据的子集可能已导入到 Cloud Firestore。
|
列表字段 |
---|
列出该数据库的字段配置和元数据。 目前,
|
列表索引 |
---|
列出复合索引。
|
更新字段 |
---|
更新字段配置。目前,字段更新仅适用于单字段索引配置。但是,对 此调用返回 要配置数据库的默认字段设置,请使用带有资源名称的特殊
|
创建索引请求
领域 | |
---|---|
parent | |
index | 要创建的复合索引。 |
删除索引请求
领域 | |
---|---|
name | 表单名称 |
导出文档元数据
来自FirestoreAdmin.ExportDocuments
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
operation_state | 出口操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
collection_ids[] | 正在导出哪些集合 ID。 |
output_uri_prefix | 实体导出到的位置。 |
出口文件请求
领域 | |
---|---|
name | 要导出的数据库。应采用以下形式: |
collection_ids[] | 要导出哪个集合 ID。未指定是指所有集合。 |
output_uri_prefix | 输出 URI。目前仅支持以下形式的 Google Cloud Storage URI: |
出口单据响应
在google.longrunning.Operation
响应字段中返回。
领域 | |
---|---|
output_uri_prefix | 输出文件的位置。这可用于在操作成功完成后开始导入 Cloud Firestore(此项目或另一个项目)。 |
场地
代表数据库中的单个字段。
字段按“集合组”分组,代表数据库中具有相同 id 的所有集合。
领域 | |
---|---|
name | 字段名称的形式 字段路径可以是简单的字段名称,例如 字段路径可以使用 示例:(注意:这里的注释是用 markdown 语法写的,所以多了一层反引号来表示代码块) 特殊 |
index_config | 该字段的索引配置。如果未设置,字段索引将恢复为 |
索引配置
该字段的索引配置。
领域 | |
---|---|
indexes[] | 该字段支持的索引。 |
uses_ancestor_config | 仅输出。当为 true 时, |
ancestor_field | 仅输出。指定 |
reverting | 仅输出 如果为 true,则 |
字段操作元数据
来自FirestoreAdmin.UpdateField
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
field | 此操作所作用的字段资源。例如: |
index_config_deltas[] | |
state | 操作的状态。 |
document_progress | 该操作的进展(以文件形式)。 |
bytes_progress | 此操作的进度(以字节为单位)。 |
索引配置增量
有关索引配置更改的信息。
领域 | |
---|---|
change_type | 指定索引如何变化。 |
index | 索引正在更改。 |
更改类型
指定索引如何变化。
枚举 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 更改的类型未指定或未知。 |
ADD | 正在添加单字段索引。 |
REMOVE | 单字段索引正在被删除。 |
获取字段请求
领域 | |
---|---|
name | 表单名称 |
获取索引请求
领域 | |
---|---|
name | 表单名称 |
导入文件元数据
来自FirestoreAdmin.ImportDocuments
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
operation_state | 导入操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
collection_ids[] | 正在导入哪些集合 ID。 |
input_uri_prefix | 正在导入的文档的位置。 |
进口文件请求
领域 | |
---|---|
name | 要导入的数据库。应采用以下形式: |
collection_ids[] | 要导入哪个集合 ID。未指定表示导入中包含的所有集合。 |
input_uri_prefix | 导出文件的位置。这必须与已成功完成导出的 ExportDocumentsResponse 的 output_uri_prefix 匹配。请参阅: |
指数
Cloud Firestore 索引支持对数据库中的文档进行简单和复杂的查询。
领域 | |
---|---|
name | 仅输出。服务器为此索引定义的名称。复合索引的名称格式为: |
query_scope | 指定集合查询范围的索引允许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有相同的集合 ID。 指定集合组查询范围的索引允许查询源自特定文档、在查询时指定且与该索引具有相同集合 ID 的所有集合。 |
fields[] | 该索引支持的字段。 对于复合索引,这始终是 2 个或更多字段。最后一个字段条目始终针对字段路径 对于单字段索引,这始终是一个字段路径等于关联字段的字段路径的条目。 |
state | 仅输出。索引的服务状态。 |
索引字段
索引中的一个字段。 field_path描述了哪个字段被索引,value_mode描述了字段值如何被索引。
领域 | |
---|---|
field_path | 可以是名字。对于单字段索引,它必须与字段名称匹配,也可以省略。 |
联合字段value_mode 。字段值的索引方式。 value_mode 只能是以下之一: | |
order | 表示该字段支持按指定顺序排序或使用=、<、<=、>、>=进行比较。 |
array_config | 表示该字段支持对 |
数组配置
支持的数组值配置。
枚举 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | 该索引不支持额外的数组查询。 |
CONTAINS | 索引支持数组包含查询。 |
命令
支持的订购。
枚举 | |
---|---|
ORDER_UNSPECIFIED | 顺序未指定。不是一个有效的选项。 |
ASCENDING | 该字段按字段值升序排序。 |
DESCENDING | 该字段按字段值降序排序。 |
查询范围
查询范围定义查询运行的范围。这是在 StructuredQuery 的from
字段上指定的。
枚举 | |
---|---|
QUERY_SCOPE_UNSPECIFIED | 查询范围未指定。不是一个有效的选项。 |
COLLECTION | 指定集合查询范围的索引允许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有由索引指定的集合 ID。 |
COLLECTION_GROUP | 指定集合组查询范围的索引允许查询具有索引指定的集合 ID 的所有集合。 |
状态
索引的状态。在索引创建过程中,索引将处于CREATING
状态。如果索引创建成功,则会转入READY
状态。如果索引创建遇到问题,索引将转换为NEEDS_REPAIR
状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定。 |
CREATING | 正在创建索引。该索引有一个活跃的长期运行操作。写入文档时索引会更新。可能存在一些索引数据。 |
READY | 该索引已准备好可供使用。写入文档时索引会更新。该索引完全由它所适用的所有存储文档填充。 |
NEEDS_REPAIR | 正在创建索引,但出了点问题。该索引没有活动的长时间运行操作,并且最近完成的长时间运行操作失败。写入文档时索引不会更新。可能存在一些索引数据。使用 google.longrunning.Operations API 确定上次尝试创建此索引的操作失败的原因,然后重新创建索引。 |
索引操作元数据
来自FirestoreAdmin.CreateIndex
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
index | 此操作所作用的索引资源。例如: |
state | 操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
列表字段请求
领域 | |
---|---|
parent | |
filter | 应用到列表结果的过滤器。目前, |
page_size | 要返回的结果数。 |
page_token | 页面令牌,从之前对 |
列表字段响应
领域 | |
---|---|
fields[] | 请求的字段。 |
next_page_token | 可用于请求另一页结果的页面令牌。如果空白,则这是最后一页。 |
列出索引请求
领域 | |
---|---|
parent | |
filter | 应用到列表结果的过滤器。 |
page_size | 要返回的结果数。 |
page_token | 页面令牌,从之前对 |
列表索引响应
领域 | |
---|---|
indexes[] | 请求的索引。 |
next_page_token | 可用于请求另一页结果的页面令牌。如果空白,则这是最后一页。 |
操作状态
描述操作的状态。
枚举 | |
---|---|
OPERATION_STATE_UNSPECIFIED | 未指定。 |
INITIALIZING | 正在准备处理请求。 |
PROCESSING | 正在积极处理请求。 |
CANCELLING | 用户对操作调用 google.longrunning.Operations.CancelOperation 后,请求正在取消。 |
FINALIZING | 请求已处理并处于最终确定阶段。 |
SUCCESSFUL | 请求已成功完成。 |
FAILED | 请求已完成处理,但遇到错误。 |
CANCELLED | 用户调用 google.longrunning.Operations.CancelOperation 后,请求已完成取消。 |
进步
描述操作的进度。工作单元是通用的,必须根据Progress
使用位置进行解释。
领域 | |
---|---|
estimated_work | 估计的工作量。 |
completed_work | 已完成的工作量。 |
更新字段请求
领域 | |
---|---|
field | 要更新的字段。 |
update_mask | 掩模,相对于场。如果指定,则只有此 field_mask 指定的配置才会在字段中更新。 |