外部 API の再エクスポート
便宜上、外部で定義された次の API は、このモジュールのエントリ ポイントから再エクスポートされます。
| 記号 | 説明 |
|---|---|
| BulkWriter | @google-cloud/firestore パッケージの BulkWriter 型。 |
| AggregateField | @google-cloud/firestore パッケージの AggregateField 型。 |
| BulkWriterOptions | @google-cloud/firestore パッケージの BulkWriterOptions 型。 |
| BundleBuilder | @google-cloud/firestore パッケージの BundleBuilder 型。 |
| コレクション グループ | @google-cloud/firestore パッケージの CollectionGroup 型。 |
| CollectionReference | @google-cloud/firestore パッケージの CollectionReference 型。 |
| DocumentChange | @google-cloud/firestore パッケージの DocumentChange 型。 |
| DocumentData | @google-cloud/firestore パッケージの DocumentData 型。 |
| DocumentReference | @google-cloud/firestore パッケージの DocumentReference 型。 |
| DocumentSnapshot | @google-cloud/firestore パッケージの DocumentSnapshot 型。 |
| FieldPath | @google-cloud/firestore パッケージの FieldPath 型。 |
| フィールド値 | @google-cloud/firestore パッケージの FieldValue 型。 |
| フィルタ | @google-cloud/firestore パッケージの Filter 型。 |
| Firestore | @google-cloud/firestore パッケージの Firestore 型。 |
| FirestoreDataConverter | @google-cloud/firestore パッケージの FirestoreDataConverter 型。 |
| GeoPoint | @google-cloud/firestore パッケージの GeoPoint 型。 |
| GrpcStatus | @google-cloud/firestore パッケージの GrpcStatus 型。 |
| 前提条件 | @google-cloud/firestore パッケージの Precondition 型。 |
| クエリ | @google-cloud/firestore パッケージの Query 型。 |
| QueryDocumentSnapshot | @google-cloud/firestore パッケージの QueryDocumentSnapshot 型。 |
| QueryPartition | @google-cloud/firestore パッケージの QueryPartition 型。 |
| QuerySnapshot | @google-cloud/firestore パッケージの QuerySnapshot 型。 |
| ReadOptions | @google-cloud/firestore パッケージの ReadOptions 型。 |
| SetOptions | @google-cloud/firestore パッケージの SetOptions 型。 |
| タイムスタンプ | @google-cloud/firestore パッケージの Timestamp 型。 |
| Transaction | @google-cloud/firestore パッケージの Transaction 型。 |
| WriteBatch | @google-cloud/firestore パッケージの WriteBatch 型。 |
| WriteResult（書き込み結果） | @google-cloud/firestore パッケージの WriteResult 型。 |
| setLogFunction | @google-cloud/firestore パッケージの setLogFunction 関数。 |
Cloud Firestore
関数
| 関数 | 説明 |
|---|---|
| getFirestore() | デフォルト アプリのデフォルトの Firestore サービスを取得します。 |
| getFirestore(app) | 指定されたアプリのデフォルトの Firestore サービスを取得します。 |
| getFirestore(databaseId) | （ベータ版） デフォルト アプリ用の名前付き Firestore サービスを取得します。 |
| getFirestore(app, databaseId) | （ベータ版） 指定されたアプリについて指定された Firestore サービスを取得します。 |
| terraformFirestore(アプリ, 設定) | 指定されたアプリのデフォルトの Firestore サービスを取得し、コンストラクタに追加のパラメータを渡します。 |
| InitializeFirestore(app, settings, databaseId) | （ベータ版） 指定されたアプリの名前付き Firestore サービスを取得し、コンストラクタに追加のパラメータを渡します。 |
クラス
| クラス | 説明 |
|---|---|
| FirebaseFirestoreError | Firebase Firestore のエラーコードの構造。これは FirebaseError を拡張します。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| FirestoreSettings | Firestore コンストラクタに渡す設定。 |
getFirestore()
デフォルト アプリのデフォルトの Firestore サービスを取得します。
署名:
export declare function getFirestore(): Firestore;
戻り値:
Firestore
デフォルト アプリのデフォルトの Firestore サービス。
例
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore（アプリ）
指定されたアプリのデフォルトの Firestore サービスを取得します。
署名:
export declare function getFirestore(app: App): Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | 返す Firestore サービス。 |
戻り値:
Firestore
指定したアプリに関連付けられているデフォルトの Firestore サービス。
例
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。
デフォルト アプリの名前付き Firestore サービスを取得します。
署名:
export declare function getFirestore(databaseId: string): Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| databaseId | 文字列 | 返されるデータベースの名前。 |
戻り値:
Firestore
デフォルト アプリ用の名前付きの Firestore サービス。
例
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(app, databaseId)
この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。
指定されたアプリに対して指定された Firestore サービスを取得します。
署名:
export declare function getFirestore(app: App, databaseId: string): Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | 返す Firestore サービス。 |
| databaseId | 文字列 | 返されるデータベースの名前。 |
戻り値:
Firestore
指定されたアプリに関連付けられた、指定された Firestore サービス。
例
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
初期化 Firestore(アプリ, 設定)
指定されたアプリのデフォルトの Firestore サービスを取得し、コンストラクタに追加のパラメータを渡します。
署名:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | 返す Firestore サービス。 |
| 設定 | FirestoreSettings | コンストラクタに渡す設定オブジェクト。 |
戻り値:
Firestore
指定されたアプリと設定に関連付けられたデフォルトの Firestore サービス。
例
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
InitializeFirestore(app, settings, databaseId)
この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。
指定されたアプリの名前付き Firestore サービスを取得し、コンストラクタに追加のパラメータを渡します。
署名:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | 返す Firestore サービス。 |
| 設定 | FirestoreSettings | コンストラクタに渡す設定オブジェクト。 |
| databaseId | 文字列 | 返されるデータベースの名前。 |
戻り値:
Firestore
指定されたアプリと設定に関連付けられた、指定された Firestore サービス。
例
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');