Ponowne eksportowanie z zewnętrznych interfejsów API
Dla wygody następujące interfejsy API zdefiniowane zewnętrznie są ponownie eksportowane z tego punktu wejścia modułu.
Symbol | Opis |
---|---|
BulkWriter | BulkWriter z pakietu @google-cloud/firestore . |
Zagregowane pole | AggregateField z pakietu @google-cloud/firestore . |
BulkWriterOptions | BulkWriterOptions z pakietu @google-cloud/firestore . |
Kreator pakietów | BundleBuilder z pakietu @google-cloud/firestore . |
CollectionGroup | CollectionGroup z pakietu @google-cloud/firestore . |
CollectionReference | CollectionReference z pakietu @google-cloud/firestore . |
Zmiana dokumentu | DocumentChange z pakietu @google-cloud/firestore . |
DocumentData | DocumentData z pakietu @google-cloud/firestore . |
DocumentReference | DocumentReference z pakietu @google-cloud/firestore . |
DocumentSnapshot | DocumentSnapshot z pakietu @google-cloud/firestore . |
FieldPath | FieldPath z pakietu @google-cloud/firestore . |
Wartość pola | FieldValue z pakietu @google-cloud/firestore . |
Filtr | Filter z pakietu @google-cloud/firestore . |
Firestore | Firestore z pakietu @google-cloud/firestore . |
FirestoreDataConverter | FirestoreDataConverter z pakietu @google-cloud/firestore . |
GeoPoint | GeoPoint z pakietu @google-cloud/firestore . |
GrpcStatus (Stan Grpc) | GrpcStatus z pakietu @google-cloud/firestore . |
Warunek wstępny | Precondition z pakietu @google-cloud/firestore . |
Zapytanie | Query z pakietu @google-cloud/firestore . |
QueryDocumentSnapshot | QueryDocumentSnapshot z pakietu @google-cloud/firestore . |
QueryPartition | QueryPartition z pakietu @google-cloud/firestore . |
Zrzut zapytania | QuerySnapshot z pakietu @google-cloud/firestore . |
ReadOptions (Opcje odczytu) | ReadOptions z pakietu @google-cloud/firestore . |
Ustaw opcje | SetOptions z pakietu @google-cloud/firestore . |
Sygnatura czasowa | Timestamp z pakietu @google-cloud/firestore . |
Transakcja | Transaction z pakietu @google-cloud/firestore . |
WriteBatch (zapisy wsadowe) | WriteBatch z pakietu @google-cloud/firestore . |
WriteResult | WriteResult z pakietu @google-cloud/firestore . |
setLogFunction, | setLogFunction z pakietu @google-cloud/firestore . |
Cloud Firestore.
Funkcje
Funkcja | Opis |
---|---|
getFirestore(), | Pobiera domyślną usługę Firestore dla domyślnej aplikacji. |
getFirestore(aplikacja) | Pobiera domyślną usługę Firestore dla danej aplikacji. |
getFirestore(databaseId), | (BETA) Pobiera nazwę usługi Firestore dla domyślnej aplikacji. |
getFirestore(aplikacja, identyfikator bazy danych), | (BETA) Pobiera usługę Firestore o nazwie dla danej aplikacji. |
initializeFirestore(aplikacja, ustawienia) | Pobiera domyślną usługę Firestore dla danej aplikacji i przekazuje dodatkowe parametry do jej konstruktora. |
initializeFirestore(aplikacja, ustawienia, identyfikator_bazy danych) | (BETA) Pobiera usługę Firestore dla danej aplikacji i przekazuje do jej konstruktora dodatkowe parametry. |
Zajęcia
Klasa | Opis |
---|---|
Błąd FirebaseFirestore | Struktura kodu błędu Firebase Firestore. Rozszerza to błąd FirebaseError. |
Interfejsy
Interfejs | Opis |
---|---|
Ustawienia Firestore | Ustawienia przekazywane do konstruktora Firestore. |
getFirestore()
Pobiera domyślną usługę Firestore dla domyślnej aplikacji.
Podpis:
export declare function getFirestore(): Firestore;
Zwroty:
Firestore
Domyślna usługa Firestore dla domyślnej aplikacji.
Przykład
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(aplikacja)
Pobiera domyślną usługę Firestore dla danej aplikacji.
Podpis:
export declare function getFirestore(app: App): Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
Zwroty:
Firestore
Domyślna usługa Firestore powiązana z udostępnioną aplikacją.
Przykład
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(identyfikator_bazy_danych)
Ten interfejs API jest udostępniany w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera usługę Firestore dla domyślnej aplikacji.
Podpis:
export declare function getFirestore(databaseId: string): Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
Identyfikator bazy danych | string, | nazwy bazy danych do zwrócenia. |
Zwroty:
Firestore
Usługa Firestore dla domyślnej aplikacji.
Przykład
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(aplikacja; identyfikator bazy danych)
Ten interfejs API jest udostępniany w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera usługę Firestore o nazwie dla danej aplikacji.
Podpis:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
Identyfikator bazy danych | string, | nazwy bazy danych do zwrócenia. |
Zwroty:
Firestore
Usługa Firestore powiązana z udostępnioną aplikacją.
Przykład
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
zainicjujFirestore(aplikacja, ustawienia)
Pobiera domyślną usługę Firestore dla danej aplikacji i przekazuje dodatkowe parametry do jej konstruktora.
Podpis:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
ustawienia | Ustawienia Firestore | Obiekt ustawień, który ma zostać przekazany do konstruktora. |
Zwroty:
Firestore
Domyślna usługa Firestore
powiązana z udostępnianą aplikacją i ustawieniami.
Przykład
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
zainicjujFirestore(aplikacja, ustawienia, identyfikator_bazy danych)
Ten interfejs API jest udostępniany w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera usługę Firestore dla danej aplikacji i przekazuje do jej konstruktora dodatkowe parametry.
Podpis:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
ustawienia | Ustawienia Firestore | Obiekt ustawień, który ma zostać przekazany do konstruktora. |
Identyfikator bazy danych | string, | nazwy bazy danych do zwrócenia. |
Zwroty:
Firestore
Usługa o nazwie Firestore
powiązana z podaną aplikacją i ustawieniami.
Przykład
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');