Harici API Yeniden Dışa Aktarma İşlemleri
Harici olarak tanımlanan aşağıdaki API'ler, kolaylık sağlamak amacıyla bu modül giriş noktasından yeniden dışa aktarılır.
| Simge | Açıklama |
|---|---|
| Toplu Yazıcı | @google-cloud/firestore paketinden BulkWriter türü. |
| AggregateField | @google-cloud/firestore paketinden AggregateField türü. |
| BulkWriterOptions | @google-cloud/firestore paketinden BulkWriterOptions türü. |
| Paket Oluşturucu | @google-cloud/firestore paketinden BundleBuilder türü. |
| CollectionGroup | @google-cloud/firestore paketinden CollectionGroup türü. |
| KoleksiyonReferansı | @google-cloud/firestore paketinden CollectionReference türü. |
| DokümanDeğişimi | @google-cloud/firestore paketinden DocumentChange türü. |
| DocumentData | @google-cloud/firestore paketinden DocumentData türü. |
| BelgeReferansı | @google-cloud/firestore paketinden DocumentReference türü. |
| DocumentSnapshot | @google-cloud/firestore paketinden DocumentSnapshot türü. |
| FieldPath | @google-cloud/firestore paketinden FieldPath türü. |
| Alan Değeri | @google-cloud/firestore paketinden FieldValue türü. |
| Filtrele | @google-cloud/firestore paketinden Filter türü. |
| Firestore | @google-cloud/firestore paketinden Firestore türü. |
| FirestoreDataConverter | @google-cloud/firestore paketinden FirestoreDataConverter türü. |
| GeoPoint | @google-cloud/firestore paketinden GeoPoint türü. |
| GrpcStatus (GrpcStatus) | @google-cloud/firestore paketinden GrpcStatus türü. |
| Ön koşul | @google-cloud/firestore paketinden Precondition türü. |
| Sorgu | @google-cloud/firestore paketinden Query türü. |
| QueryDocumentSnapshot | @google-cloud/firestore paketinden QueryDocumentSnapshot türü. |
| QueryPartition (Sorgu Bölümü) | @google-cloud/firestore paketinden QueryPartition türü. |
| Sorgu Anlık Görüntüsü | @google-cloud/firestore paketinden QuerySnapshot türü. |
| ReadOptions | @google-cloud/firestore paketinden ReadOptions türü. |
| SetOptions | @google-cloud/firestore paketinden SetOptions türü. |
| Zaman damgası | @google-cloud/firestore paketinden Timestamp türü. |
| İşlem | @google-cloud/firestore paketinden Transaction türü. |
| WriteBatch | @google-cloud/firestore paketinden WriteBatch türü. |
| WriteResult | @google-cloud/firestore paketinden WriteResult türü. |
| setLogFunction | @google-cloud/firestore paketinden 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) | Belirtilen 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) Belirtilen uygulama için adlandırılmış Firestore hizmetini alır. |
| initializeFirestore(uygulama, ayarlar) | Belirtilen uygulama için varsayılan Firestore hizmetini alıp oluşturucuya ek parametreler iletir. |
| initializeFirestore(uygulama; ayarlar; veritabanı kimliği) | (BETA) Belirtilen uygulama için adlandırılmış Firestore hizmetini alır ve oluşturucuya ek parametreler iletir. |
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;
İadeler:
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)
Belirtilen uygulama için varsayılan Firestore hizmetini alır.
İmza:
export declare function getFirestore(app: App): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulamaya | hangi Firestore hizmetinin döndürüleceğini belirler. |
İadeler:
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 bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi ü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ıdır. |
İadeler:
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 bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi üretim ortamında kullanmayın.
Belirtilen 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 | Uygulamaya | hangi Firestore hizmetinin döndürüleceğini belirler. |
| veritabanı kimliği | dize | döndürülecek veritabanının adıdır. |
İadeler:
Firestore
Sağlanan uygulamayla ilişkilendirilmiş olan Firestore hizmeti.
Örnek
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
initializeFirestore(uygulama; ayarlar)
Belirtilen uygulama için varsayılan Firestore hizmetini alıp oluşturucuya ek parametreler iletir.
İmza:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulamaya | hangi Firestore hizmetinin döndürüleceğini belirler. |
| ayarlar | FirestoreAyarları | Oluşturucuya iletilecek ayarlar nesnesi. |
İadeler:
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});
initializeFirestore(uygulama; ayarlar; veritabanı kimliği)
Bu API, geliştiriciler için bir önizleme olarak sağlanır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi üretim ortamında kullanmayın.
Belirtilen uygulama için adlandırılmış Firestore hizmetini alır ve oluşturucusuna ek parametreler iletir.
İmza:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | Uygulamaya | 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ıdır. |
İadeler:
Firestore
Sağlanan uygulama ve ayarlarla ilişkilendirilmiş Firestore hizmeti.
Örnek
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');