機能
関数 | 説明 |
---|---|
関数(アプリ、...) | |
getFirestore(アプリ) | 提供されたFirebaseAppに関連付けられている既存のデフォルトFirestoreインスタンスを返します。 。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。 |
getFirestore(アプリ、データベースID) | (ベータ版)提供されたFirebaseAppに関連付けられている既存のFirestoreインスタンスを返します。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。 |
初期化Firestore(アプリ、設定) | 指定された設定を使用して Cloud Firestore の新しいインスタンスを初期化します。 getFirestore()を含む他の関数の前にのみ呼び出すことができます。 。カスタム設定が空の場合、この関数はgetFirestore()を呼び出すことと同じです。 。 |
InitializeFirestore(アプリ、設定、データベースID) | (ベータ)提供された設定を使用して Cloud Firestore の新しいインスタンスを初期化します。 getFirestore()を含む他の関数の前にのみ呼び出すことができます。 。カスタム設定が空の場合、この関数はgetFirestore()を呼び出すことと同じです。 。 |
関数(firestore, ...) | |
コレクション(firestore, path, pathSegments) | 指定された絶対パスにあるコレクションを参照するCollectionReference インスタンスを取得します。 |
collectionGroup(firestore, collectionId) | 指定されたcollectionId を持つコレクションまたはサブコレクションに含まれるデータベース内のすべてのドキュメントを含む新しいQuery インスタンスを作成して返します。 |
connectFirestoreEmulator(ファイアストア、ホスト、ポート、オプション) | Cloud Firestore エミュレータと通信するようにこのインスタンスを変更します。注: これは、このインスタンスが操作を実行するために使用される前に呼び出す必要があります。 |
doc(firestore, path, pathSegments) | 指定された絶対パスにあるドキュメントを参照するDocumentReference インスタンスを取得します。 |
runTransaction(firestore、updateFunction、オプション) | 指定されたupdateFunction を実行し、トランザクション内で適用された変更をコミットしようとします。トランザクション内で読み取られたドキュメントが変更された場合、Cloud Firestore はupdateFunction を再試行します。 5 回試行してもコミットに失敗すると、トランザクションは失敗します。 1 つのトランザクションで許可される書き込みの最大数は 500 です。 |
終了(ファイアストア) | 提供されたFirestore インスタンスを終了します。 terminate() を呼び出した後は、 clearIndexedDbPersistence() 関数のみを使用できます。他の関数はFirestoreError をスローします。終了によって保留中の書き込みはキャンセルされず、サーバーからの応答を待っている Promise は解決されません。終了後に再起動するには、 getFirestore()を使用してFirestore の新しいインスタンスを作成します。 。注: 通常の状況では、 terminate() を呼び出す必要はありません。この関数は、このインスタンスにすべてのリソースを強制的に解放する場合、またはテスト実行の間にすべてのローカル状態が確実に破棄されるようにするために、 clearIndexedDbPersistence()と組み合わせて使用する場合にのみ役立ちます。 |
writeBatch(ファイアストア) | 複数の書き込みを 1 つのアトミック操作として実行するために使用される書き込みバッチを作成します。 1 つの WriteBatch で許可される書き込みの最大数は 500 です。これらの書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
関数() | |
カウント() | クエリの結果セット内のドキュメントの数を計算するために使用できる AggregateField オブジェクトを作成します。 |
削除フィールド() | {merge: true} を指定したupdateDoc()またはsetDoc()で使用してフィールドを削除対象としてマークするためのセンチネルを返します。 |
ドキュメントID() | ドキュメントの ID を参照する特別なセンチネルFieldPath を返します。これをクエリで使用して、ドキュメント ID で並べ替えたりフィルター処理したりできます。 |
getFirestore() | デフォルトのFirebaseAppに関連付けられている既存のデフォルトFirestoreインスタンスを返します。 。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。 |
サーバータイムスタンプ() | サーバーが生成したタイムスタンプを書き込まれたデータに含めるためにsetDoc()またはupdateDoc()で使用されるセンチネルを返します。 |
関数(データベースID, ...) | |
getFirestore(データベースID) | (ベータ版)デフォルトのFirebaseAppに関連付けられている既存のFirestoreインスタンスを返します。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。 |
関数(要素, ...) | |
arrayRemove(要素) | setDoc()で使用できる特別な値、またはサーバー上にすでに存在する配列値から指定された要素を削除するようにサーバーに指示する特別な値を返します。指定された各要素のすべてのインスタンスが配列から削除されます。変更されるフィールドがまだ配列でない場合は、空の配列で上書きされます。 |
arrayUnion(要素) | setDoc()またはupdateDoc()で使用できる特別な値を返し、指定された要素とサーバー上にすでに存在する配列値を結合するようにサーバーに指示します。配列内にまだ存在しない指定された各要素が最後に追加されます。変更されるフィールドがまだ配列でない場合は、指定された要素を正確に含む配列で上書きされます。 |
関数(フィールド, ...) | |
平均(フィールド) | クエリの結果セット内のドキュメントの範囲にわたる指定されたフィールドの平均を計算するために使用できる AggregateField オブジェクトを作成します。 |
合計(フィールド) | クエリの結果セット内のドキュメント範囲にわたる指定されたフィールドの合計を計算するために使用できる AggregateField オブジェクトを作成します。 |
関数(フィールドパス, ...) | |
orderBy(フィールドパス, 方向Str) | 指定されたフィールドによってクエリ結果を並べ替えるQueryOrderByConstraintを作成します。オプションで昇順ではなく降順で並べ替えることもできます。注: 指定されたフィールドを含まないドキュメントはクエリ結果には表示されません。 |
where(フィールドパス、opStr、値) | ドキュメントに指定されたフィールドが含まれている必要があり、値が指定されたリレーション制約を満たす必要があることを強制するQueryFieldFilterConstraintを作成します。 |
関数(フィールド値, ...) | |
endAt(フィールド値) | クエリの順序を基準にして、指定されたフィールドで終了するように結果セットを変更するQueryEndAtConstraintを作成します。フィールド値の順序は、クエリの order by 句の順序と一致する必要があります。 |
endBefore(フィールド値) | クエリの順序を基準にして、指定されたフィールドの前で終了するように結果セットを変更するQueryEndAtConstraintを作成します。フィールド値の順序は、クエリの order by 句の順序と一致する必要があります。 |
startAfter(フィールド値) | クエリの順序に関連して、指定されたフィールドの後に開始するように結果セットを変更するQueryStartAtConstraintを作成します。フィールド値の順序は、クエリの order by 句の順序と一致する必要があります。 |
startAt(フィールド値) | クエリの順序に相対して、指定されたフィールドから開始するように結果セットを変更するQueryStartAtConstraintを作成します。フィールド値の順序は、クエリの order by 句の順序と一致する必要があります。 |
関数(左, ...) | |
aggregateFieldEqual(左, 右) | 2 つの 'AggregateField を比較します` 等価性のインスタンス。 |
aggregateQuerySnapshotEqual(左、右) | 2 つのAggregateQuerySnapshot インスタンスが等しいかどうかを比較します。 2 つのAggregateQuerySnapshot インスタンスは、同じデータを比較する基礎となるクエリがある場合、「等しい」とみなされます。 |
queryEqual(左、右) | 指定されたクエリが同じコレクションを指し、同じ制約を適用する場合は true を返します。 |
refEqual(左、右) | 指定された参照が等しい場合は true を返します。 |
スナップショット等しい(左、右) | 提供されたスナップショットが等しい場合は true を返します。 |
関数(制限, ...) | |
限界(限界) | 最初に一致したドキュメントのみを返すQueryLimitConstraintを作成します。 |
最後までの制限(制限) | 最後に一致したドキュメントのみを返すQueryLimitConstraintを作成します。 limitToLast クエリには少なくとも 1 つのorderBy 句を指定する必要があります。指定しないと、実行中に例外がスローされます。 |
関数(ログレベル, ...) | |
setLogLevel(logLevel) | Cloud Firestore ログの詳細度(デバッグ、エラー、またはサイレント)を設定します。 |
関数(n, ...) | |
増分(n) | setDoc()またはupdateDoc()で使用できる特別な値を返し、フィールドの現在の値を指定された値だけインクリメントするようにサーバーに指示します。オペランドまたは現在のフィールド値のいずれかが浮動小数点精度を使用する場合、すべての算術演算は IEEE 754 セマンティクスに従います。両方の値が整数の場合、JavaScript の安全な数値範囲 ( Number.MIN_SAFE_INTEGER からNumber.MAX_SAFE_INTEGER ) の外にある値も精度が失われる可能性があります。さらに、Firestore バックエンドによって処理されると、すべての整数演算は -2^63 から 2^63-1 までの範囲に制限されます。現在のフィールド値がタイプnumber でない場合、またはフィールドがまだ存在しない場合、変換によりフィールドが指定された値に設定されます。 |
関数(クエリ、...) | |
getAggregate(クエリ、aggregateSpec) | 実際にドキュメントをダウンロードせずに、指定されたクエリの結果セット内のドキュメントに対して指定された集計を計算します。この関数を使用して集計を実行すると、ドキュメントのデータではなく最終的な集計値のみがダウンロードされるため、効率的です。この関数は、結果セットが全体をダウンロードできないほど大きい (数千のドキュメント) 場合に、ドキュメントの集約を実行できます。 |
getCount(クエリ) | 実際にドキュメントをダウンロードせずに、指定されたクエリの結果セット内のドキュメントの数を計算します。この関数を使用してドキュメントをカウントすると、ドキュメントのデータではなく最終的なカウントのみがダウンロードされるため、効率的です。この関数は、結果セットが全体をダウンロードできないほど大きい (数千のドキュメント) 場合にドキュメントをカウントできます。 |
getDocs(クエリ) | クエリを実行し、結果をQuerySnapshotとして返します。 。クエリが以前に実行されていた場合でも、すべてのクエリはサーバーによって直接実行されます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得結果に反映されます。クライアントがオフラインの場合、操作は失敗します。以前にキャッシュされた結果とローカルの変更を確認するには、完全な Firestore SDK を使用します。 |
query(クエリ、compositeFilter、queryConstraints) | 追加のクエリ制約も含めるように拡張されたQueryの新しい不変インスタンスを作成します。 |
クエリ(クエリ、クエリ制約) | 追加のクエリ制約も含めるように拡張されたQueryの新しい不変インスタンスを作成します。 |
関数(クエリ制約, ...) | |
and(クエリ制約) | 指定されたフィルター制約を組み合わせた新しいQueryCompositeFilterConstraintを作成します。結合フィルタには、指定されたフィルタをすべて満たす場合にドキュメントが含まれます。 |
or(クエリ制約) | 指定されたフィルター制約の論理和である新しいQueryCompositeFilterConstraintを作成します。論理和フィルタには、指定されたフィルタのいずれかを満たしている場合にドキュメントが含まれます。 |
関数(参照、...) | |
addDoc(参照、データ) | 指定されたデータを使用して新しいドキュメントを指定されたCollectionReference に追加し、ドキュメント ID を自動的に割り当てます。この書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
コレクション(参照、パス、パスセグメント) | 指定された相対パスにあるreference のサブコレクションを参照するCollectionReference インスタンスを取得します。 |
コレクション(参照、パス、パスセグメント) | 指定された相対パスにあるreference のサブコレクションを参照するCollectionReference インスタンスを取得します。 |
deleteDoc(参照) | 指定されたDocumentReference によって参照されるドキュメントを削除します。削除は、返された Promise が解決された後に発生するドキュメントの読み取りにのみ反映されます。クライアントがオフラインの場合、削除は失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
doc(参照、パス、パスセグメント) | 指定された相対パスにあるreference 内のドキュメントを参照するDocumentReference インスタンスを取得します。パスが指定されていない場合、返されるDocumentReference には自動生成された一意の ID が使用されます。 |
doc(参照、パス、パスセグメント) | 指定された相対パスにあるreference 内のドキュメントを参照するDocumentReference インスタンスを取得します。 |
getDoc(参照) | 指定されたドキュメント参照によって参照されるドキュメントを読み取ります。ドキュメントが以前に読み取られたり変更されたりした場合でも、すべてのドキュメントはサーバーから直接フェッチされます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得されたDocumentSnapshot に反映されます。クライアントがオフラインの場合、読み取りは失敗します。キャッシュを使用したい場合、またはローカルの変更を確認したい場合は、完全な Firestore SDK を使用してください。 |
setDoc(参照、データ) | 指定されたDocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。この書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
setDoc(参照、データ、オプション) | 指定されたDocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 merge またはmergeFields を指定すると、指定されたデータを既存のドキュメントにマージできます。この書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
updateDoc(参照、データ) | 指定されたDocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。この更新の結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
updateDoc(参照、フィールド、値、moreFieldsAndValues) | 指定されたDocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。ネストされたフィールドは、ドット区切りのフィールド パス文字列を指定するか、 FieldPath オブジェクトを指定することによって更新できます。この更新の結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。 |
関数(スナップショット、...) | |
endAt(スナップショット) | 指定されたドキュメント (両端を含む) で終了するように結果セットを変更するQueryEndAtConstraintを作成します。終了位置はクエリの順序に相対します。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。 |
endBefore(スナップショット) | 指定されたドキュメントの前で終了するように結果セットを変更するQueryEndAtConstraintを作成します (排他的)。終了位置はクエリの順序に相対します。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。 |
startAfter(スナップショット) | 指定されたドキュメントの後に開始するように結果セットを変更するQueryStartAtConstraintを作成します (排他的)。開始位置はクエリの順序に相対します。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。 |
startAt(スナップショット) | 指定されたドキュメント (両端を含む) から開始するように結果セットを変更するQueryStartAtConstraintを作成します。開始位置はクエリの順序に相対します。ドキュメントには、このクエリのorderBy で提供されるすべてのフィールドが含まれている必要があります。 |
クラス
クラス | 説明 |
---|---|
集計フィールド | Firestore によって実行できる集計を表します。 |
集計クエリスナップショット | 集計クエリの実行結果。 |
バイト | バイト配列を表す不変オブジェクト。 |
コレクションリファレンス | CollectionReference オブジェクトは、ドキュメントの追加、ドキュメント参照の取得、およびドキュメントのクエリ ( query()を使用) に使用できます。 )。 |
ドキュメントリファレンス | DocumentReference Firestore データベース内のドキュメントの場所を参照し、その場所の書き込み、読み取り、またはリスニングに使用できます。参照された場所にあるドキュメントは存在する場合もあれば、存在しない場合もあります。 |
ドキュメントスナップショット | DocumentSnapshot には、Firestore データベース内のドキュメントから読み取られたデータが含まれています。 .data() または.get(<field>) を使用してデータを抽出し、特定のフィールドを取得できます。存在しないドキュメントを指すDocumentSnapshot の場合、データ アクセスはすべて「未定義」を返します。 exists() メソッドを使用すると、ドキュメントの存在を明示的に確認できます。 |
フィールドパス | FieldPath ドキュメント内のフィールドを参照します。パスは、単一のフィールド名 (ドキュメント内の最上位フィールドを参照) またはフィールド名のリスト (ドキュメント内のネストされたフィールドを参照) で構成されます。フィールド名を指定してFieldPath を作成します。複数のフィールド名が指定された場合、パスはドキュメント内のネストされたフィールドを指します。 |
フィールド値 | set() またはupdate() を使用してドキュメント フィールドを書き込むときに使用できるセンチネル値。 |
ファイヤーストア | Cloud Firestore サービス インターフェイス。このコンストラクターを直接呼び出さないでください。代わりに、 getFirestore()を使用してください。 。 |
Firestoreエラー | Firestore オペレーションによって返されたエラー。 |
ジオポイント | Firestore の地理的位置を表す不変オブジェクト。位置は緯度と経度のペアとして表されます。緯度の値の範囲は [-90, 90] です。経度の値の範囲は [-180, 180] です。 |
クエリ | Query は、読んだり聞いたりできるクエリを指します。フィルターや順序を追加して、洗練されたQuery オブジェクトを構築することもできます。 |
クエリ複合フィルタ制約 | QueryCompositeFilterConstraint は、複数のQueryFieldFilterConstraintの論理 OR または AND を実行することにより、Firestore クエリによって返されるドキュメントのセットを絞り込むために使用されます。 s またはQueryCompositeFilterConstraint s. QueryCompositeFilterConstraint は、 or()またはand()を呼び出すことによって作成され、その後query()に渡されて、 QueryCompositeFilterConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
クエリ制約 | QueryConstraint は、Firestore クエリによって返されるドキュメントのセットを絞り込むために使用されます。 QueryConstraint はwhere()を呼び出すことによって作成されます、 orderBy() 、 startAt() 、 startAfter() 、 endBefore() 、 endAt() 、制限() 、 limitToLast() をクエリ()に渡して、このQueryConstraint も含む新しいクエリ インスタンスを作成できます。 |
クエリドキュメントスナップショット | QueryDocumentSnapshot には、クエリの一部として Firestore データベース内のドキュメントから読み取られたデータが含まれています。ドキュメントは存在することが保証されており、そのデータを.data() または.get(<field>) で抽出して特定のフィールドを取得できます。 QueryDocumentSnapshot は、 DocumentSnapshot と同じ API サーフェスを提供します。クエリ結果には既存のドキュメントのみが含まれるため、 exists プロパティは常に true になり、 data() は '未定義' を返すことはありません。 |
クエリ終了アット制約 | QueryEndAtConstraint は、Firestore クエリによって返される結果セットの末尾からドキュメントを除外するために使用されます。 QueryEndAtConstraint は、 endAt()またはendBefore()を呼び出すことによって作成され、その後query()に渡されて、このQueryEndAtConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
クエリフィールドフィルター制約 | QueryFieldFilterConstraint は、1 つ以上のドキュメント フィールドでフィルタリングすることにより、Firestore クエリによって返されるドキュメントのセットを絞り込むために使用されます。 QueryFieldFilterConstraint はwhere()を呼び出すことによって作成され、その後query()に渡されて、このQueryFieldFilterConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
クエリ制限制約 | QueryLimitConstraint は、Firestore クエリによって返されるドキュメントの数を制限するために使用されます。 QueryLimitConstraint は、 limit()またはlimitToLast()を呼び出すことによって作成され、その後query()に渡されて、このQueryLimitConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
QueryOrderByConstraint | QueryOrderByConstraint は、Firestore クエリによって返されたドキュメントのセットを並べ替えるために使用されます。 QueryOrderByConstraint は、 orderBy() を呼び出すことによって作成され、これをquery()に渡して、このQueryOrderByConstraint も含む新しいクエリ インスタンスを作成できます。注: orderBy フィールドを含まないドキュメントはクエリ結果には表示されません。 |
クエリスナップショット | QuerySnapshot は、クエリの結果を表す 0 個以上のDocumentSnapshot オブジェクトが含まれます。ドキュメントには、 docs プロパティを使用して配列としてアクセスすることも、 forEach メソッドを使用して列挙することもできます。ドキュメントの数は、 empty プロパティとsize プロパティによって決定できます。 |
クエリ開始アット制約 | QueryStartAtConstraint は、Firestore クエリによって返される結果セットの先頭からドキュメントを除外するために使用されます。 QueryStartAtConstraint は、 startAt()またはstartAfter()を呼び出すことによって作成され、その後query()に渡されて、このQueryStartAtConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
タイムスタンプ | Timestamp タイムゾーンやカレンダーに依存しない時点を表し、UTC エポック時間のナノ秒の解像度で秒および秒の端数として表されます。これは、グレゴリオ暦を 1 年目まで逆方向に拡張する Proletic グレゴリオ暦を使用してエンコードされます。これは、すべての分が 60 秒の長さであることを前提としてエンコードされます。つまり、うるう秒は「不鮮明」であるため、解釈にうるう秒テーブルは必要ありません。範囲は 0001-01-01T00:00:00Z ~ 9999-12-31T23:59:59.999999999Z です。例と詳細な仕様については、タイムスタンプの定義を参照してください。 。 |
取引 | トランザクションへの参照。トランザクションのupdateFunction に渡されるTransaction オブジェクトは、トランザクション コンテキスト内でデータを読み書きするメソッドを提供します。 runTransaction()を参照してください。 。 |
ライトバッチ | 書き込みバッチ。複数の書き込みを 1 つのアトミック単位として実行するために使用されます。 WriteBatch オブジェクトは、 writeBatch()を呼び出すことで取得できます。 。書き込みバッチに書き込みを追加するメソッドを提供します。 WriteBatch.commit() が呼び出されるまで、書き込みはコミットされません (またはローカルで表示されません)。 |
インターフェース
インターフェース | 説明 |
---|---|
集計仕様 | 一連の集計とその別名を指定します。 |
ドキュメントデータ | ドキュメント データ ( setDoc() で使用するため) ) は、値にマップされたフィールドで構成されます。 |
FirestoreDataConverter | AppModelType 型のユーザー オブジェクトをDbModelType 型の Firestore データに変換するためにwithConverter() によって使用されるコンバーター。コンバータを使用すると、Firestore にオブジェクトを保存したり、Firestore からオブジェクトを取得したりするときに、ジェネリック型の引数を指定できます。この文脈において、「AppModel」とは、関連する情報と機能をパッケージ化するためにアプリケーションで使用されるクラスです。このようなクラスには、たとえば、複雑なネストされたデータ型のプロパティ、メモ化に使用されるプロパティ、Firestore でサポートされていない型のプロパティ ( symbol やbigint など)、複合操作を実行するヘルパー関数などを含めることができます。このようなクラスは、Firestore データベースに保存するのに適していないか、保存することができません。代わりに、そのようなクラスのインスタンスは、他の POJO または POJO の配列内にネストされる可能性がある、プリミティブなプロパティだけを備えた「プレーン オールド JavaScript オブジェクト」(POJO) に変換する必要があります。このコンテキストでは、このタイプは「DbModel」と呼ばれ、Firestore に永続化するのに適したオブジェクトになります。便宜上、アプリケーションはFirestoreDataConverter を実装し、コンバータをDocumentReference やQuery などの Firestore オブジェクトに登録して、Firestore に保存するときにAppModel DbModel に自動的に変換し、Firestore から取得するときにDbModel をAppModel に変換できます。 |
設定 | Cloud Firestore インスタンスのカスタム構成を指定します。他のメソッドを呼び出す前に、これらを設定する必要があります。 |
トランザクションオプション | トランザクション動作をカスタマイズするオプション。 |
タイプエイリアス
タイプエイリアス | 説明 |
---|---|
キーにプレフィックスを追加 | すべてのキーの前にドットの後ろに外側のキーが付加された新しいマップを返します。 |
集計フィールドの種類 | Firestore でサポートされるすべてのAggregateField タイプの結合。 |
スペックデータの集計 | キーがAggregateSpec から取得され、値が入力AggregateSpec からの対応するAggregateField によって実行された集計の結果である型。 |
集計タイプ | 実行される集計タイプを表す共用体タイプ。 |
子更新フィールド | 特定の型 T1 のネストされたフィールドを計算するためのヘルパー。これは、 undefined | {...} などの共用体型を配布するために必要です。 undefined | {...} (オプションの小道具の場合に発生します) または{a: A} | {b: B} 。この使用例では、 T[K] は式として評価され分散されないため、 V Record 上の T T[K] の共用体型を分散するために使用されます。 https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types を参照してください。 |
Firestoreエラーコード | Firestore ステータス コードのセット。コードは、ここで gRPC によって公開されているものと同じです: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md可能な値: - 'canceled': 操作は (通常は呼び出し元によって) キャンセルされました。 - 「不明」: 不明なエラー、または別のエラー ドメインからのエラー。 - 'invalid-argument': クライアントが無効な引数を指定しました。これは「failed-precondition」とは異なることに注意してください。 「invalid-argument」は、システムの状態に関係なく問題のある引数 (無効なフィールド名など) を示します。 - 「deadline-exceeded」: 操作が完了する前に期限が切れました。システムの状態を変更する操作の場合、操作が正常に完了した場合でも、このエラーが返されることがあります。たとえば、サーバーからの正常な応答が期限切れになるまで遅延する可能性があります。 - 「not-found」: 要求されたドキュメントの一部が見つかりませんでした。 - 'already-exists': 作成しようとしたドキュメントはすでに存在します。 - 'permission-denied': 呼び出し元には、指定された操作を実行する権限がありません。 - 「resource-exhausted」: 一部のリソースが使い果たされています。おそらくユーザーごとのクォータか、ファイル システム全体のスペースが不足している可能性があります。 - 'failed-precondition': システムが操作の実行に必要な状態にないため、操作は拒否されました。 - 「aborted」: 操作は通常、トランザクションの中止などの同時実行の問題により中止されました。 - 「out-of-range」: 有効な範囲を超えて操作が試行されました。 - 「未実装」: 操作が実装されていないか、サポート/有効化されていません。 - 'internal': 内部エラー。基礎となるシステムによって予期されるいくつかの不変条件が壊れていることを意味します。これらのエラーのいずれかが表示された場合は、何かが非常に壊れています。 - 「利用不可」: サービスは現在利用できません。これは一時的な状態である可能性が高く、バックオフを使用して再試行することで修正できる可能性があります。 - 「data-loss」: 回復不可能なデータ損失または破損。 - 「未認証」: リクエストには操作に対する有効な認証資格情報がありません。 |
ネストされた更新フィールド | 各フィールド (例: 「bar」) について、すべてのネストされたキー (例: { 「bar.baz」: T1、「bar.qux」: T2 } )。それらを交差させて、オプションとしてマークされたすべての可能なキーを含む 1 つのマップを作成します。 |
方向による注文 | orderBy()句の方向は、「desc」または「asc」(降順または昇順) として指定されます。 |
部分的フィールド値あり | Typescript のPartial<T> に似ていますが、ネストされたフィールドを省略し、FieldValues をプロパティ値として渡すことができます。 |
原生的 | プリミティブ型。 |
クエリ制約タイプ | この SDK で使用できるさまざまなクエリ制約について説明します。 |
クエリフィルター制約 | QueryFilterConstraint 、 QueryFieldFilterConstraintおよびQueryCompositeFilterConstraintを表すヘルパー共用体型です。 。 |
クエリ非フィルタ制約 | QueryNonFilterConstraint 、ドキュメントのセットを絞り込んだり並べ替えたりするために使用される QueryConstraint を表すヘルパー共用体型です。ただし、ドキュメント フィールドで明示的にフィルタリングすることはありません。 QueryNonFilterConstraint は、 orderBy()を呼び出すことによって作成されます。 、 startAt() 、 startAfter() 、 endBefore() 、 endAt() 、 limit()またはlimitToLast() をクエリ()に渡して、 QueryConstraint も含まれる新しいクエリ インスタンスを作成できます。 |
オプションの設定 | setDoc()の動作を構成するオプション オブジェクトと呼びかけます。 SetOptions にmerge: true を指定することで、ターゲット ドキュメント全体を上書きするのではなく、詳細なマージを実行するようにこれらの呼び出しを構成できます。 |
結合から交差点まで | 共用体型U = T1 | T2 | ... を指定すると、 U = T1 | T2 | ... 、交差型(T1 & T2 & ...) を返します。分配条件型と条件型からの推論を使用します。これが機能するのは、反変位置にある同じ型変数の複数の候補により交差型が推論されるためです。 https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -タイプ |
データの更新 | データを更新します ( updateDoc() で使用します) ) 値にマップされたフィールド パス (例: 'foo' または 'foo.baz') で構成されます。ドットを含むフィールドは、ドキュメント内のネストされたフィールドを参照します。 FieldValues はプロパティ値として渡すことができます。 |
WhereFilterOp | where()句のフィルター条件は、文字列 '<'、'<='、'=='、'!='、'>='、'>'、'array-contains' を使用して指定します。 、「in」、「array-contains-any」、「not-in」。 |
フィールド値あり | 型の安全性を維持しながら、FieldValues をプロパティ値として渡すことができます。 |
関数(アプリ、...)
getFirestore(アプリ)
提供されたFirebaseAppに関連付けられている既存のデフォルトFirestoreインスタンスを返します。 。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。
サイン:
export declare function getFirestore(app: FirebaseApp): Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | FirebaseApp | 返されたFirestoreインスタンスが関連付けられているFirebaseAppインスタンス。 |
戻り値:
提供されたアプリのFirestoreインスタンス。
getFirestore(アプリ、データベースID)
この API は開発者向けのプレビューとして提供されており、受け取ったフィードバックに基づいて変更される可能性があります。この API は実稼働環境では使用しないでください。
提供されたFirebaseAppに関連付けられている既存のFirestoreインスタンスを返します。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。
サイン:
export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | FirebaseApp | 返されたFirestoreインスタンスが関連付けられているFirebaseAppインスタンス。 |
データベースID | 弦 | データベースの名前。 |
戻り値:
提供されたアプリのFirestoreインスタンス。
初期化Firestore(アプリ、設定)
指定された設定を使用して Cloud Firestore の新しいインスタンスを初期化します。 getFirestore()を含む他の関数の前にのみ呼び出すことができます。 。カスタム設定が空の場合、この関数はgetFirestore()を呼び出すことと同じです。 。
サイン:
export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | FirebaseApp | Firestore インスタンスが関連付けられるFirebaseApp 。 |
設定 | 設定 | Firestore インスタンスを構成するための設定オブジェクト。 |
戻り値:
新しく初期化されたFirestore
インスタンス。
InitializeFirestore(アプリ、設定、データベースID)
この API は開発者向けのプレビューとして提供されており、受け取ったフィードバックに基づいて変更される可能性があります。この API は実稼働環境では使用しないでください。
指定された設定を使用して Cloud Firestore の新しいインスタンスを初期化します。 getFirestore()を含む他の関数の前にのみ呼び出すことができます。 。カスタム設定が空の場合、この関数はgetFirestore()を呼び出すことと同じです。 。
サイン:
export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | FirebaseApp | Firestore インスタンスが関連付けられるFirebaseApp 。 |
設定 | 設定 | Firestore インスタンスを構成するための設定オブジェクト。 |
データベースID | 弦 | データベースの名前。 |
戻り値:
新しく初期化されたFirestore
インスタンス。
関数(firestore, ...)
コレクション(firestore, path, pathSegments)
指定された絶対パスにあるコレクションを参照するCollectionReference
インスタンスを取得します。
サイン:
export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
消防署 | ファイヤーストア | ルートFirestore インスタンスへの参照。 |
パス | 弦 | スラッシュで区切られたコレクションへのパス。 |
パスセグメント | 弦[] | 最初の引数を基準にして適用する追加のパス セグメント。 |
戻り値:
コレクションリファレンス<ドキュメントデータ、ドキュメントデータ>
CollectionReference
インスタンス。
例外
最終パスのセグメント数が偶数で、コレクションを指していない場合。
collectionGroup(firestore, collectionId)
指定されたcollectionId
を持つコレクションまたはサブコレクションに含まれるデータベース内のすべてのドキュメントを含む新しいQuery
インスタンスを作成して返します。 。
サイン:
export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
消防署 | ファイヤーストア | ルートFirestore インスタンスへの参照。 |
コレクションID | 弦 | クエリを実行するコレクションを識別します。この ID がパスの最後のセグメントであるすべてのコレクションまたはサブコレクションが含まれます。スラッシュを含めることはできません。 |
戻り値:
作成されたQuery
。
connectFirestoreEmulator(ファイアストア、ホスト、ポート、オプション)
Cloud Firestore エミュレータと通信するようにこのインスタンスを変更します。
サイン:
export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
消防署 | ファイヤーストア | エミュレータに接続するように構成するFirestore インスタンス。 |
ホスト | 弦 | エミュレータホスト (例: localhost)。 |
ポート | 番号 | エミュレータのポート (例: 9000)。 |
オプション | {mockUserToken?: EmulatorMockTokenOptions |弦; } |
戻り値:
空所
doc(ファイヤーストア、パス、パスセグメント)
指定された絶対パスでドキュメントを参照するDocumentReference
インスタンスを取得します。
サイン:
export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ファイヤーストア | ファイヤーストア | ルートFirestore インスタンスへの参照。 |
パス | 弦 | ドキュメントへのスラッシュ分離パス。 |
Pathsegments | 弦[] | 最初の引数に対して適用される追加のパスセグメント。 |
戻り値:
ドキュメントリファレンス< documentData 、 documentdata >
DocumentReference
インスタンス。
例外
最終パスに奇数のセグメントがあり、ドキュメントを指していない場合。
RunTransaction(Firestore、UpdateFunction、Options)
指定されたupdateFunction
を実行し、トランザクション内で適用される変更をコミットしようとします。トランザクション内で読み取られたドキュメントが変更された場合、Cloud FirestoreはupdateFunction
を取得します。 5回の試行後にコミットに失敗した場合、トランザクションは失敗します。
単一のトランザクションで許可されている最大数は500です。
サイン:
export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ファイヤーストア | ファイヤーストア | このトランザクションを実行するためのFirestoreデータベースへの参照。 |
UpdateFunction | (トランザクション:トランザクション)=>約束<T> | トランザクションコンテキスト内で実行する機能。 |
オプション | トランザクションオプション | コミットする試みの最大数を構成するオプションオブジェクト。 |
戻り値:
約束<t>
トランザクションが正常に完了したか、明示的に中止された場合( updateFunction
失敗した約束を返しました)、 updateFunction
によって返された約束ここに返されます。それ以外の場合、トランザクションが失敗した場合、対応する障害エラーによる拒否された約束が返されます。
終了(ファイヤーストア)
提供されたFirestore
インスタンスを終了します。
clearIndexedDbPersistence()
terminate()
のみを呼び出した後も使用できます。他の機能はFirestoreError
を投げます。終了は保留中の書き込みをキャンセルせず、サーバーからの応答を待っている約束は解決されません。
終了後に再起動するには、 getFirestore()を使用してFirestore
の新しいインスタンスを作成します。
サイン:
export declare function terminate(firestore: Firestore): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ファイヤーストア | ファイヤーストア | 終了するFirestore インスタンス。 |
戻り値:
約束<無効>
インスタンスが正常に終了したときに解決されるPromise
。
WriteBatch(Firestore)
単一の原子操作として複数の書き込みを実行するために使用される書き込みバッチを作成します。単一の書き込みバッチで許可されている最大数の書き込みは500です。
これらの書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function writeBatch(firestore: Firestore): WriteBatch;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ファイヤーストア | ファイヤーストア |
戻り値:
複数の書き込みをアトミックに実行するために使用できるWriteBatch
。
関数()
カウント()
クエリの結果セットでドキュメントのカウントを計算するために使用できる集約フィールドオブジェクトを作成します。
サイン:
export declare function count(): AggregateField<number>;
戻り値:
アグリゲートフィールド<number>
deletefield()
削除のフィールドをマークするために、 {merge: true}
を使用してupdatedoc()またはsetdoc()で使用するためにセンチネルを返します。
サイン:
export declare function deleteField(): FieldValue;
戻り値:
documentid()
ドキュメントのIDを参照するために、特別なSentinel FieldPath
を返します。ドキュメントIDでソートまたはフィルタリングするためにクエリで使用できます。
サイン:
export declare function documentId(): FieldPath;
戻り値:
getFirestore()
デフォルトのFireBaseappに関連付けられている既存のデフォルトのFirestoreインスタンスを返します。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。
サイン:
export declare function getFirestore(): Firestore;
戻り値:
提供されたアプリのファイヤーストアインスタンス。
サーバータイムスタンプ()
setdoc()またはupdatedoc()で使用されたセンチネルを返して、書かれたデータにサーバーで生成されたタイムスタンプを含めます。
サイン:
export declare function serverTimestamp(): FieldValue;
戻り値:
function(databaseid、...)
getFirestore(databaseid)
このAPIは、開発者のプレビューとして提供されており、受け取ったフィードバックに基づいて変更される場合があります。このAPIを生産環境で使用しないでください。
デフォルトのFireBaseappに関連付けられている既存のFirestoreインスタンスを返します。インスタンスが存在しない場合は、デフォルト設定で新しいインスタンスを初期化します。
サイン:
export declare function getFirestore(databaseId: string): Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
DatabaseID | 弦 | データベースの名前。 |
戻り値:
提供されたアプリのファイヤーストアインスタンス。
関数(要素、...)
arrayremove(要素)
setDoc()で使用できる特別な値を返します。または、サーバーに既に存在する配列値から指定された要素を削除するようにサーバーに指示します。指定された各要素のすべてのインスタンスは、配列から削除されます。変更されているフィールドがまだ配列でない場合、空の配列で上書きされます。
サイン:
export declare function arrayRemove(...elements: unknown[]): FieldValue;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
要素 | 未知[] | 配列から削除する要素。 |
戻り値:
setDoc()
またはupdateDoc()
への呼び出しで使用するFieldValue
Sentinel
arrayunion(要素)
サーバーに既に存在する配列値と特定の要素を結合するようにサーバーに指示するsetDoc()またはupdatedoc()で使用できる特別な値を返します。アレイにまだ存在しない指定された各要素は、最後まで追加されます。変更されているフィールドがまだ配列でない場合、指定された要素を正確に含む配列が上書きされます。
サイン:
export declare function arrayUnion(...elements: unknown[]): FieldValue;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
要素 | 未知[] | 配列に結合する要素。 |
戻り値:
setDoc()
またはupdateDoc()
への呼び出しで使用するFieldValue
Sentinel 。
関数(フィールド、...)
平均(フィールド)
クエリの結果セットのドキュメントの範囲で指定されたフィールドの平均を計算するために使用できる集約フィールドオブジェクトを作成します。
サイン:
export declare function average(field: string | FieldPath): AggregateField<number | null>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
分野 | 文字列 |フィールドパス | 結果セット全体で平均するフィールドを指定します。 |
戻り値:
アグリゲートフィールド<番号| null>
sum(field)
クエリの結果セットで、さまざまなドキュメントで指定されたフィールドの合計を計算するために使用できるAggregateFieldオブジェクトを作成します。
サイン:
export declare function sum(field: string | FieldPath): AggregateField<number>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
分野 | 文字列 |フィールドパス | 結果セット全体で合計するフィールドを指定します。 |
戻り値:
アグリゲートフィールド<number>
関数(FieldPath、...)
Orderby(FieldPath、DirectionStr)
QueryOrderByConstraintを作成します。これにより、指定されたフィールドでクエリの結果をソートします。
サイン:
export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldPath | 文字列 |フィールドパス | ソートするフィールド。 |
DirectionStr | OrderByDirection | (「ASC」または「DESC」)によってソートするオプションの方向。指定されていない場合、注文は上昇します。 |
戻り値:
作成されたQueryOrderByConstraint 。
WHERE(FieldPath、Opstr、Value)
ドキュメントに指定されたフィールドが含まれている必要があり、値が提供された関係の制約を満たす必要があることを強制するQueryFieldFilterConstraintを作成します。
サイン:
export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldPath | 文字列 |フィールドパス | 比較するパス |
opstr | wherefilterop | 操作文字列( "&lt;"、 "&lt; ="、 "=="、 "&lt;"、 "&lt; ="、 "!=")。 |
価値 | 未知 | 比較の値 |
戻り値:
作成されたQueryFieldFilterConstraint 。
関数(FieldValues、...)
Endat(FieldValues)
クエリの順序に対して提供されたフィールドで終了する結果を変更するQueryEndatConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。
サイン:
export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldValues | 未知[] | フィールドは、クエリの順序でこのクエリを終了する値です。 |
戻り値:
queryendatconstraint query()
に渡す
endbefore(fieldvalues)
クエリの順序に対して、提供されたフィールドの前に終了する結果を変更するQueryEndatConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。
サイン:
export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldValues | 未知[] | フィールドは、クエリの順序の順序で、前にこのクエリを終了する値です。 |
戻り値:
queryendatconstraint query()
に渡す
start(fieldvalues)
クエリの順序に対して提供されたフィールドの後に起動する結果セットを変更するqueryStartAtConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。
サイン:
export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldValues | 未知[] | フィールドは、クエリの注文の順にこのクエリを開始するための値です。 |
戻り値:
querystartatconstraint query()
に渡す
startat(fieldvalues)
クエリの順序に対して提供されたフィールドから開始する結果セットを変更するquerystartatconstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。
サイン:
export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
FieldValues | 未知[] | フィールドは、クエリの順序でこのクエリを開始するための値です。 |
戻り値:
querystartatconstraint query()
に渡す。
関数(左、...)
aggregatefieldequal(左、右)
2つの 'AggregateFieldを比較します`平等のためのインスタンス。
サイン:
export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
左 | アグリゲートフィールド<不明> | この集計フィールドをright と比較してください。 |
右 | アグリゲートフィールド<不明> | この集計フィールドをleft と比較してください。 |
戻り値:
ブール値
aggregatequerysnapshotequal(左、右)
平等については、2つのAggregateQuerySnapshot
インスタンスを比較します。
2つのAggregateQuerySnapshot
インスタンスは、等しいデータと同じデータを比較する根本的なクエリがある場合、「等しい」と見なされます。
サイン:
export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
左 | aggregatequerysnapshot <aggregateSpectype、appModelType、dbmodelType> | 比較する最初のAggregateQuerySnapshot 。 |
右 | aggregatequerysnapshot <aggregateSpectype、appModelType、dbmodelType> | 比較する2番目のAggregateQuerySnapshot 。 |
戻り値:
ブール値
上記のように、オブジェクトが「等しい」、またはそれ以外の場合はfalse
の場合はtrue
。
Queryequal(左、右)
提供されたクエリが同じコレクションを指し、同じ制約を適用した場合、trueを返します。
サイン:
export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
左 | クエリ<AppModelType、DbModelType> | 比較するQuery 。 |
右 | クエリ<AppModelType、DbModelType> | 比較するQuery 。 |
戻り値:
ブール値
参照が同じFirestoreデータベースの同じ場所を指している場合はTRUE。
refequal(左、右)
提供された参照が等しい場合、trueを返します。
サイン:
export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
左 | ドキュメントリファレンス<appmodeltype、dbmodeltype> | CollectionReference <AppModelType、DbModelType> | 比較するための参照。 |
右 | ドキュメントリファレンス<appmodeltype、dbmodeltype> | CollectionReference <AppModelType、DbModelType> | 比較するための参照。 |
戻り値:
ブール値
参照が同じFirestoreデータベースの同じ場所を指している場合はTRUE。
snapshotequal(左、右)
提供されたスナップショットが等しい場合、trueを返します。
サイン:
export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
左 | documentsnapshot <appmodeltype、dbmodeltype> | querysnapshot <AppModelType、DbModelType> | 比較するスナップショット。 |
右 | documentsnapshot <appmodeltype、dbmodeltype> | querysnapshot <AppModelType、DbModelType> | 比較するスナップショット。 |
戻り値:
ブール値
スナップショットが等しい場合はtrue。
関数(制限, ...)
制限(制限)
最初の一致するドキュメントのみを返すquerylimitconstraintを作成します。
サイン:
export declare function limit(limit: number): QueryLimitConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
限界 | 番号 | 返品するアイテムの最大数。 |
戻り値:
作成されたquerylimitconstraint 。
最後までの制限(制限)
最後の一致するドキュメントのみを返すquerylimitconstraintを作成します。
limitToLast
クエリについては、少なくとも1つのorderBy
句を指定する必要があります。そうしないと、実行中に例外がスローされます。
サイン:
export declare function limitToLast(limit: number): QueryLimitConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
限界 | 番号 | 返品するアイテムの最大数。 |
戻り値:
作成されたquerylimitconstraint 。
関数(loglevel、...)
setloglevel(loglevel)
クラウドファイアストアログの冗長性(デバッグ、エラー、またはサイレント)を設定します。
サイン:
export declare function setLogLevel(logLevel: LogLevel): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
loglevel | loglevel | アクティビティとエラーロギングのために設定した冗長性。次の値のいずれかにすることができます。
|
戻り値:
空所
関数(n、...)
増分(n)
SetDoc()またはupdatedoc()で使用できる特別な値を返し、サーバーに指定された値によってフィールドの現在の値を増分するように指示します。
オペランドまたは現在のフィールド値がフローティングポイント精度を使用する場合、すべての算術はIEEE 754セマンティクスに従います。両方の値が整数である場合、JavaScriptの安全な数値範囲の外側の値( Number.MIN_SAFE_INTEGER
to Number.MAX_SAFE_INTEGER
)また、精密損失の対象となります。さらに、Firestoreバックエンドで処理されると、すべての整数操作が-2^63から2^63-1の間に上限になります。
現在のフィールド値がタイプnumber
でない場合、または、フィールドがまだ存在しない場合、変換はフィールドを指定された値に設定します。
サイン:
export declare function increment(n: number): FieldValue;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
n | 番号 | 増加する値。 |
戻り値:
setDoc()
またはupdateDoc()
への呼び出しで使用するFieldValue
Sentinel
関数(クエリ、...)
getAggregate(query、aggregatespec)
実際にドキュメントをダウンロードすることなく、指定されたクエリの結果セットのドキュメント上の指定された集約を計算します。
この関数を使用して集約を実行することは、ドキュメントのデータではなく最終的な集約値のみがダウンロードされるため、効率的です。この関数は、結果セットが完全にダウンロードするために非常に大きい場合(数千のドキュメント)の場合、ドキュメントの集約を実行できます。
サイン:
export declare function getAggregate<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ | クエリ<AppModelType、DbModelType> | 結果セットが集約されているクエリ。 |
aggregatespec | AggregateSpectype | 結果セットを介して実行するアグリゲートを指定するAggregateSpec オブジェクト。 AggregatesPecは、各集合体のエイリアスを指定します。これは、集約結果を取得するために使用できます。 |
戻り値:
約束< aggregatequerysnapshot <AggregateSpectype、AppModelType、dbmodelType >>
例
const aggregateSnapshot = await getAggregate(query, {
countOfDocs: count(),
totalHours: sum('hours'),
averageScore: average('score')
});
const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;
getCount(Query)
ドキュメントを実際にダウンロードせずに、指定されたクエリの結果セットのドキュメントの数を計算します。
この関数を使用してドキュメントをカウントすることは効率的です。これは、ドキュメントのデータではなく最終カウントのみがダウンロードされるためです。この関数は、結果セットが完全にダウンロードするために非常に大きい場合のドキュメントをカウントできます(数千のドキュメント)。
サイン:
export declare function getCount<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
count: AggregateField<number>;
}, AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ | クエリ<AppModelType、DbModelType> | 結果セットサイズが計算されるクエリ。 |
戻り値:
約束< aggregatequerysnapshot <{count: aggregatefield <number>; }、appModelType、dbmodelType >>
カウントで解決される約束。カウントはsnapshot.data().count
、 snapshot
は、返された約束が解決するAggregateQuerySnapshot
です。
getDocs(クエリ)
クエリを実行し、結果をquerysnapshotとして返します。
クエリが以前に実行された場合でも、すべてのクエリはサーバーによって直接実行されます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得された結果に反映されています。クライアントがオフラインの場合、操作に失敗します。以前にキャッシュされた結果とローカルの変更を確認するには、Firesstore SDK全体を使用してください。
サイン:
export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ | クエリ<AppModelType、DbModelType> | 実行するQuery 。 |
戻り値:
約束< querysnapshot <AppModelType、DbModelType>>
クエリの結果とともに解決される約束。
クエリ(クエリ、compositefilter、queryconstraints)
追加のクエリ制約も含めるように拡張されたQueryの新しい不変インスタンスを作成します。
サイン:
export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ | クエリ<AppModelType、DbModelType> | 新しい制約のベースとして使用するクエリインスタンス。 |
compositefilter | querycompositefilterconstraint | 適用するQueryCompositeFilterConstraint 。 querycompositefilterconstraintを使用して()または()または()を作成します。 |
クエリ制約 | querynonfilterconstraint [] | 追加のquerynonfilterconstraint s適用する(例: orderby() 、 limit() )。 |
戻り値:
クエリ<AppModelType、DbModelType>
例外
提供されたクエリ制約のいずれかを既存の制約または新しい制約と組み合わせることができない場合。
クエリ(クエリ、クエリ制約)
追加のクエリ制約も含めるように拡張されたQueryの新しい不変インスタンスを作成します。
サイン:
export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ | クエリ<AppModelType、DbModelType> | 新しい制約のベースとして使用するクエリインスタンス。 |
クエリ制約 | クエリ制約[] | QueryConstraintのリスト適用する。 |
戻り値:
クエリ<AppModelType、DbModelType>
例外
提供されたクエリ制約のいずれかを既存の制約または新しい制約と組み合わせることができない場合。
関数(queryconstraints、...)
および(queryconstraints)
指定されたフィルター制約の接続性である新しいQueryCompositeFilterConstraintを作成します。接続詞フィルターには、指定されたすべてのフィルターを満たす場合、ドキュメントが含まれます。
サイン:
export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ制約 | QueryFilterConstraint [] | オプション。 QueryFilterConstraintのリストsの接続詞を実行します。これらは、 where()への呼び出しで作成する必要があります、または() 、 または() 。 |
戻り値:
querycompositefilterconstraint
新しく作成されたQueryCompositeFilterConstraint 。
または(queryconstraints)
指定されたフィルター制約の分離である新しいQueryCompositeFilterConstraintを作成します。分離フィルターには、指定されたフィルターのいずれかを満たす場合、ドキュメントが含まれます。
サイン:
export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
クエリ制約 | QueryFilterConstraint [] | オプション。 QueryFilterConstraintのリストsの分離を実行します。これらは、 where()への呼び出しで作成する必要があります、または() 、 または() 。 |
戻り値:
querycompositefilterconstraint
新しく作成されたQueryCompositeFilterConstraint 。
関数(参照、...)
adddoc(参照、データ)
指定されたデータを使用して指定されたCollectionReference
に新しいドキュメントを追加し、ドキュメントIDを自動的に割り当てます。
この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | CollectionReference <AppModelType、DbModelType> | このドキュメントを追加するためのコレクションへの参照。 |
データ | フィールド値あり<AppModelType> | 新しいドキュメントのデータを含むオブジェクト。 |
戻り値:
約束< documentReference <AppModelType、DbModelType>>
バックエンドに書き込まれた後、新しく作成されたドキュメントを指すDocumentReference
で解決されたPromise
。
例外
エラー - 指定された入力が有効な Firestore ドキュメントではない場合。
コレクション(リファレンス、パス、パスセグメント)
指定された相対パスでのreference
のサブコレクションを指すCollectionReference
インスタンスを取得します。
サイン:
export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | CollectionReference <AppModelType、DbModelType> | コレクションへの参照。 |
パス | 弦 | コレクションへのスラッシュ分離されたパス。 |
Pathsegments | 弦[] | 最初の引数に関連する追加のパスセグメント。 |
戻り値:
CollectionReference < documentData 、 documentdata >
CollectionReference
インスタンス。
例外
最終パスに偶数のセグメントがあり、コレクションを指していない場合。
コレクション(リファレンス、パス、パスセグメント)
指定された相対パスでのreference
のサブコレクションを指すCollectionReference
インスタンスを取得します。
サイン:
export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | ファイヤーストア文書への参照。 |
パス | 弦 | コレクションへのスラッシュ分離されたパス。 |
Pathsegments | 弦[] | 最初の引数に対して適用される追加のパスセグメント。 |
戻り値:
CollectionReference < documentData 、 documentdata >
CollectionReference
インスタンス。
例外
最終パスに偶数のセグメントがあり、コレクションを指していない場合。
deletedoc(参照)
指定されたDocumentReference
が参照されるドキュメントを削除します。
削除は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、削除は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 削除するドキュメントへの参照。 |
戻り値:
約束<無効>
ドキュメントがバックエンドから正常に削除されると、 Promise
が解決されました。
doc(参照、パス、パスセグメント)
指定された相対パスでreference
内のドキュメントを参照するDocumentReference
インスタンスを取得します。パスが指定されていない場合、返品されたDocumentReference
に自動的に生成された一意のIDが使用されます。
サイン:
export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | CollectionReference <AppModelType、DbModelType> | コレクションへの参照。 |
パス | 弦 | ドキュメントへのスラッシュ分離パス。自動遺伝子のIDを使用するには省略する必要があります。 |
Pathsegments | 弦[] | 最初の引数に対して適用される追加のパスセグメント。 |
戻り値:
ドキュメントリファレンス<AppModelType、DbModelType>
DocumentReference
インスタンス。
例外
最終パスに奇数のセグメントがあり、ドキュメントを指していない場合。
doc(参照、パス、パスセグメント)
指定された相対パスでreference
内のドキュメントを参照するDocumentReference
インスタンスを取得します。
サイン:
export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | ファイヤーストア文書への参照。 |
パス | 弦 | ドキュメントへのスラッシュ分離パス。 |
Pathsegments | 弦[] | 最初の引数に対して適用される追加のパスセグメント。 |
戻り値:
ドキュメントリファレンス< documentData 、 documentdata >
DocumentReference
インスタンス。
例外
最終パスに奇数のセグメントがあり、ドキュメントを指していない場合。
getDoc(参照)
指定されたドキュメントリファレンスで言及されているドキュメントを読み取ります。
ドキュメントが以前に読み取られたり変更されていた場合でも、すべてのドキュメントはサーバーから直接フェッチされます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得されたDocumentSnapshot
に反映されています。クライアントがオフラインの場合、読み取りが失敗します。キャッシュを使用したり、ローカルの変更をご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | ドキュメントの参照への参照。 |
戻り値:
Promise< DocumentSnapshot <AppModelType、DbModelType>>
現在のドキュメントコンテンツを含むDocumentSnapshot
で解決された約束。
setdoc(参照、データ)
指定されたDocumentReference
が参照された文書に書き込み。ドキュメントがまだ存在しない場合、それは作成されます。
この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 書くためのドキュメントへの参照。 |
データ | フィールド値あり<AppModelType> | ドキュメントのフィールドと値のマップ。 |
戻り値:
約束<無効>
データがバックエンドに正常に書き込まれると、 Promise
が解決されました。
例外
エラー - 指定された入力が有効な Firestore ドキュメントではない場合。
SetDoc(参照、データ、オプション)
指定されたDocumentReference
が参照された文書に書き込み。ドキュメントがまだ存在しない場合、それは作成されます。 merge
またはmergeFields
提供する場合、提供されたデータを既存のドキュメントにマージできます。
この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 書くためのドキュメントへの参照。 |
データ | 部分的フィールド値あり<AppModelType> | ドキュメントのフィールドと値のマップ。 |
オプション | オプションの設定 | 設定された動作を構成するオブジェクト。 |
戻り値:
約束<無効>
データがバックエンドに正常に書き込まれると、 Promise
が解決されました。
例外
エラー - 指定された入力が有効な Firestore ドキュメントではない場合。
updatedoc(参照、データ)
指定された文書で言及されているDocumentReference
内のフィールドを更新する。存在しないドキュメントに適用すると、更新は失敗します。
この更新の結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 更新するドキュメントへの参照。 |
データ | データの更新<DbModelType> | ドキュメントを更新するフィールドと値を含むオブジェクト。フィールドには、ドキュメント内のネストされたフィールドを参照するためのドットを含めることができます。 |
戻り値:
約束<無効>
データがバックエンドに正常に書き込まれると、 Promise
が解決されました。
例外
エラー - 指定された入力が有効な Firestore データではない場合。
updatedoc(参照、フィールド、値、モアフィールドサンドバル)
指定されたDocumentReference
内の更新フィールドは、存在しないドキュメントに適用されると更新が失敗します。
ネストされたフィールドは、ドット区切りのフィールド パス文字列を指定するか、 FieldPath
オブジェクトを指定することによって更新できます。
この更新の結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。
サイン:
export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 更新するドキュメントへの参照。 |
分野 | 文字列 |フィールドパス | 更新する最初のフィールド。 |
価値 | 未知 | 最初の値。 |
詳細フィールドと値 | 未知[] | 追加のキー値ペア。 |
戻り値:
約束<無効>
データがバックエンドに正常に書き込まれると、 Promise
が解決されました。
例外
エラー - 指定された入力が有効な Firestore データではない場合。
関数(スナップショット、...)
Endat(スナップショット)
提供されたドキュメント(包括的)で終了する結果を変更するqueryendatconstraintを作成します。終了位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。
サイン:
export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
スナップショット | documentsnapshot <AppModelType、DbModelType> | ドキュメントのスナップショットが終了します。 |
戻り値:
queryendatconstraint query()
に渡す
endbefore(snapshot)
提供されたドキュメント(排他的)の前に結果を終了する結果を変更するQueryEndatConstraintを作成します。終了位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。
サイン:
export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
スナップショット | documentsnapshot <AppModelType、DbModelType> | 以前に終了するドキュメントのスナップショット。 |
戻り値:
queryendatconstraint query()
に渡す
start after(snapshot)
提供されたドキュメント(排他的)の後に起動する結果セットを変更するqueryStartAtConstraintを作成します。開始位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。
サイン:
export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
スナップショット | documentsnapshot <AppModelType、DbModelType> | 開始するドキュメントのスナップショット。 |
戻り値:
querystartatconstraint query()
に渡す
startat(snapshot)
QueryStartAtConstraintを作成し、結果設定された結果を変更して、提供されたドキュメント(包括的)で開始します。開始位置は、クエリの順序に関連しています。このドキュメントには、このクエリのorderBy
で提供されるすべてのフィールドを含める必要があります。
サイン:
export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
スナップショット | documentsnapshot <AppModelType、DbModelType> | 開始するドキュメントのスナップショット。 |
戻り値:
querystartatconstraint query()
に渡す。
AddPrefixTokeys
すべてのキーにドットに追加された外側キーが付いている新しいマップを返します。
サイン:
export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
[K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};
AggregateFieldType
FirestoreによってサポートされているすべてのAggregateField
タイプの連合。
サイン:
export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;
aggregatespecdata
キーがAggregateSpec
から取られているタイプ、およびその値は、入力AggregateSpec
から対応するAggregateField
によって実行される集約の結果です。
サイン:
export declare type AggregateSpecData<T extends AggregateSpec> = {
[P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};
AggregateType
実行される骨材タイプを表すユニオンタイプ。
サイン:
export declare type AggregateType = 'count' | 'avg' | 'sum';
ChildUpdateFields
特定のタイプT1のネストされたフィールドを計算するためのヘルパー。これは、 undefined | {...}
(オプションの小道具で発生)または{a: A} | {b: B}
。
このユースケースでは、 V
Record
上のユニオンタイプのT[K]
を配布するために使用されます、 T[K]
は式として評価され、分布していないためです。
https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-typesを参照してください
サイン:
export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
firestoreerrorcode
Firestoreステータスコードのセット。コードは、grpcによって公開されているコードで同じです:https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
可能な値: - 「キャンセル」:操作はキャンセルされました(通常は発信者によって)。 - 「不明」:異なるエラードメインからの不明なエラーまたはエラー。 - 'invalid-argument':クライアントは無効な引数を指定しました。これは「失敗した前提条件」とは異なることに注意してください。 「Invalid-Argument」は、システムの状態に関係なく問題がある引数を示します(たとえば、無効なフィールド名)。 - 「締め切り」:操作が完了する前に期限が切れた締め切り。システムの状態を変更する操作の場合、操作が正常に完了した場合でも、このエラーが返される場合があります。たとえば、サーバーからの応答の成功は、期限が切れるのに十分長く遅れていた可能性があります。 - 'not-found':要求されたドキュメントは見つかりませんでした。 - 「すでに存在する」:作成を試みた文書が既に存在します。 - 「許可-Denied」:発信者は、指定された操作を実行する許可を持っていません。 - 「Resource-Execresd」:一部のリソースは使い果たされており、おそらくユーザーごとのクォータ、またはファイルシステム全体がスペースが外れています。 - 「失敗前処理」:システムが操作の実行に必要な状態にないため、操作は拒否されました。 - 「中止」:通常、トランザクション中断などの並行性の問題が原因で、操作は中止されました。 - 「実装されていない」:操作は実装されていないか、サポート/有効化されていません。 - 「内部」:内部エラー。基礎となるシステムによって予想されるいくつかの侵略が壊れていることを意味します。これらのエラーのいずれかが表示されている場合、何かが非常に壊れています。 - 「利用できない」:サービスは現在利用できません。これはおそらく一時的な状態であり、バックオフで再試行することで修正される場合があります。 - 「データロス」:回復不可能なデータ損失または腐敗。 - 「認証されていない」:リクエストには、操作の有効な認証資格情報がありません。
サイン:
export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
NestedUpDateFields
各フィールド(例: 'bar')について、すべてのネストされたキーを見つけます(例:{ 'bar.baz':t1、 'bar.qux':t2 } )。それらと交差して、すべてオプションとしてマークされたすべての可能なキーを含む単一のマップを作成します
サイン:
export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
[K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;
OrderByDirection
Orderby()句の方向は、「DESC」または「ASC」(下降または上昇)として指定されています。
サイン:
export declare type OrderByDirection = 'desc' | 'asc';
部分的フィールド値あり
TypeScriptのPartial<T>
に似ています、しかし、ネストされたフィールドを省略し、フィールド値をプロパティ値として渡すことができます。
サイン:
export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
[K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);
原生的
プリミティブタイプ。
サイン:
export declare type Primitive = string | number | boolean | undefined | null;
クエリ制約タイプ
この SDK で使用できるさまざまなクエリ制約について説明します。
サイン:
export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';
QueryFilterConstraint
QueryFilterConstraint
、 queryfieldfilterconstraintとquerycompositefilterconstraintを表すヘルパーユニオンタイプです。
サイン:
export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
querynonfilterconstraint
QueryNonFilterConstraint
、ドキュメントのセットを絞り込んだり注文したりするために使用されるQueryConstraintsを表すヘルパーユニオンタイプですが、ドキュメントフィールドで明示的にフィルタリングしません。 QueryNonFilterConstraint
sはorderby()を呼び出すことによって作成されます、 startAt() 、 startAfter() 、 endBefore() 、 endat() 、 limit()またはlimittolast()をQueryConstraint
()に渡すことができます。 。
サイン:
export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;
オプションの設定
setdoc()の動作を構成するオプションオブジェクト、および電話。これらの呼び出しは、ターゲットドキュメント全体を上書きするのではなく、 SetOptions
合併を実行するように構成できますmerge: true
。
サイン:
export declare type SetOptions = {
readonly merge?: boolean;
} | {
readonly mergeFields?: Array<string | FieldPath>;
};
ユニオンインターセクション
ユニオンタイプU = T1 | T2 | ...
が与えられますU = T1 | T2 | ...
、交差したタイプ(T1 & T2 & ...)
を返します。
分配条件付きタイプと条件付きタイプからの推論を使用します。これは、対照的位置の同じタイプ変数の複数の候補が交差タイプを推測するためです。 https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-typeto-intersection -タイプ
サイン:
export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
データの更新
データを更新する( updatedoc()で使用するため)値にマッピングされたフィールドパス(「foo」または「foo.baz」など)で構成されています。ドットを含むフィールドは、ドキュメント内のネストされたフィールドを参照します。 FieldValuesは、プロパティ値として渡すことができます。
サイン:
export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
[K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;
wherefilterop
where()句のフィルター条件は、文字列 '&lt;'、 '&lt; ='、 '=='、 '!='、 '&gt; ='、 '&gt;'、 'array-contains'を使用して指定されています。 、 'in'、 'array-contains-any'、および 'not-in'。
サイン:
export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
フィールド値あり
タイプの安全性を維持しながら、フィールド値をプロパティ値として渡すことができます。
サイン:
export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
[K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);