Harici API Yeniden Dışa Aktarma İşlemleri
Harici olarak tanımlanmış aşağıdaki API'ler, kolaylık sağlamak amacıyla bu modül giriş noktasından yeniden dışa aktarılır.
| Sembol | Açıklama |
|---|---|
| Toplu Yazar | @google-cloud/firestore paketindeki BulkWriter türü. |
| AggregateField | @google-cloud/firestore paketindeki AggregateField türü. |
| BulkWriterOptions | @google-cloud/firestore paketindeki BulkWriterOptions türü. |
| Paket Oluşturucu | @google-cloud/firestore paketindeki BundleBuilder türü. |
| KoleksiyonGrubu | @google-cloud/firestore paketindeki CollectionGroup türü. |
| KoleksiyonReferansı | @google-cloud/firestore paketindeki CollectionReference türü. |
| DocumentChange | @google-cloud/firestore paketindeki DocumentChange türü. |
| DocumentData | @google-cloud/firestore paketindeki DocumentData türü. |
| DocumentReference | @google-cloud/firestore paketindeki DocumentReference türü. |
| DocumentSnapshot | @google-cloud/firestore paketindeki DocumentSnapshot türü. |
| FieldPath | @google-cloud/firestore paketindeki FieldPath türü. |
| Alan Değeri | @google-cloud/firestore paketindeki FieldValue türü. |
| Filtrele | @google-cloud/firestore paketindeki Filter türü. |
| Firestore | @google-cloud/firestore paketindeki Firestore türü. |
| FirestoreDataConverter | @google-cloud/firestore paketindeki FirestoreDataConverter türü. |
| GeoPoint | @google-cloud/firestore paketindeki GeoPoint türü. |
| GrpcStatus | @google-cloud/firestore paketindeki GrpcStatus türü. |
| Ön koşul | @google-cloud/firestore paketindeki Precondition türü. |
| Sorgu | @google-cloud/firestore paketindeki Query türü. |
| QueryDocumentSnapshot | @google-cloud/firestore paketindeki QueryDocumentSnapshot türü. |
| Sorgu Bölümü | @google-cloud/firestore paketindeki QueryPartition türü. |
| Sorgu Anlık Görüntüsü | @google-cloud/firestore paketindeki QuerySnapshot türü. |
| ReadOptions | @google-cloud/firestore paketindeki ReadOptions türü. |
| SetOptions | @google-cloud/firestore paketindeki SetOptions türü. |
| Zaman damgası | @google-cloud/firestore paketindeki Timestamp türü. |
| İşlem | @google-cloud/firestore paketindeki Transaction türü. |
| WriteBatch | @google-cloud/firestore paketindeki WriteBatch türü. |
| WriteResult | @google-cloud/firestore paketindeki WriteResult türü. |
| setLogFunction | @google-cloud/firestore paketindeki setLogFunction işlevi. |
Cloud Firestore'a gidin.
İşlevler
| İşlev | Açıklama |
|---|---|
| getFirestore() | Varsayılan uygulama için varsayılan Firestore hizmetini alır. |
| getFirestore(uygulama) | Belirli bir uygulama için varsayılan Firestore hizmetini alır. |
| getFirestore(veritabanıKimliği) | (BETA) Varsayılan uygulama için adlandırılmış Firestore hizmetini alır. |
| getFirestore(uygulama, veritabanı kimliği) | (BETA) Belirli bir uygulama için adlandırılmış Firestore hizmetini alır. |
| initializeFirestore(uygulama, ayarlar) | Belirli bir uygulama için varsayılan Firestore hizmetini alarak oluşturucuya ek parametreler iletir. |
| initializeFirestore(uygulama, ayarlar, veritabanı kimliği) | (BETA) Belirli bir uygulama için adlandırılmış Firestore hizmetini alarak oluşturucuya ek parametreler iletir. |
Sınıflar
| Sınıf | Açıklama |
|---|---|
| FirebaseFirestore Hatası | Firebase Firestore hata kodu yapısı. Bu, FirebaseError'ı genişletir. |
Arayüzler
| Arayüz | Açıklama |
|---|---|
| FirestoreAyarları | Firestore oluşturucuya aktarılacak ayarlar. |
getFirestore()
Varsayılan uygulama için varsayılan Firestore hizmetini alır.
İmza:
export declare function getFirestore(): Firestore;
Şunu döndürür:
Firestore
Varsayılan uygulama için varsayılan Firestore hizmeti.
Örnek
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(uygulama)
Belirli bir uygulama için varsayılan Firestore hizmetini alır.
İmza:
export declare function getFirestore(app: App): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulama | hangi Firestore hizmetinin döndürüleceğini belirler. |
Şunu döndürür:
Firestore
Sağlanan uygulamayla ilişkilendirilmiş varsayılan Firestore hizmeti.
Örnek
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(veritabanıKimliği)
Bu API, geliştiriciler için önizleme olarak sunulmaktadır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.
Varsayılan uygulama için adlandırılmış Firestore hizmetini alır.
İmza:
export declare function getFirestore(databaseId: string): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| veritabanı kimliği | dize | döndürülecek veritabanının adını girin. |
Şunu döndürür:
Firestore
Varsayılan uygulama için adlandırılmış Firestore hizmeti.
Örnek
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(uygulama; veritabanı kimliği)
Bu API, geliştiriciler için önizleme olarak sunulmaktadır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.
Belirli bir uygulama için adlandırılmış Firestore hizmetini alır.
İmza:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulama | hangi Firestore hizmetinin döndürüleceğini belirler. |
| veritabanı kimliği | dize | döndürülecek veritabanının adını girin. |
Şunu döndürür:
Firestore
Sağlanan uygulamayla ilişkilendirilmiş adlandırılmış Firestore hizmeti.
Örnek
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
startizeFirestore(uygulama, ayarlar)
Belirli bir uygulama için varsayılan Firestore hizmetini alarak oluşturucuya ek parametreler iletir.
İmza:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulama | hangi Firestore hizmetinin döndürüleceğini belirler. |
| ayarlar | FirestoreAyarları | Oluşturucuya iletilecek ayarlar nesnesi. |
Şunu döndürür:
Firestore
Sağlanan uygulama ve ayarlarla ilişkilendirilmiş varsayılan Firestore hizmeti.
Örnek
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
startizeFirestore(uygulama; ayarlar, veritabanı kimliği)
Bu API, geliştiriciler için önizleme olarak sunulmaktadır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi bir üretim ortamında kullanmayın.
Belirli bir uygulama için adlandırılmış Firestore hizmetini alarak oluşturucuya ek parametreler iletir.
İmza:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulama | hangi Firestore hizmetinin döndürüleceğini belirler. |
| ayarlar | FirestoreAyarları | Oluşturucuya iletilecek ayarlar nesnesi. |
| veritabanı kimliği | dize | döndürülecek veritabanının adını girin. |
Şunu döndürür:
Firestore
Sağlanan uygulama ve ayarlarla ilişkili, adlandırılmış Firestore hizmeti.
Örnek
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');