索引
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 にインポートされている可能性があります。
|
リストフィールド |
---|
このデータベースのフィールド構成とメタデータをリストします。 現在、
|
リストインデックス |
---|
複合インデックスをリストします。
|
フィールドの更新 |
---|
フィールド構成を更新します。現在、フィールドの更新は単一フィールドのインデックス構成にのみ適用されます。ただし、 この呼び出しは、フィールド更新のステータスを追跡するために使用できる データベースのデフォルトのフィールド設定を構成するには、リソース名を持つ特別な
|
CreateIndexRequest
FirestoreAdmin.CreateIndex
のリクエスト。
田畑 | |
---|---|
parent | |
index | 作成する複合インデックス。 |
インデックスの削除リクエスト
FirestoreAdmin.DeleteIndex
のリクエスト。
田畑 | |
---|---|
name | 形式の名前 |
ドキュメントメタデータのエクスポート
google.longrunning.Operation
のメタデータはFirestoreAdmin.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 (このプロジェクトまたは別のプロジェクト) へのインポートを開始できます。 |
分野
データベース内の単一のフィールドを表します。
フィールドは、同じ ID を持つデータベース内のすべてのコレクションを表す「コレクション グループ」によってグループ化されます。
田畑 | |
---|---|
name | フィールド パスは、単純なフィールド名 (例: フィールド パスは、 例: (注: ここのコメントはマークダウン構文で記述されているため、コード ブロックを表すバックティックの追加レイヤーがあります) 特別な |
index_config | このフィールドのインデックス構成。設定しない場合、フィールドのインデックス付けは |
インデックス構成
このフィールドのインデックス構成。
田畑 | |
---|---|
indexes[] | このフィールドでサポートされているインデックス。 |
uses_ancestor_config | 出力のみ。 true の場合、 |
ancestor_field | 出力のみ。このフィールドのインデックス構成の設定元となる |
reverting | 出力のみ true の場合、 |
フィールド操作メタデータ
google.longrunning.Operation
のメタデータはFirestoreAdmin.UpdateField
から得られます。
田畑 | |
---|---|
start_time | この操作が開始された時刻。 |
end_time | この操作が完了した時刻。操作がまだ進行中の場合は設定が解除されます。 |
field | この操作が作用するフィールド リソース。例: |
index_config_deltas[] | この操作の意図を説明する |
state | 操作の状態。 |
document_progress | この作戦の進捗状況を文書で示します。 |
bytes_progress | この操作の進行状況 (バイト単位)。 |
IndexConfigDelta
インデックス構成の変更に関する情報。
田畑 | |
---|---|
change_type | インデックスがどのように変化するかを指定します。 |
index | インデックスが変更されています。 |
変更タイプ
インデックスがどのように変化するかを指定します。
列挙型 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 変更の種類は特定されておらず、不明です。 |
ADD | 単一フィールドのインデックスが追加されています。 |
REMOVE | 単一フィールドのインデックスが削除されています。 |
GetFieldRequest
FirestoreAdmin.GetField
のリクエスト。
田畑 | |
---|---|
name | 形式の名前 |
GetIndexRequest
FirestoreAdmin.GetIndex
のリクエスト。
田畑 | |
---|---|
name | 形式の名前 |
ドキュメントメタデータのインポート
google.longrunning.Operation
のメタデータはFirestoreAdmin.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 と一致する必要があります。参照: |
索引
Cloud Firestore インデックスを使用すると、データベース内のドキュメントに対する単純なクエリと複雑なクエリが可能になります。
田畑 | |
---|---|
name | 出力のみ。このインデックスのサーバー定義の名前。複合インデックスのこの名前の形式は次のようになります。projects |
query_scope | コレクション クエリ スコープが指定されたインデックスでは、クエリ時に指定され、同じコレクション ID を持つ特定のドキュメントの子であるコレクションに対するクエリが許可されます。 コレクション グループ クエリ スコープが指定されたインデックスでは、クエリ時に指定された特定のドキュメントから派生し、このインデックスと同じコレクション ID を持つすべてのコレクションに対するクエリが許可されます。 |
fields[] | このインデックスでサポートされるフィールド。 複合インデックスの場合、これは常に 2 つ以上のフィールドです。最後のフィールドエントリは常にフィールドパス 単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールド パスと等しいフィールド パスを持つ 1 つのエントリになります。 |
state | 出力のみ。インデックスの提供状態。 |
インデックスフィールド
インデックス内のフィールド。 field_path はどのフィールドにインデックスが付けられるかを示し、value_mode はフィールド値がどのようにインデックス付けされるかを示します。
田畑 | |
---|---|
field_path | nameを指定できます。単一フィールドのインデックスの場合、これはフィールドの名前と一致する必要があります。そうでない場合は省略できます。 |
共用体フィールドvalue_mode 。フィールド値のインデックス付け方法。 value_mode 次のいずれか 1 つだけです。 | |
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 を使用して、このインデックスを最後に作成しようとした操作が失敗した理由を特定し、インデックスを再作成します。 |
インデックス操作メタデータ
google.longrunning.Operation
のメタデータはFirestoreAdmin.CreateIndex
から得られます。
田畑 | |
---|---|
start_time | この操作が開始された時刻。 |
end_time | この操作が完了した時刻。操作がまだ進行中の場合は設定が解除されます。 |
index | この操作が作用するインデックス リソース。例: |
state | 操作の状態。 |
progress_documents | この作戦の進捗状況を文書で示します。 |
progress_bytes | この操作の進行状況 (バイト単位)。 |
リストフィールドリクエスト
FirestoreAdmin.ListFields
のリクエスト。
田畑 | |
---|---|
parent | |
filter | リスト結果に適用するフィルター。現在、 |
page_size | 返される結果の数。 |
page_token | |
リストフィールド応答
田畑 | |
---|---|
fields[] | 要求されたフィールド。 |
next_page_token | 結果の別のページをリクエストするために使用できるページ トークン。空白の場合、これが最後のページです。 |
ListIndexesRequest
FirestoreAdmin.ListIndexes
のリクエスト。
田畑 | |
---|---|
parent | |
filter | リスト結果に適用するフィルター。 |
page_size | 返される結果の数。 |
page_token | |
ListIndexesResponse
田畑 | |
---|---|
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 | 完了した作業量。 |
フィールド更新リクエスト
FirestoreAdmin.UpdateField
のリクエスト。
田畑 | |
---|---|
field | 更新されるフィールド。 |
update_mask | フィールドに対する相対的なマスク。指定した場合、この field_mask で指定された構成のみがフィールドで更新されます。 |