Externe API-Reexporte
Die folgenden extern definierten APIs werden der Einfachheit halber von diesem Moduleinstiegspunkt erneut exportiert.
Symbol | Beschreibung |
---|---|
BulkWriter | BulkWriter Typ aus dem @google-cloud/firestore Paket. |
AggregateField | AggregateField Typ aus dem @google-cloud/firestore Paket. |
BulkWriterOptions | BulkWriterOptions Typ aus dem @google-cloud/firestore Paket. |
BundleBuilder | BundleBuilder Typ aus dem @google-cloud/firestore Paket. |
Sammlungsgruppe | CollectionGroup Typ aus dem @google-cloud/firestore Paket. |
CollectionReference | CollectionReference -Typ aus dem @google-cloud/firestore Paket. |
Dokumentänderung | DocumentChange Typ aus dem @google-cloud/firestore Paket. |
Dokumentdaten | DocumentData Typ aus dem @google-cloud/firestore Paket. |
Dokumentverweis | DocumentReference -Typ aus dem @google-cloud/firestore Paket. |
DocumentSnapshot | DocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
FieldPath | FieldPath Typ aus dem @google-cloud/firestore Paket. |
Feldwert | FieldValue Typ aus dem @google-cloud/firestore Paket. |
Filter | Filter aus dem @google-cloud/firestore Paket. |
Feuerladen | Firestore Typ aus dem @google-cloud/firestore Paket. |
FirestoreDataConverter | FirestoreDataConverter Typ aus dem @google-cloud/firestore Paket. |
GeoPoint | GeoPoint Typ aus dem @google-cloud/firestore Paket. |
GrpcStatus | GrpcStatus Typ aus dem @google-cloud/firestore Paket. |
Voraussetzung | Precondition aus dem @google-cloud/firestore Paket. |
Abfrage | Query aus dem @google-cloud/firestore Paket. |
QueryDocumentSnapshot | QueryDocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
QueryPartition | QueryPartition Typ aus dem @google-cloud/firestore Paket. |
AbfrageSnapshot | QuerySnapshot Typ aus dem @google-cloud/firestore Paket. |
ReadOptions | ReadOptions Typ aus dem @google-cloud/firestore Paket. |
SetOptions | SetOptions Typ aus dem @google-cloud/firestore Paket. |
Zeitstempel | Timestamp aus dem @google-cloud/firestore Paket. |
Transaktion | Transaction aus dem @google-cloud/firestore Paket. |
WriteBatch | WriteBatch Typ aus dem @google-cloud/firestore Paket. |
WriteResult | WriteResult Typ aus dem @google-cloud/firestore Paket. |
setLogFunction | setLogFunction Funktion aus dem @google-cloud/firestore Paket. |
Cloud Firestore.
Funktionen
Funktion | Beschreibung |
---|---|
getFirestore() | Ruft den Standard- Firestore- Dienst für die Standard-App ab. |
getFirestore(App) | Ruft den Standard- Firestore- Dienst für die angegebene App ab. |
getFirestore(Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die Standard-App ab. |
getFirestore(app, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab. |
initializeFirestore(App, Einstellungen) | Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor. |
initializeFirestore(app, Einstellungen, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
FirestoreSettings | Einstellungen, die an den Firestore-Konstruktor übergeben werden sollen. |
getFirestore()
Ruft den Standard- Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(): Firestore;
Kehrt zurück:
Feuerladen
Der Standard- Firestore- Dienst für die Standard-App.
Beispiel
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst für die Standard-App.
Beispiel
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
initializeFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
initializeFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');
,Externe API-Reexporte
Die folgenden extern definierten APIs werden der Einfachheit halber von diesem Moduleinstiegspunkt erneut exportiert.
Symbol | Beschreibung |
---|---|
BulkWriter | BulkWriter Typ aus dem @google-cloud/firestore Paket. |
AggregateField | AggregateField Typ aus dem @google-cloud/firestore Paket. |
BulkWriterOptions | BulkWriterOptions Typ aus dem @google-cloud/firestore Paket. |
BundleBuilder | BundleBuilder Typ aus dem @google-cloud/firestore Paket. |
Sammlungsgruppe | CollectionGroup Typ aus dem @google-cloud/firestore Paket. |
CollectionReference | CollectionReference -Typ aus dem @google-cloud/firestore Paket. |
Dokumentänderung | DocumentChange Typ aus dem @google-cloud/firestore Paket. |
Dokumentdaten | DocumentData Typ aus dem @google-cloud/firestore Paket. |
Dokumentverweis | DocumentReference -Typ aus dem @google-cloud/firestore Paket. |
DocumentSnapshot | DocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
FieldPath | FieldPath Typ aus dem @google-cloud/firestore Paket. |
Feldwert | FieldValue Typ aus dem @google-cloud/firestore Paket. |
Filter | Filter aus dem @google-cloud/firestore Paket. |
Feuerladen | Firestore Typ aus dem @google-cloud/firestore Paket. |
FirestoreDataConverter | FirestoreDataConverter Typ aus dem @google-cloud/firestore Paket. |
GeoPoint | GeoPoint Typ aus dem @google-cloud/firestore Paket. |
GrpcStatus | GrpcStatus Typ aus dem @google-cloud/firestore Paket. |
Voraussetzung | Precondition aus dem @google-cloud/firestore Paket. |
Abfrage | Query aus dem @google-cloud/firestore Paket. |
QueryDocumentSnapshot | QueryDocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
QueryPartition | QueryPartition Typ aus dem @google-cloud/firestore Paket. |
AbfrageSnapshot | QuerySnapshot Typ aus dem @google-cloud/firestore Paket. |
ReadOptions | ReadOptions Typ aus dem @google-cloud/firestore Paket. |
SetOptions | SetOptions Typ aus dem @google-cloud/firestore Paket. |
Zeitstempel | Timestamp aus dem @google-cloud/firestore Paket. |
Transaktion | Transaction aus dem @google-cloud/firestore Paket. |
WriteBatch | WriteBatch Typ aus dem @google-cloud/firestore Paket. |
WriteResult | WriteResult Typ aus dem @google-cloud/firestore Paket. |
setLogFunction | setLogFunction Funktion aus dem @google-cloud/firestore Paket. |
Cloud Firestore.
Funktionen
Funktion | Beschreibung |
---|---|
getFirestore() | Ruft den Standard- Firestore- Dienst für die Standard-App ab. |
getFirestore(App) | Ruft den Standard- Firestore- Dienst für die angegebene App ab. |
getFirestore(Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die Standard-App ab. |
getFirestore(app, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab. |
initializeFirestore(App, Einstellungen) | Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor. |
initializeFirestore(app, Einstellungen, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
FirestoreSettings | Einstellungen, die an den Firestore-Konstruktor übergeben werden sollen. |
getFirestore()
Ruft den Standard- Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(): Firestore;
Kehrt zurück:
Feuerladen
Der Standard- Firestore- Dienst für die Standard-App.
Beispiel
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst für die Standard-App.
Beispiel
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
initializeFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
initializeFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');
,Externe API-Reexporte
Die folgenden extern definierten APIs werden der Einfachheit halber von diesem Moduleinstiegspunkt erneut exportiert.
Symbol | Beschreibung |
---|---|
BulkWriter | BulkWriter Typ aus dem @google-cloud/firestore Paket. |
AggregateField | AggregateField Typ aus dem @google-cloud/firestore Paket. |
BulkWriterOptions | BulkWriterOptions Typ aus dem @google-cloud/firestore Paket. |
BundleBuilder | BundleBuilder Typ aus dem @google-cloud/firestore Paket. |
Sammlungsgruppe | CollectionGroup Typ aus dem @google-cloud/firestore Paket. |
CollectionReference | CollectionReference -Typ aus dem @google-cloud/firestore Paket. |
Dokumentänderung | DocumentChange Typ aus dem @google-cloud/firestore Paket. |
Dokumentdaten | DocumentData Typ aus dem @google-cloud/firestore Paket. |
Dokumentverweis | DocumentReference -Typ aus dem @google-cloud/firestore Paket. |
DocumentSnapshot | DocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
FieldPath | FieldPath Typ aus dem @google-cloud/firestore Paket. |
Feldwert | FieldValue Typ aus dem @google-cloud/firestore Paket. |
Filter | Filter aus dem @google-cloud/firestore Paket. |
Feuerladen | Firestore Typ aus dem @google-cloud/firestore Paket. |
FirestoreDataConverter | FirestoreDataConverter Typ aus dem @google-cloud/firestore Paket. |
GeoPoint | GeoPoint Typ aus dem @google-cloud/firestore Paket. |
GrpcStatus | GrpcStatus Typ aus dem @google-cloud/firestore Paket. |
Voraussetzung | Precondition aus dem @google-cloud/firestore Paket. |
Abfrage | Query aus dem @google-cloud/firestore Paket. |
QueryDocumentSnapshot | QueryDocumentSnapshot Typ aus dem @google-cloud/firestore Paket. |
QueryPartition | QueryPartition Typ aus dem @google-cloud/firestore Paket. |
AbfrageSnapshot | QuerySnapshot Typ aus dem @google-cloud/firestore Paket. |
ReadOptions | ReadOptions Typ aus dem @google-cloud/firestore Paket. |
SetOptions | SetOptions Typ aus dem @google-cloud/firestore Paket. |
Zeitstempel | Timestamp aus dem @google-cloud/firestore Paket. |
Transaktion | Transaction aus dem @google-cloud/firestore Paket. |
WriteBatch | WriteBatch Typ aus dem @google-cloud/firestore Paket. |
WriteResult | WriteResult Typ aus dem @google-cloud/firestore Paket. |
setLogFunction | setLogFunction Funktion aus dem @google-cloud/firestore Paket. |
Cloud Firestore.
Funktionen
Funktion | Beschreibung |
---|---|
getFirestore() | Ruft den Standard- Firestore- Dienst für die Standard-App ab. |
getFirestore(App) | Ruft den Standard- Firestore- Dienst für die angegebene App ab. |
getFirestore(Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die Standard-App ab. |
getFirestore(app, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab. |
initializeFirestore(App, Einstellungen) | Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor. |
initializeFirestore(app, Einstellungen, Datenbank-ID) | (BETA) Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
FirestoreSettings | Einstellungen, die an den Firestore-Konstruktor übergeben werden sollen. |
getFirestore()
Ruft den Standard- Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(): Firestore;
Kehrt zurück:
Feuerladen
Der Standard- Firestore- Dienst für die Standard-App.
Beispiel
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die Standard-App ab.
Unterschrift:
export declare function getFirestore(databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst für die Standard-App.
Beispiel
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab.
Unterschrift:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore- Dienst, der der bereitgestellten App zugeordnet ist.
Beispiel
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
initializeFirestore()
Ruft den Standard- Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an den Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Kehrt zurück:
Feuerladen
Der standardmäßige Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
initializeFirestore()
Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem Feedback, das wir erhalten, ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den benannten Firestore- Dienst für die angegebene App ab und übergibt zusätzliche Parameter an seinen Konstruktor.
Unterschrift:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | App | welcher Firestore Dienst zurückgegeben werden soll. |
Einstellungen | FirestoreSettings | Einstellungsobjekt, das an den Konstruktor übergeben werden soll. |
Datenbank-ID | Zeichenfolge | Name der zurückzugebenden Datenbank. |
Kehrt zurück:
Feuerladen
Der benannte Firestore
Dienst, der der bereitgestellten App und den bereitgestellten Einstellungen zugeordnet ist.
Beispiel
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');