指数
FirestoreAdmin
(界面)-
CreateIndexRequest
(消息) -
DeleteIndexRequest
(消息) -
ExportDocumentsMetadata
(消息) -
ExportDocumentsRequest
(消息) -
ExportDocumentsResponse
(消息) -
GetIndexRequest
(消息) -
ImportDocumentsMetadata
(消息) -
ImportDocumentsRequest
(消息) -
Index
(消息) -
Index.State
(枚举) -
IndexField
(消息) -
IndexField.Mode
(枚举) -
IndexOperationMetadata
(消息) -
IndexOperationMetadata.OperationType
(枚举) -
ListIndexesRequest
(消息) -
ListIndexesResponse
(消息) -
LocationMetadata
(消息) -
OperationState
(枚举) -
Progress
(消息)
Firestore管理员
Cloud Firestore 管理 API。
此 API 为 Cloud Firestore 提供多种管理服务。
概念
项目、数据库、命名空间、集合和文档按照 Google Cloud Firestore API 中的定义使用。
操作:操作表示在后台执行的工作。
服务
指数
索引服务管理 Cloud Firestore 索引。
索引创建是异步执行的。为每个此类异步操作创建一个操作资源。操作的状态(包括遇到的任何错误)可以通过操作资源查询。
元数据
提供有关 Cloud Firestore 中数据的元数据和统计信息。作为此 API 的一部分提供的数据可能已过时。
手术
操作集合提供对指定项目执行的操作的记录(包括任何正在进行的操作)。操作不是直接创建的,而是通过调用其他集合或资源来创建的。
尚未完成的操作可能会被取消。取消请求是异步的,并且在发出取消请求后操作可能会继续运行一段时间。
已完成的操作可以被删除,以便它不再作为操作集合的一部分列出。
操作由服务FirestoreAdmin
创建,但通过服务google.longrunning.Operations
访问。
创建索引 |
---|
创建指定的索引。新创建的索引的初始状态是 在创建过程中,该过程可能会导致错误,在这种情况下索引将移至 无法创建单个字段的索引。
|
删除索引 |
---|
删除索引。
|
出口单据 |
---|
将全部或部分文档的副本从 Google Cloud Firestore 导出到另一个存储系统,例如 Google Cloud Storage。最近对文档的更新可能不会反映在导出中。导出在后台进行,可以通过创建的操作资源监视和管理其进度。导出的输出只能在相关操作完成后才能使用。如果导出操作在完成之前取消,则可能会在 Google Cloud Storage 中留下部分数据。
|
获取索引 |
---|
获取索引。
|
进口文件 |
---|
将文档导入 Google Cloud Firestore。现有的同名文档将被覆盖。导入在后台进行,可以通过创建的操作资源监视和管理其进度。如果取消 ImportDocuments 操作,则数据的子集可能已导入到 Cloud Firestore。
|
列表索引 |
---|
列出与指定过滤器匹配的索引。
|
创建索引请求
领域 | |
---|---|
parent | 该索引将应用到的数据库的名称。例如: |
index | 要创建的索引。名称和状态字段仅输出,将被忽略。某些单字段索引无法创建或删除。 |
删除索引请求
领域 | |
---|---|
name | 索引名称。例如: |
导出文档元数据
ExportDocuments 操作的元数据。
领域 | |
---|---|
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(此项目或另一个项目)。 |
获取索引请求
领域 | |
---|---|
name | 索引的名称。例如: |
导入文件元数据
ImportDocuments 操作的元数据。
领域 | |
---|---|
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 匹配。请参阅: |
指数
索引定义。
领域 | |
---|---|
name | 索引的资源名称。仅输出。 |
collection_id | 该索引适用的集合 ID。必需的。 |
fields[] | 要索引的字段。 |
state | 索引的状态。仅输出。 |
状态
索引的状态。在索引创建过程中,索引将处于CREATING
状态。如果索引创建成功,则会转入READY
状态。如果无法创建索引,则会转换为ERROR
状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定。 |
CREATING | 正在创建索引。该索引有一个活跃的长期运行操作。写入文档时索引会更新。可能存在一些索引数据。 |
READY | 该索引已准备好可供使用。写入文档时索引会更新。该索引完全由它所适用的所有存储文档填充。 |
ERROR | 正在创建索引,但出了点问题。该索引没有活动的长时间运行操作,并且最近完成的长时间运行操作失败。写入文档时索引不会更新。可能存在一些索引数据。 |
索引字段
索引的一个字段。
领域 | |
---|---|
field_path | 田野的路径。必须匹配 [google.firestore.v1beta1.Document.fields][fields] 描述的字段路径规范。特殊字段路径 |
mode | 场的模式。 |
模式
模式决定字段的索引方式。
枚举 | |
---|---|
MODE_UNSPECIFIED | 模式未指定。 |
ASCENDING | 该字段的值被索引,以支持升序排序,也支持按 <、>、<=、>= 和 = 查询。 |
DESCENDING | 该字段的值被索引,以支持降序排序,也支持按 <、>、<=、>= 和 = 查询。 |
ARRAY_CONTAINS | 该字段的数组值已建立索引,以便支持使用 ARRAY_CONTAINS 查询的成员资格。 |
索引操作元数据
索引操作的元数据。此元数据填充google.longrunning.Operation
的元数据字段。
领域 | |
---|---|
start_time | 手术开始的时间。 |
end_time | 操作结束的时间,无论成功还是失败。如果操作仍处于活动状态,请取消设置。 |
index | 此操作所作用的索引资源。例如: |
operation_type | 索引操作的类型。 |
cancelled | 如果 |
document_progress | 现有操作的进度,以文件数量衡量。 |
操作类型
索引操作的类型。
枚举 | |
---|---|
OPERATION_TYPE_UNSPECIFIED | 未指定。绝不由服务器设置。 |
CREATING_INDEX | 该操作正在创建索引。由CreateIndex 调用启动。 |
列出索引请求
领域 | |
---|---|
parent | 数据库名称。例如: |
filter | |
page_size | 标准列表页面大小。 |
page_token | 标准列表页面令牌。 |
列表索引响应
领域 | |
---|---|
indexes[] | 索引。 |
next_page_token | 标准列表下一页标记。 |
位置元数据
该类型没有字段。
操作状态
正在进行的操作的各种可能状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 未指定。 |
INITIALIZING | 正在准备处理请求。 |
PROCESSING | 正在积极处理请求。 |
CANCELLING | 用户对操作调用 google.longrunning.Operations.CancelOperation 后,请求正在取消。 |
FINALIZING | 请求已处理并处于最终确定阶段。 |
SUCCESSFUL | 请求已成功完成。 |
FAILED | 请求已完成处理,但遇到错误。 |
CANCELLED | 用户调用 google.longrunning.Operations.CancelOperation 后,请求已完成取消。 |
进步
衡量特定指标的进度。
领域 | |
---|---|
work_completed | 已完成工作量的估计。请注意,这可能大于 |
work_estimated | 需要执行多少工作的估计。如果工作估算不可用,则为零。随着工作的进展可能会发生变化。 |