索引
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 インデックスを管理します。
インデックスの作成は非同期で実行されます。操作リソースは、そのような非同期操作ごとに作成されます。操作の状態 (発生したエラーを含む) は、Operation リソースを介して照会できます。
メタデータ
Cloud Firestore のデータに関するメタデータと統計情報を提供します。この API の一部として提供されるデータは古い可能性があります。
手術
Operations コレクションは、指定されたプロジェクトに対して実行されたアクション (進行中のオペレーションを含む) の記録を提供します。操作は直接作成されるのではなく、他のコレクションまたはリソースの呼び出しを通じて作成されます。
まだ実行されていない操作はキャンセルされる場合があります。キャンセルのリクエストは非同期であり、キャンセルのリクエストが行われた後も操作はしばらく実行され続ける可能性があります。
実行されたオペレーションは削除され、オペレーション コレクションの一部としてリストされなくなる場合があります。
オペレーションはサービスFirestoreAdmin
によって作成されますが、サービスgoogle.longrunning.Operations
を介してアクセスされます。
インデックスの作成 |
---|
指定されたインデックスを作成します。新しく作成されたインデックスの初期状態は 作成中にプロセスでエラーが発生する可能性があり、その場合、インデックスは 単一フィールドのインデックスは作成できません。
|
インデックスの削除 |
---|
インデックスを削除します。
|
ドキュメントのエクスポート |
---|
ドキュメントのすべてまたはサブセットのコピーを Google Cloud Firestore から別のストレージ システム (Google Cloud Storage など) にエクスポートします。ドキュメントに対する最近の更新がエクスポートに反映されない場合があります。エクスポートはバックグラウンドで実行され、その進行状況は、作成された操作リソースを介して監視および管理できます。エクスポートの出力は、関連する操作が完了した後にのみ使用できます。エクスポート操作が完了前にキャンセルされると、部分的なデータが Google Cloud Storage に残る可能性があります。
|
インデックスの取得 |
---|
インデックスを取得します。
|
ドキュメントのインポート |
---|
ドキュメントを Google Cloud Firestore にインポートします。同じ名前の既存のドキュメントは上書きされます。インポートはバックグラウンドで行われ、その進行状況は、作成された操作リソースを介して監視および管理できます。 ImportDocuments オペレーションがキャンセルされた場合、データのサブセットがすでに Cloud Firestore にインポートされている可能性があります。
|
リストインデックス |
---|
指定されたフィルターに一致するインデックスをリストします。
|
CreateIndexRequest
FirestoreAdmin.CreateIndex
のリクエスト。
田畑 | |
---|---|
parent | このインデックスが適用されるデータベースの名前。例: |
index | 作成するインデックス。名前フィールドと状態フィールドは出力のみであり、無視されます。特定の単一フィールドのインデックスは作成または削除できません。 |
インデックスの削除リクエスト
FirestoreAdmin.DeleteIndex
のリクエスト。
田畑 | |
---|---|
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 (このプロジェクトまたは別のプロジェクト) へのインポートを開始できます。 |
GetIndexRequest
FirestoreAdmin.GetIndex
のリクエスト。
田畑 | |
---|---|
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 呼び出しによって開始されます。 |
ListIndexesRequest
FirestoreAdmin.ListIndexes
のリクエスト。
田畑 | |
---|---|
parent | データベース名。例: |
filter | |
page_size | 標準のリスト ページ サイズ。 |
page_token | 標準のリスト ページ トークン。 |
ListIndexesResponse
田畑 | |
---|---|
indexes[] | インデックス。 |
next_page_token | 標準のリストの次ページ トークン。 |
位置メタデータ
このタイプにはフィールドがありません。
google.cloud.location.Location.metadata
のメタデータ メッセージ。
動作状態
進行中のオペレーションで考えられるさまざまな状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED | 不特定。 |
INITIALIZING | リクエストは処理の準備中です。 |
PROCESSING | リクエストはアクティブに処理されています。 |
CANCELLING | ユーザーが操作に対して google.longrunning.Operations.CancelOperation を呼び出した後、リクエストはキャンセル処理中です。 |
FINALIZING | リクエストは処理され、最終段階にあります。 |
SUCCESSFUL | リクエストは正常に完了しました。 |
FAILED | リクエストの処理は終了しましたが、エラーが発生しました。 |
CANCELLED | ユーザーが google.longrunning.Operations.CancelOperation を呼び出した後、リクエストのキャンセルが完了しました。 |
進捗
特定のメトリクスの進捗状況を測定します。
田畑 | |
---|---|
work_completed | 完了した作業量の見積もり。これは |
work_estimated | 実行する必要がある作業量の見積もり。作業見積もりが入手できない場合はゼロ。作業の進行に応じて変更される場合があります。 |