Package google.firestore.admin.v1beta2

指数

Firestore管理员

操作由服务FirestoreAdmin创建,但通过服务google.longrunning.Operations访问。

创建索引

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

创建复合索引。这会返回一个google.longrunning.Operation ,可用于跟踪创建的状态。操作的元数据将是IndexOperationMetadata类型。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

删除索引

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

删除复合索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

出口单据

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

将全部或部分文档的副本从 Google Cloud Firestore 导出到另一个存储系统,例如 Google Cloud Storage。最近对文档的更新可能不会反映在导出中。导出在后台进行,可以通过创建的操作资源监视和管理其进度。导出的输出只能在相关操作完成后才能使用。如果导出操作在完成之前取消,则可能会在 Google Cloud Storage 中留下部分数据。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

获取字段

rpc GetField( GetFieldRequest ) returns ( Field )

获取字段的元数据和配置。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

获取索引

rpc GetIndex( GetIndexRequest ) returns ( Index )

获取复合索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

进口文件

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

将文档导入 Google Cloud Firestore。现有的同名文档将被覆盖。导入在后台进行,可以通过创建的操作资源监视和管理其进度。如果取消 ImportDocuments 操作,则数据的子集可能已导入到 Cloud Firestore。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

列表字段

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

列出该数据库的字段配置和元数据。

目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请调用FirestoreAdmin.ListFields并将过滤器设置为indexConfig.usesAncestorConfig:false

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

列表索引

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

列出复合索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

更新字段

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

更新字段配置。目前,字段更新仅适用于单字段索引配置。但是,对FirestoreAdmin.UpdateField调用应提供字段掩码,以避免更改调用者不知道的任何配置。字段掩码应指定为: { paths: "index_config" }

此调用返回google.longrunning.Operation ,可用于跟踪字段更新的状态。操作的元数据将是FieldOperationMetadata类型。

要配置数据库的默认字段设置,请使用带有资源名称的特殊Fieldprojects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

创建索引请求

FirestoreAdmin.CreateIndex的请求。

领域
parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

要创建的复合索引。

删除索引请求

FirestoreAdmin.DeleteIndex的请求。

领域
name

string

表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

导出文档元数据

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

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

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

operation_state

OperationState

出口操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

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

collection_ids[]

string

正在导出哪些集合 ID。

output_uri_prefix

string

实体导出到的位置。

出口文件请求

FirestoreAdmin.ExportDocuments的请求。

领域
name

string

要导出的数据库。应采用以下形式: projects/{project_id}/databases/{database_id}

collection_ids[]

string

要导出哪个集合 ID。未指定是指所有集合。

output_uri_prefix

string

输出 URI。目前仅支持以下形式的 Google Cloud Storage URI: gs://BUCKET_NAME[/NAMESPACE_PATH] ,其中BUCKET_NAME是 Google Cloud Storage 存储桶的名称, NAMESPACE_PATH是可选的 Google Cloud Storage 命名空间路径。选择名称时,请务必考虑 Google Cloud Storage 命名指南:https: //cloud.google.com/storage/docs/naming 。如果 URI 是一个存储桶(没有命名空间路径),则会根据开始时间生成前缀。

出口单据响应

google.longrunning.Operation响应字段中返回。

领域
output_uri_prefix

string

输出文件的位置。这可用于在操作成功完成后开始导入 Cloud Firestore(此项目或另一个项目)。

场地

代表数据库中的单个字段。

字段按“集合组”分组,代表数据库中具有相同 id 的所有集合。

领域
name

string

字段名称的形式projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

字段路径可以是简单的字段名称,例如address或map_value内字段的路径,例如address.city ,或者特殊的字段路径。唯一有效的特殊字段是* ,它代表任何字段。

字段路径可以使用(backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: * , . , ``` (backtick), [ , ]` 以及任何 ascii 符号字符。

示例:(注意:这里的注释是用 markdown 语法写的,所以多了一层反引号来表示代码块) \ address.city` represents a field named ,而不是in the field , not the map key city . `*` represents a field named ,而不是任何字段。

特殊Field包含所有字段的默认索引设置。该字段的资源名称为: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*在此Field上定义的索引将应用于所有没有自己的Field索引配置的字段。

index_config

IndexConfig

该字段的索引配置。如果未设置,字段索引将恢复为ancestor_field定义的配置。要显式删除该字段的所有索引,请指定带有空索引列表的索引配置。

索引配置

该字段的索引配置。

领域
indexes[]

Index

该字段支持的索引。

uses_ancestor_config

bool

仅输出。当为 true 时, Field的索引配置是根据ancestor_field指定的配置设置的。当为 false 时, Field的索引配置是显式定义的。

ancestor_field

string

仅输出。指定Field的资源名称,从该Field设置该字段的索引配置(当uses_ancestor_config为true时),或者如果该字段没有索引配置(当uses_ancestor_config为false时),则从该Field设置该资源名称。

reverting

bool

仅输出 如果为 true,则Field的索引配置正在恢复。完成后,索引配置将转换为与ancestor_field指定的字段相同的状态,此时uses_ancestor_config将为truereverting将为false

字段操作元数据

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

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

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

field

string

此操作所作用的字段资源。例如: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

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

state

OperationState

操作的状态。

document_progress

Progress

该操作的进展(以文件形式)。

bytes_progress

Progress

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

索引配置增量

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

领域
change_type

ChangeType

指定索引如何变化。

index

Index

索引正在更改。

更改类型

指定索引如何变化。

枚举
CHANGE_TYPE_UNSPECIFIED更改的类型未指定或未知。
ADD正在添加单字段索引。
REMOVE单字段索引正在被删除。

获取字段请求

FirestoreAdmin.GetField的请求。

领域
name

string

表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

获取索引请求

FirestoreAdmin.GetIndex的请求。

领域
name

string

表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

导入文件元数据

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

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

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

operation_state

OperationState

导入操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

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

collection_ids[]

string

正在导入哪些集合 ID。

input_uri_prefix

string

正在导入的文档的位置。

进口文件请求

FirestoreAdmin.ImportDocuments的请求。

领域
name

string

要导入的数据库。应采用以下形式: projects/{project_id}/databases/{database_id}

collection_ids[]

string

要导入哪个集合 ID。未指定表示导入中包含的所有集合。

input_uri_prefix

string

导出文件的位置。这必须与已成功完成导出的 ExportDocumentsResponse 的 output_uri_prefix 匹配。请参阅: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix

指数

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

领域
name

string

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

query_scope

QueryScope

指定集合查询范围的索引允​​许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有相同的集合 ID。

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

fields[]

IndexField

该索引支持的字段。

对于复合索引,这始终是 2 个或更多字段。最后一个字段条目始终针对字段路径__name__ 。如果在创建时未将__name__指定为最后一个字段,则会自动添加该字段,其方向与最后定义的字段相同。如果复合索引中的最后一个字段不是定向的,则__name__将按 ASCENDING 排序(除非明确指定)。

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

state

State

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

索引字段

索引中的一个字段。 field_path描述了哪个字段被索引,value_mode描述了字段值如何被索引。

领域
field_path

string

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

联合字段value_mode 。字段值的索引方式。 value_mode只能是以下之一:
order

Order

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

array_config

ArrayConfig

表示该字段支持对array_value的操作。

数组配置

支持的数组值配置。

枚举
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.CreateIndexgoogle.longrunning.Operation结果的元数据。

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

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

index

string

此操作所作用的索引资源。例如: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

state

OperationState

操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

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

列表字段请求

FirestoreAdmin.ListFields的请求。

领域
parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

应用到列表结果的过滤器。目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请调用FirestoreAdmin.ListFields并将过滤器设置为indexConfig.usesAncestorConfig:false

page_size

int32

要返回的结果数。

page_token

string

页面令牌,从之前对FirestoreAdmin.ListFields调用返回,可用于获取下一页结果。

列表字段响应

FirestoreAdmin.ListFields的响应。

领域
fields[]

Field

请求的字段。

next_page_token

string

可用于请求另一页结果的页面令牌。如果空白,则这是最后一页。

列出索引请求

FirestoreAdmin.ListIndexes的请求。

领域
parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

应用到列表结果的过滤器。

page_size

int32

要返回的结果数。

page_token

string

页面令牌,从之前对FirestoreAdmin.ListIndexes调用返回,可用于获取下一页结果。

列表索引响应

FirestoreAdmin.ListIndexes的响应。

领域
indexes[]

Index

请求的索引。

next_page_token

string

可用于请求另一页结果的页面令牌。如果空白,则这是最后一页。

操作状态

描述操作的状态。

枚举
OPERATION_STATE_UNSPECIFIED未指定。
INITIALIZING正在准备处理请求。
PROCESSING正在积极处理请求。
CANCELLING用户对操作调用 google.longrunning.Operations.CancelOperation 后,请求正在取消。
FINALIZING请求已处理并处于最终确定阶段。
SUCCESSFUL请求已成功完成。
FAILED请求已完成处理,但遇到错误。
CANCELLED用户调用 google.longrunning.Operations.CancelOperation 后,请求已完成取消。

进步

描述操作的进度。工作单元是通用的,必须根据Progress使用位置进行解释。

领域
estimated_work

int64

估计的工作量。

completed_work

int64

已完成的工作量。

更新字段请求

FirestoreAdmin.UpdateField的请求。

领域
field

Field

要更新的字段。

update_mask

FieldMask

掩模,相对于场。如果指定,则只有此 field_mask 指定的配置才会在字段中更新。