Fonksiyonlar
İşlev | Tanım |
---|---|
işlev(uygulama, ...) | |
getFirestore(uygulama) | Sağlanan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır. |
getFirestore(uygulama, veritabanı kimliği) | (BETA) Sağlanan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır. |
startupizeFirestore(uygulama, ayarlar) | Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. . |
startupizeFirestore(uygulama, ayarlar, veritabanı kimliği) | (BETA) Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. . |
fonksiyon(ateş deposu, ...) | |
koleksiyon(firestore, yol, yolSegmentleri) | Belirtilen mutlak yoldaki koleksiyona başvuran bir CollectionReference örneği alır. |
koleksiyonGrubu(ateş deposu, koleksiyon kimliği) | Belirtilen collectionId ile bir koleksiyonda veya alt koleksiyonda bulunan veritabanındaki tüm belgeleri içeren yeni bir Query örneği oluşturur ve döndürür. |
connectFirestoreEmulator(firestore, ana makine, bağlantı noktası, seçenekler) | Cloud Firestore emülatörüyle iletişim kurmak için bu örneği değiştirin. Not: Bu örnek herhangi bir işlem yapmak için kullanılmadan önce bunun çağrılması gerekir. |
doc(firestore, yol, yolSegmentleri) | Belirtilen mutlak yoldaki belgeye başvuran bir DocumentReference örneğini alır. |
runTransaction(firestore, updateFunction, seçenekler) | Verilen updateFunction çalıştırır ve ardından işlem içinde uygulanan değişiklikleri gerçekleştirmeye çalışır. İşlem içinde okunan herhangi bir belge değiştiyse Cloud Firestore, updateFunction öğesini yeniden dener. 5 denemeden sonra taahhütte bulunulamazsa işlem başarısız olur. Tek bir işlemde izin verilen maksimum yazma sayısı 500'dür. |
sonlandır(firestore) | Sağlanan Firestore örneğini sonlandırır. terminate() çağrıldıktan sonra yalnızca clearIndexedDbPersistence() işlevleri kullanılabilir. Başka herhangi bir işlev FirestoreError atacaktır. Fesih, bekleyen herhangi bir yazma işlemini iptal etmez ve sunucudan yanıt bekleyen herhangi bir söz çözümlenmez. Fesih sonrasında yeniden başlatmak için getFirestore() ile yeni bir Firestore örneği oluşturun. . Not: Normal koşullar altında, terminate() çağrılması gerekli değildir. Bu işlev yalnızca bu örneği tüm kaynaklarını serbest bırakmaya zorlamak istediğinizde veya test çalıştırmaları arasında tüm yerel durumun yok edildiğinden emin olmak için clearIndexedDbPersistence() ile birlikte kullanışlıdır. |
writeBatch(firestore) | Tek bir atomik işlem olarak birden çok yazma işlemi gerçekleştirmek için kullanılan bir yazma toplu işlemi oluşturur. Tek bir WriteBatch'te izin verilen maksimum yazma sayısı 500'dür. Bu yazma işlemlerinin sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
işlev() | |
saymak() | Bir sorgunun sonuç kümesindeki belge sayısını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun. |
deleteField() | Bir alanı silinmek üzere işaretlemek için updateDoc() veya setDoc() ile {merge: true} ile kullanılacak bir sentinel döndürür. |
belgeKimliği() | Bir belgenin kimliğine başvurmak için özel bir nöbetçi FieldPath döndürür. Sorgularda belge kimliğine göre sıralamak veya filtrelemek için kullanılabilir. |
getFirestore() | Varsayılan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır. |
sunucuTimestamp() | Yazılı verilere sunucu tarafından oluşturulan bir zaman damgasını dahil etmek için setDoc() veya updateDoc() ile kullanılan bir sentinel döndürür. |
işlev (veritabanı kimliği, ...) | |
getFirestore(veritabanı kimliği) | (BETA) Varsayılan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır. |
fonksiyon(elemanlar, ...) | |
arrayRemove(öğeler) | setDoc() ile kullanılabilecek veya sunucuya, sunucuda zaten var olan herhangi bir dizi değerinden verilen öğeleri kaldırmasını söyleyen özel bir değer döndürür. Belirtilen her öğenin tüm örnekleri diziden kaldırılacaktır. Değiştirilen alan zaten bir dizi değilse, üzerine boş bir dizi yazılacaktır. |
diziBirliği(öğeler) | Sunucuya, verilen öğeleri sunucuda zaten var olan herhangi bir dizi değeriyle birleştirmesini söyleyen setDoc() veya updateDoc() ile kullanılabilecek özel bir değer döndürür. Dizide halihazırda mevcut olmayan her belirtilen öğe sonuna eklenecektir. Değiştirilen alan zaten bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi onun üzerine yazılacaktır. |
fonksiyon(alan,...) | |
ortalama(alan) | Bir sorgunun sonuç kümesindeki bir dizi belge üzerinden belirli bir alanın ortalamasını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun. |
toplam(alan) | Bir sorgunun sonuç kümesindeki bir dizi belge üzerinde belirtilen alanın toplamını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun. |
fonksiyon(fieldPath, ...) | |
orderBy(fieldPath, DirectionStr) | Sorgu sonucunu belirtilen alana göre, isteğe bağlı olarak artan yerine azalan sırada sıralayan bir QueryOrderByConstraint oluşturur. Not: Belirtilen alanı içermeyen belgeler sorgu sonucunda yer almayacaktır. |
nerede(fieldPath, opStr, değer) | Belgelerin belirtilen alanı içermesi gerektiğini ve değerin sağlanan ilişki kısıtlamasını karşılamasını zorunlu kılan bir QueryFieldFilterConstraint oluşturur. |
fonksiyon(fieldValues, ...) | |
endAt(fieldValues) | Sonuç kümesini, sorgu sırasına göre sağlanan alanlarda bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir. |
endBefore(fieldValues) | Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir. |
startAfter(fieldValues) | Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan sonra başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir. |
startAt(fieldValues) | Sonuç kümesini, sorgu sırasına göre sağlanan alanlardan başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgu cümlelerinin sırasına göre eşleşmelidir. |
fonksiyon(sol, ...) | |
agregaFieldEqual(sol, sağ) | İki 'AggregateField'ı karşılaştırır Eşitlik örnekleri. |
ToplamaQuerySnapshotEqual(sol, sağ) | Eşitlik açısından iki AggregateQuerySnapshot örneğini karşılaştırır. İki AggregateQuerySnapshot örneği, eşit ve aynı verileri karşılaştıran temel sorgulara sahipse "eşit" olarak kabul edilir. |
queryEqual(sol, sağ) | Sağlanan sorgular aynı koleksiyona işaret ediyorsa ve aynı kısıtlamaları uyguluyorsa true değerini döndürür. |
refEqual(sol, sağ) | Sağlanan referanslar eşitse true değerini döndürür. |
anlık görüntüEşit(sol, sağ) | Sağlanan anlık görüntüler eşitse true değerini döndürür. |
fonksiyon(limit, ...) | |
limit(limit) | Yalnızca ilk eşleşen belgeleri döndüren bir QueryLimitConstraint oluşturur. |
limitToLast(sınır) | Yalnızca son eşleşen belgeleri döndüren bir QueryLimitConstraint oluşturur. limitToLast sorguları için en az bir orderBy yan tümcesi belirtmeniz gerekir, aksi takdirde yürütme sırasında bir istisna atılır. |
fonksiyon(logLevel, ...) | |
setLogLevel(logLevel) | Cloud Firestore günlüklerinin ayrıntı düzeyini ayarlar (hata ayıklama, hata veya sessiz). |
fonksiyon(n, ...) | |
artış(n) | setDoc() veya updateDoc() ile kullanılabilecek, sunucuya alanın geçerli değerini verilen değer kadar artırmasını söyleyen özel bir değer döndürür. İşlenen veya geçerli alan değeri kayan nokta hassasiyetini kullanıyorsa, tüm aritmetik IEEE 754 semantiğini takip eder. Her iki değer de tamsayıysa, JavaScript'in güvenli sayı aralığının ( Number.MIN_SAFE_INTEGER - Number.MAX_SAFE_INTEGER arası) dışındaki değerler de hassasiyet kaybına maruz kalır. Ayrıca, Firestore arka ucu tarafından işlendikten sonra tüm tamsayı işlemleri -2^63 ile 2^63-1 arasında sınırlanır. Geçerli alan değeri number türünde değilse veya alan henüz mevcut değilse, dönüşüm, alanı verilen değere ayarlar. |
işlev (sorgu, ...) | |
getAggregate(sorgu, agregaSpec) | Belgeleri fiili olarak indirmeden, verilen sorgunun sonuç kümesindeki belgeler üzerinden belirtilen toplamaları hesaplar. Toplamaları gerçekleştirmek için bu işlevin kullanılması verimlidir çünkü belgelerin verileri değil yalnızca nihai toplama değerleri indirilir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce belge) belgelerin birleştirilmesini gerçekleştirebilir. |
getCount(sorgu) | Belgeleri gerçekte indirmeden, verilen sorgunun sonuç kümesindeki belge sayısını hesaplar. Belgeleri saymak için bu işlevin kullanılması verimlidir çünkü belgelerin verileri değil yalnızca son sayım indirilir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce belge) belgeleri sayabilir. |
getDocs(sorgu) | Sorguyu yürütür ve sonuçları Sorgu Anlık Görüntüsü olarak döndürür . Sorgu daha önce yürütülmüş olsa bile tüm sorgular doğrudan sunucu tarafından yürütülür. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışsa alınan sonuçlara yansıtılır. İstemci çevrimdışıysa işlem başarısız olur. Daha önce önbelleğe alınmış sonuçları ve yerel değişiklikleri görmek için Firestore SDK'nın tamamını kullanın. |
sorgu(sorgu, kompozitFilter, queryConstraints) | Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur. |
sorgu(sorgu, queryConstraints) | Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur. |
fonksiyon(queryConstraints, ...) | |
ve(sorguKısıtlamaları) | Verilen filtre kısıtlamalarının birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir bağlantı filtresi, verilen tüm filtreleri karşılıyorsa bir belgeyi içerir. |
veya(sorguKısıtlamaları) | Verilen filtre kısıtlamalarının bir parçası olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir ayırma filtresi, verilen filtrelerden herhangi birini karşılıyorsa bir belgeyi içerir. |
fonksiyon(referans, ...) | |
addDoc(başvuru, veri) | Belirtilen CollectionReference , verilen verilerle yeni bir belge ekleyin ve bu belgeye otomatik olarak bir belge kimliği atayın. Bu yazmanın sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
koleksiyon(referans, yol, yolSegmentleri) | Belirtilen göreli yoldaki reference alt koleksiyonuna başvuran bir CollectionReference örneği alır. |
koleksiyon(referans, yol, yolSegmentleri) | Belirtilen göreli yoldaki reference alt koleksiyonuna başvuran bir CollectionReference örneği alır. |
deleteDoc(referans) | Belirtilen DocumentReference tarafından başvurulan belgeyi siler. Silme işlemi yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa silme işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
doc(referans, yol, yolSegmentleri) | Belirtilen göreli yolda reference içindeki bir belgeye başvuran bir DocumentReference örneğini alır. Hiçbir yol belirtilmezse, döndürülen DocumentReference için otomatik olarak oluşturulan benzersiz bir kimlik kullanılacaktır. |
doc(referans, yol, yolSegmentleri) | Belirtilen göreli yolda reference içindeki bir belgeye başvuran bir DocumentReference örneğini alır. |
getDoc(referans) | Belirtilen belge referansının atıfta bulunduğu belgeyi okur. Belge daha önce okunmuş veya değiştirilmiş olsa bile tüm belgeler doğrudan sunucudan alınır. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışsa, alınan DocumentSnapshot yansıtılır. İstemci çevrimdışıysa okuma başarısız olur. Önbelleğe almayı kullanmak veya yerel değişiklikleri görmek istiyorsanız lütfen Firestore SDK'nın tamamını kullanın. |
setDoc(başvuru, veri) | Belirtilen DocumentReference tarafından başvurulan belgeye yazar. Belge henüz mevcut değilse oluşturulacaktır. Bu yazmanın sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
setDoc(başvuru, veri, seçenekler) | Belirtilen DocumentReference tarafından başvurulan belgeye yazar. Belge henüz mevcut değilse oluşturulacaktır. merge veya mergeFields sağlarsanız sağlanan veriler mevcut bir belgeyle birleştirilebilir. Bu yazmanın sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
updateDoc(referans, veri) | Belirtilen DocumentReference tarafından başvurulan belgedeki alanları günceller. Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur. Bu güncellemenin sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
updateDoc(referans, alan, değer, moreFieldsAndValues) | Belirtilen DocumentReference tarafından başvurulan belgedeki alanları günceller Güncelleme, mevcut olmayan bir belgeye uygulanırsa başarısız olur. İç içe geçmiş alanlar, noktalarla ayrılmış alan yolu dizeleri sağlanarak veya FieldPath nesneleri sağlanarak güncellenebilir. Bu güncellemenin sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın. |
işlev(anlık görüntü, ...) | |
endAt(anlık görüntü) | Sonuç kümesini sağlanan belgede (dahil) bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir. |
endBefore(anlık görüntü) | Sonuç kümesini sağlanan belgeden (hariç) önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir. |
startAfter(anlık görüntü) | Sağlanan belgeden (hariç) sonra başlayacak şekilde sonuç kümesini değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç konumu sorgunun sırasına göredir. Belge, sorgunun orderBy'sinde sağlanan alanların tümünü içermelidir. |
startAt(anlık görüntü) | Sağlanan belgede (dahil) başlayacak şekilde sonuç kümesini değiştiren bir QueryStartAtConstraint oluşturur. Başlangıç konumu sorgunun sırasına göredir. Belge, bu sorgunun orderBy sağlanan alanların tümünü içermelidir. |
Sınıflar
Sınıf | Tanım |
---|---|
Toplam Alan | Firestore tarafından gerçekleştirilebilecek bir toplamayı temsil eder. |
Toplu Sorgu Anlık Görüntüsü | Toplama sorgusu yürütmenin sonuçları. |
Bayt | Bir bayt dizisini temsil eden değişmez bir nesne. |
KoleksiyonReferans | CollectionReference nesnesi, belge eklemek, belge referansları almak ve belgeleri sorgulamak ( query() kullanarak) için kullanılabilir. ). |
BelgeReferansı | DocumentReference Firestore veritabanındaki bir belge konumunu ifade eder ve konumu yazmak, okumak veya dinlemek için kullanılabilir. Başvurulan konumdaki belge mevcut olabilir veya olmayabilir. |
Belge Anlık Görüntüsü | DocumentSnapshot Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belirli bir alanı elde etmek için veriler .data() veya .get(<field>) ile çıkarılabilir. Mevcut olmayan bir belgeye işaret eden bir DocumentSnapshot için, herhangi bir veri erişimi 'tanımsız' değerini döndürecektir. Bir belgenin varlığını açıkça doğrulamak için exists() yöntemini kullanabilirsiniz. |
AlanYolu | FieldPath belgedeki bir alanı ifade eder. Yol, tek bir alan adından (belgedeki en üst düzey alana atıfta bulunarak) veya alan adları listesinden (belgede iç içe geçmiş bir alana atıfta bulunarak) oluşabilir. Alan adlarını sağlayarak bir FieldPath oluşturun. Birden fazla alan adı sağlanırsa yol, belgedeki iç içe geçmiş bir alanı işaret eder. |
Alan değeri | set() veya update() ile belge alanlarını yazarken kullanılabilecek sentinel değerleri. |
Yangın deposu | Cloud Firestore hizmet arayüzü. Bu yapıcıyı doğrudan çağırmayın. Bunun yerine getFirestore() işlevini kullanın . |
FirestoreError | Firestore işlemi tarafından döndürülen bir hata. |
GeoPoint | Firestore'daki coğrafi konumu temsil eden değişmez bir nesne. Konum enlem/boylam çifti olarak temsil edilir. Enlem değerleri [-90, 90] aralığındadır. Boylam değerleri [-180, 180] aralığındadır. |
Sorgu | Query okuyabileceğiniz veya dinleyebileceğiniz bir sorguyu ifade eder. Filtreler ekleyerek ve sıralayarak da iyileştirilmiş Query nesneleri oluşturabilirsiniz. |
QueryCompositeFilterConstraint | QueryCompositeFilterConstraint , birden fazla QueryFieldFilterConstraint'in mantıksal VEYA veya VE işlemlerini gerçekleştirerek bir Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için kullanılır s veya QueryCompositeFilterConstraint S. QueryCompositeFilterConstraint ler or() veya and() çağrılarak oluşturulur ve daha sonra QueryCompositeFilterConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
Sorgu Kısıtlaması | Bir Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için QueryConstraint kullanılır. QueryConstraint s, Where() çağrılarak oluşturulur. , tarafından sipariş() , başlamak() , startAfter() , endBefore() , sonunda() , sınır() , limitToLast() ve daha sonra bu QueryConstraint de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
SorguBelge Anlık Görüntüsü | QueryDocumentSnapshot bir sorgunun parçası olarak Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belgenin var olduğu garanti edilir ve belirli bir alanı elde etmek için verileri .data() veya .get(<field>) ile çıkarılabilir. QueryDocumentSnapshot , DocumentSnapshot ile aynı API yüzeyini sunar. Sorgu sonuçları yalnızca mevcut belgeleri içerdiğinden, exists özelliği her zaman doğru olacaktır ve data() hiçbir zaman 'tanımsız' değerini döndürmeyecektir. |
SorguEndAtConstraint | Bir Firestore sorgusu tarafından döndürülen sonuç kümesinin sonundaki belgeleri hariç tutmak için QueryEndAtConstraint kullanılır. QueryEndAtConstraint ler, endAt() veya endBefore() çağrılarak oluşturulur ve daha sonra bu QueryEndAtConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
QueryFieldFilterConstraint | QueryFieldFilterConstraint , bir veya daha fazla belge alanını filtreleyerek Firestore sorgusu tarafından döndürülen belge kümesini daraltmak için kullanılır. QueryFieldFilterConstraint ler, Where() çağrılarak oluşturulur ve daha sonra bu QueryFieldFilterConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
SorguLimitKısıtlaması | Bir Firestore sorgusu tarafından döndürülen belge sayısını sınırlamak için QueryLimitConstraint kullanılır. QueryLimitConstraint limit() veya limitToLast() çağrılarak oluşturulur ve daha sonra bu QueryLimitConstraint de içeren yeni bir sorgu örneği oluşturmak için query()' ye iletilebilir. |
SorguOrderByConstraint | Bir Firestore sorgusu tarafından döndürülen belge kümesini sıralamak için QueryOrderByConstraint kullanılır. QueryOrderByConstraint , orderBy() çağrılarak oluşturulur ve daha sonra bu QueryOrderByConstraint de içeren yeni bir sorgu örneği oluşturmak için query()' ye iletilebilir. Not: orderBy alanını içermeyen belgeler sorgu sonucunda mevcut olmayacaktır. |
Sorgu Anlık Görüntüsü | Bir QuerySnapshot bir sorgunun sonuçlarını temsil eden sıfır veya daha fazla DocumentSnapshot nesnesi içerir. Belgelere docs özelliği aracılığıyla bir dizi olarak erişilebilir veya forEach yöntemi kullanılarak numaralandırılabilir. empty ve size özellikleri aracılığıyla belge sayısı belirlenebilir. |
QueryStartAtConstraint | QueryStartAtConstraint , belgeleri Firestore sorgusu tarafından döndürülen sonuç kümesinin başlangıcından hariç tutmak için kullanılır. QueryStartAtConstraint ler startAt() veya startAfter() çağrılarak oluşturulur ve daha sonra bu QueryStartAtConstraint öğesini de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
Zaman damgası | Timestamp UTC Epoch zamanında nanosaniye çözünürlükte saniyeler ve saniyelerin kesirleri olarak temsil edilen, herhangi bir saat diliminden veya takvimden bağımsız olarak zaman içindeki bir noktayı temsil eder. Gregoryen takvimini geriye doğru birinci yıla kadar genişleten Proleptik Gregoryen Takvimi kullanılarak kodlanmıştır. Tüm dakikaların 60 saniye uzunluğunda olduğu varsayılarak kodlanmıştır, yani artık saniyeler "bulaşmıştır", böylece yorumlama için artık saniye tablosuna ihtiyaç duyulmaz. Aralık 0001-01-01T00:00:00Z ila 9999-12-31T23:59:59.999999999Z arasındadır. Örnekler ve daha fazla spesifikasyon için Zaman Damgası tanımına bakın. . |
İşlem | Bir işleme referans. Bir işlemin updateFunction işlevine iletilen Transaction nesnesi, işlem bağlamı içindeki verileri okuma ve yazma yöntemlerini sağlar. runTransaction()' a bakın . |
YazmaToplusu | Tek bir atomik birim olarak birden fazla yazma işlemi gerçekleştirmek için kullanılan bir yazma grubu. WriteBatch nesnesi writeBatch() çağrılarak elde edilebilir. . Yazma grubuna yazma işlemleri eklemek için yöntemler sağlar. WriteBatch.commit() çağrılıncaya kadar yazmaların hiçbiri gerçekleştirilmeyecek (veya yerel olarak görülmeyecek). |
Arayüzler
Arayüz | Tanım |
---|---|
Toplam Özellikler | Bir dizi toplamayı ve bunların takma adlarını belirtir. |
BelgeVerileri | Belge verileri ( setDoc() ile kullanım için) ) değerlerle eşlenen alanlardan oluşur. |
FirestoreDataConverter | AppModelType türündeki kullanıcı nesnelerini DbModelType türündeki Firestore verilerine dönüştürmek için withConverter() tarafından kullanılan dönüştürücü. Dönüştürücüyü kullanmak, nesneleri Firestore'dan saklarken ve alırken genel tür bağımsız değişkenlerini belirtmenize olanak tanır. Bu bağlamda "AppModel", bir uygulamada ilgili bilgi ve işlevleri bir araya paketlemek için kullanılan bir sınıftır. Böyle bir sınıf, örneğin karmaşık, iç içe geçmiş veri türlerine sahip özelliklere, not alma için kullanılan özelliklere, Firestore tarafından desteklenmeyen türlerin özelliklerine ( symbol ve bigint gibi) ve bileşik işlemleri gerçekleştiren yardımcı işlevlere sahip olabilir. Bu tür sınıfların bir Firestore veritabanında saklanması uygun değildir ve/veya mümkün değildir. Bunun yerine, bu tür sınıfların örneklerinin, potansiyel olarak diğer POJO'ların veya POJO dizilerinin içine yerleştirilmiş, yalnızca ilkel özelliklere sahip "düz eski JavaScript nesnelerine" (POJO'lar) dönüştürülmesi gerekir. Bu bağlamda bu tür "DbModel" olarak anılır ve Firestore'da kalıcı olmaya uygun bir nesne olacaktır. Kolaylık sağlamak için uygulamalar, FirestoreDataConverter uygulayabilir ve dönüştürücüyü, Firestore'da depolarken AppModel otomatik olarak DbModel dönüştürmek ve Firestore'dan alırken DbModel AppModel dönüştürmek için DocumentReference veya Query gibi Firestore nesnelerine kaydedebilir. |
Ayarlar | Cloud Firestore örneğiniz için özel yapılandırmaları belirtir. Başka yöntemleri çağırmadan önce bunları ayarlamanız gerekir. |
İşlemSeçenekleri | İşlem davranışını özelleştirme seçenekleri. |
Takma Adları Yazın
Takma Ad yazın | Tanım |
---|---|
Anahtarlara Önek Ekle | Her anahtarın önüne dış anahtarın bir noktaya eklendiği yeni bir harita döndürür. |
Toplam Alan Türü | Firestore tarafından desteklenen tüm AggregateField türlerinin birleşimi. |
Toplam Belirtim Verileri | Anahtarları AggregateSpec alınan ve değerleri AggregateSpec girişinden karşılık gelen AggregateField tarafından gerçekleştirilen toplamanın sonucu olan bir tür. |
Toplama Türü | Gerçekleştirilecek agrega tipini temsil eden birleşim tipi. |
ÇocukGüncelleme Alanları | Belirli bir T1 türü için iç içe geçmiş alanların hesaplanmasına yönelik yardımcı. Bu, undefined | {...} gibi birleşim türlerini dağıtmak için gereklidir. undefined | {...} (isteğe bağlı aksesuarlar için olur) veya {a: A} | {b: B} . Bu kullanım durumunda, T[K] bir ifade olarak değerlendirildiğinden ve dağıtılmadığından, Record üzerinde T[K] 'nin birleşim türlerini dağıtmak için V kullanılır. Bkz. https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types |
FirestoreErrorCode | Firestore durum kodları kümesi. Kodlar burada gRPC tarafından sunulan kodlarla aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Olası değerler: - 'iptal edildi': İşlem iptal edildi (genellikle arayan tarafından). - 'bilinmiyor': Bilinmeyen hata veya farklı bir hata etki alanından gelen hata. - 'geçersiz argüman': Müşteri geçersiz bir argüman belirtti. Bunun 'başarısız önkoşul'dan farklı olduğunu unutmayın. 'geçersiz argüman', sistemin durumuna bakılmaksızın sorunlu olan argümanları belirtir (örn. geçersiz alan adı). - 'son tarih aşıldı': İşlem tamamlanamadan son tarih sona erdi. Sistemin durumunu değiştiren işlemlerde, işlem başarıyla tamamlansa bile bu hata dönebilir. Örneğin, bir sunucudan gelen başarılı bir yanıt, sürenin dolmasına yetecek kadar gecikmiş olabilir. - 'bulunamadı': İstenilen bazı belgeler bulunamadı. - 'zaten mevcut': Oluşturmaya çalıştığımız bazı belgeler zaten mevcut. - 'izin reddedildi': Arayanın belirtilen işlemi yürütme izni yok. - 'kaynak tükendi': Kaynakların bir kısmı tükendi, kullanıcı başına kota olabilir veya tüm dosya sisteminde yer kalmadı. - 'başarısız önkoşul': Sistem, işlemin yürütülmesi için gerekli durumda olmadığından işlem reddedildi. - 'durduruldu': İşlem, genellikle işlem iptalleri vb. gibi bir eşzamanlılık sorunu nedeniyle durduruldu. - 'aralık dışı': Geçerli aralığın ötesinde işlem yapılmaya çalışıldı. - 'uygulanmamış': İşlem uygulanmadı veya desteklenmiyor/etkinleştirilmiyor. - 'dahili': Dahili hatalar. Temel sistemin beklediği bazı değişmezlerin bozulduğu anlamına gelir. Bu hatalardan birini görüyorsanız bir şeyler çok bozuk demektir. - 'kullanılamıyor': Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve geri çekilmeyle yeniden denenerek düzeltilebilir. - 'veri kaybı': Kurtarılamaz veri kaybı veya bozulması. - 'kimliği doğrulanmamış': İsteğin, işlem için geçerli kimlik doğrulama bilgileri yok. |
İç İçe Güncelleştirme Alanları | Her alan için (örn. 'bar'), iç içe geçmiş tüm anahtarları bulun (örn. { 'bar.baz': T1, 'bar.qux': T2 } ). İsteğe bağlı olarak işaretlenmiş tüm olası anahtarları içeren tek bir harita oluşturmak için bunları kesiştirin |
Yöne Göre Sipariş | OrderBy() cümlesinin yönü 'azalan' veya 'artan' (azalan veya artan) olarak belirtilir. |
Kısmi WithFieldValue | TypeScript'in Partial<T> öğesine benzer, ancak iç içe geçmiş alanların atlanmasına ve FieldValues'un özellik değerleri olarak aktarılmasına izin verir. |
İlkel | İlkel türler. |
Sorgu Kısıtlaması Türü | Bu SDK'da bulunan farklı sorgu kısıtlamalarını açıklar. |
Sorgu Filtresi Kısıtlaması | QueryFilterConstraint QueryFieldFilterConstraint ve QueryCompositeFilterConstraint'i temsil eden yardımcı bir birleşim türüdür . |
QueryNonFilterConstraint | QueryNonFilterConstraint belge kümesini daraltmak veya sıralamak için kullanılan ancak bir belge alanında açıkça filtreleme yapmayan QueryConstraint'leri temsil eden bir yardımcı birleşim türüdür. QueryNonFilterConstraint orderBy() çağrılarak oluşturulur. , başlamak() , startAfter() , endBefore() , sonunda() , limit() veya limitToLast() ve daha sonra QueryConstraint de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir. |
Seçenekleri Ayarla | setDoc() davranışını yapılandıran bir seçenekler nesnesi ve aramalar. Bu çağrılar, bir SetOptions ile merge: true sağlanarak hedef belgelerin bütünüyle üzerine yazmak yerine ayrıntılı birleştirmeler gerçekleştirecek şekilde yapılandırılabilir. |
Birleşimden Kavşağa | Birleşim türü verildiğinde U = T1 | T2 | ... , kesişen bir tür döndürür (T1 & T2 & ...) . Dağıtıcı koşullu türleri ve koşullu türlerden çıkarımı kullanır. Bu işe yarar çünkü aynı tip değişken için zıt değişken konumlarındaki birden fazla aday, bir kesişim tipinin çıkarılmasına neden olur. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tip |
Veriyi güncelle | Verileri güncelle ( updateDoc() ile kullanım için) ) değerlerle eşlenen alan yollarından (örneğin 'foo' veya 'foo.baz') oluşur. Nokta içeren alanlar, belge içindeki iç içe geçmiş alanlara referans verir. FieldValues özellik değerleri olarak aktarılabilir. |
WhereFilterOp | Where() yan tümcesindeki filtre koşulları '<', '<=', '==', '!=', '>=', '>', 'array-contains' dizeleri kullanılarak belirtilir , 'içeride', 'dizi-herhangi birini içerir' ve 'içeride değil'. |
Alan Değeri ile | Tür güvenliğini korurken FieldValues'un bir özellik değeri olarak aktarılmasına izin verir. |
işlev(uygulama, ...)
getFirestore(uygulama)
Sağlanan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Hiçbir örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
İmza:
export declare function getFirestore(app: FirebaseApp): Firestore;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
uygulama | Firebase Uygulaması | Döndürülen Firestore örneğinin ilişkili olduğu FirebaseApp örneği. |
İadeler:
Sağlanan uygulamanın Firestore örneği.
getFirestore(uygulama, veritabanı kimliği)
Bu API, geliştiriciler için bir önizleme olarak sağlanmıştır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi üretim ortamında kullanmayın.
Sağlanan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür . Hiçbir örnek mevcut değilse, varsayılan ayarlarla yeni bir örneği başlatır.
İmza:
export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
uygulama | Firebase Uygulaması | Döndürülen Firestore örneğinin ilişkili olduğu FirebaseApp örneği. |
veritabanı kimliği | sicim | Veritabanının adı. |
İadeler:
Sağlanan uygulamanın Firestore örneği.
startupizeFirestore(uygulama, ayarlar)
Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. .
İmza:
export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
uygulama | Firebase Uygulaması | Firestore örneğinin ilişkilendirileceği FirebaseApp . |
ayarlar | Ayarlar | Firestore örneğini yapılandırmak için bir ayarlar nesnesi. |
İadeler:
Yeni başlatılan bir Firestore
örneği.
startupizeFirestore(uygulama, ayarlar, veritabanı kimliği)
Bu API, geliştiriciler için bir önizleme olarak sağlanmıştır ve aldığımız geri bildirimlere göre değişebilir. Bu API'yi üretim ortamında kullanmayın.
Sağlanan ayarlarla Cloud Firestore'un yeni bir örneğini başlatır. Yalnızca getFirestore() dahil diğer işlevlerden önce çağrılabilir . Özel ayarlar boşsa, bu işlev getFirestore() işlevinin çağrılmasına eşdeğerdir. .
İmza:
export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
uygulama | Firebase Uygulaması | Firestore örneğinin ilişkilendirileceği FirebaseApp . |
ayarlar | Ayarlar | Firestore örneğini yapılandırmak için bir ayarlar nesnesi. |
veritabanı kimliği | sicim | Veritabanının adı. |
İadeler:
Yeni başlatılan bir Firestore
örneği.
fonksiyon(ateş deposu, ...)
koleksiyon(firestore, yol, yolSegmentleri)
Belirtilen mutlak yoldaki koleksiyona başvuran bir CollectionReference
örneği alır.
İmza:
export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Kök Firestore örneğine bir referans. |
yol | sicim | Bir koleksiyona giden eğik çizgiyle ayrılmış yol. |
yol Segmentleri | sicim[] | İlk bağımsız değişkene göre uygulanacak ek yol bölümleri. |
İadeler:
KoleksiyonReferans < BelgeVerileri , BelgeVerileri >
CollectionReference
örneği.
İstisnalar
Son yolun çift sayıda bölümü varsa ve bir koleksiyona işaret etmiyorsa.
koleksiyonGrubu(ateş deposu, koleksiyon kimliği)
Verilen koleksiyon kimliğine sahip bir koleksiyonda veya alt collectionId
bulunan veritabanındaki tüm belgeleri içeren yeni bir Query
örneği oluşturur ve döndürür .
İmza:
export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Kök Firestore örneğine bir referans. |
koleksiyon kimliği | sicim | Sorgulanacak koleksiyonları tanımlar. Yolunun son bölümü olarak bu kimliğe sahip her koleksiyon veya alt koleksiyon dahil edilecektir. Eğik çizgi içeremez. |
İadeler:
Sorgu < BelgeVerileri , BelgeVerileri >
Oluşturulan Query
.
ConnectFirestoreEmulator (firestore, ana bilgisayar, bağlantı noktası, seçenekler)
Bulut Firestore Emulator ile iletişim kurmak için bu örneği değiştirin.
İmza:
export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Emülatöre bağlanmak için yapılandırılacak Firestore örneği. |
ev sahibi | sicim | Emülatör ana bilgisayar (Örn: Localhost). |
liman | sayı | Emülatör portu (Örn: 9000). |
seçenekler | {Mockusertoken?: EmulatormockTokenOptions | sicim; } |
İadeler:
geçersiz
Doc (Firestore, Path, Pathsegments)
Belgeyi belirtilen mutlak yolda ifade eden bir DocumentReference
örneği alır.
İmza:
export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Kök Firestore örneğine bir referans. |
yol | sicim | Bir belgeye eğik çizgi ile ayrılmış bir yol. |
yol | sicim[] | İlk argümana göre uygulanacak ek yol segmentleri. |
İadeler:
Belge < DocumentData , DocumentData >
DocumentReference
örneği.
İstisnalar
Son yolun tek sayıda segmenti varsa ve bir belgeye işaret etmiyorsa.
RunTransaction (Firestore, UpdateFonction, Seçenekler)
Verilen updateFunction
yürütür ve ardından işlem içinde uygulanan değişiklikleri işlemeye çalışır. İşlemde okunan herhangi bir belge değiştiyse, Cloud Firestore updateFunction
. 5 denemeden sonra taahhütte bulunmazsa, işlem başarısız olur.
Tek bir işlemde izin verilen maksimum yazma sayısı 500'dür.
İmza:
export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Bu işlemi yürütmek için Firestore veritabanına bir referans. |
Güncelleme Fonksiyonu | (İşlem: İşlem ) => Vaat <t> | İşlem bağlamında yürütülecek işlev. |
seçenekler | İşlemSeçenekleri | Bir seçenek nesnesi, maksimum taahhüt denemesi sayısını yapılandırmak için. |
İadeler:
Söz <T>
İşlem başarıyla tamamlandı veya açıkça iptal edildi ( updateFunction
başarısız bir söz döndürdü), updateFunction
tarafından döndürülen söz buraya iade edildi. Aksi takdirde, işlem başarısız olursa, ilgili hata hatası ile reddedilen bir vaat döndürülür.
sonlandır (firestore)
Verilen Firestore
örneğini sonlandırır.
terminate()
çağrıldıktan sonra yalnızca clearIndexedDbPersistence()
işlevleri kullanılabilir. Başka herhangi bir işlev FirestoreError
atacaktır . Fesih bekleyen yazıları iptal etmez ve sunucudan yanıt bekleyen vaatler çözülmez.
Fesihten sonra yeniden başlatmak için GetFirestore () ile yeni bir Firestore
örneği oluşturun () .
İmza:
export declare function terminate(firestore: Firestore): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu | Firestore örneği sonlandırılacak. |
İadeler:
Söz <void>
Örnek başarıyla feshedildiğinde çözülen bir Promise
.
WriteBatch (Firestore)
Tek bir atom işlemi olarak birden fazla yazma yapmak için kullanılan bir yazma parti oluşturur. Tek bir yazma tabanında izin verilen maksimum yazma sayısı 500'dür.
Bu yazmaların sonucu, yalnızca iade edilen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function writeBatch(firestore: Firestore): WriteBatch;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
itfaiye deposu | Yangın deposu |
İadeler:
Birden fazla yazmayı atomik olarak yürütmek için kullanılabilecek bir WriteBatch
.
işlev()
saymak()
Bir sorgunun sonuç kümesindeki belgelerin sayısını hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.
İmza:
export declare function count(): AggregateField<number>;
İadeler:
Toplu <sayı>
DeleteField ()
Bir alanı silmek için işaretlemek için {merge: true}
ile UpdateC () veya setDoc () ile kullanım için bir sentinel döndürür.
İmza:
export declare function deleteField(): FieldValue;
İadeler:
DocumentId ()
Bir belgenin kimliğine atıfta bulunmak için özel bir Sentinel FieldPath
döndürür. Sorgularda belge kimliğine göre sıralamak veya filtrelemek için kullanılabilir.
İmza:
export declare function documentId(): FieldPath;
İadeler:
getFirestore ()
Varsayılan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
İmza:
export declare function getFirestore(): Firestore;
İadeler:
Sağlanan uygulamanın firestore örneği.
sunucuTimestamp()
Yazılı verilere sunucu tarafından oluşturulan bir zaman damgası eklemek için setDoc () veya updatedoc () ile kullanılan bir sentinel döndürür.
İmza:
export declare function serverTimestamp(): FieldValue;
İadeler:
işlev (databaseId, ...)
GetFirestore (DatabaseId)
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 bir üretim ortamında kullanmayın.
Varsayılan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür . Örnek yoksa, varsayılan ayarlarla yeni bir örneği başlatır.
İmza:
export declare function getFirestore(databaseId: string): Firestore;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
veritabaseid | sicim | Veritabanının adı. |
İadeler:
Sağlanan uygulamanın firestore örneği.
işlev (öğeler, ...)
Arrayremove (Elements)
SetDoc () ile kullanılabilecek özel bir değer döndürür veya sunucuya verilen öğeleri sunucuda zaten var olan herhangi bir dizi değerinden kaldırmasını söyler. Belirtilen her öğenin tüm örnekleri diziden kaldırılır. Değiştirilen alan zaten bir dizi değilse, boş bir dizi ile üzerine yazılır.
İmza:
export declare function arrayRemove(...elements: unknown[]): FieldValue;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
elementler | Bilinmeyen[] | Diziden çıkarılacak öğeler. |
İadeler:
setDoc()
veya updateDoc()
çağrısında kullanılmak üzere FieldValue
Sentinel
ArrayUnion (Elementler)
Sunucuya sunucuya zaten var olan herhangi bir dizi değeri ile verilen öğeleri bir araya getirmesini söyleyen setDoc () veya updatedoc () ile kullanılabilecek özel bir değer döndürür. Dizide halihazırda bulunmayan her belirtilen öğe sonuna eklenecektir. Değiştirilen alan zaten bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi ile üzerine yazılır.
İmza:
export declare function arrayUnion(...elements: unknown[]): FieldValue;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
elementler | Bilinmeyen[] | Diziye birleşmenin unsurları. |
İadeler:
setDoc()
veya updateDoc()
çağrısında kullanılmak üzere FieldValue
Sentinel .
fonksiyon(alan,...)
ortalama (alan)
Bir sorgunun sonuç kümesinde belirtilen bir alanın ortalamasını bir dizi belge üzerinden hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.
İmza:
export declare function average(field: string | FieldPath): AggregateField<number | null>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
alan | Dize | Saha yağı | Sonuç kümesi boyunca ortalama alanı belirtir. |
İadeler:
Toplu <numara | null>
Toplam (Alan)
Bir sorgunun sonuç kümesindeki bir dizi belge üzerinden belirli bir alanın toplamını hesaplamak için kullanılabilecek bir AgregateField nesnesi oluşturun.
İmza:
export declare function sum(field: string | FieldPath): AggregateField<number>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
alan | Dize | Saha yağı | Alanı sonuç kümesi boyunca toplamı belirtir. |
İadeler:
Toplu <sayı>
Fonksiyon (FieldPath, ...)
Sipariş (FieldPath, TalitortionTr)
Sorgu sonucunu belirtilen alana, isteğe bağlı olarak yükselmek yerine azalan sırada sıralayan bir QueryOrderByConstraint oluşturur.
İmza:
export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
saha yağı | Dize | Saha yağı | Sıralamak için alan. |
Talitorttr | Sipariş | Sıralamak için isteğe bağlı yön ('ASC' veya 'DESC'). Belirtilmezse, sipariş yükselecektir. |
İadeler:
Oluşturulan queryorderbyconstraint .
Nerede (FieldPath, Opstr, değer)
Belgelerin belirtilen alanı içermesi ve değerin sağlanan ilişki kısıtlamasını karşılaması gerektiğini zorlayan bir QueryFieldFilterConstraint oluşturur.
İmza:
export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
saha yağı | Dize | Saha yağı | Karşılaştırma Yolu |
opstr | Where Filterop | Operasyon dizesi (örneğin "& lt;", "& lt; =", "==", "& lt;", "& lt; =", "! ="). |
değer | Bilinmeyen | Karşılaştırma değeri |
İadeler:
Oluşturulan QueryFieldFilterConstraint .
Fonksiyon (FieldValues, ...)
Endat (FieldValues)
Sorgunun sırasına göre verilen alanlarda sona erecek şekilde ayarlanan sonucu değiştiren bir queryendAconstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.
İmza:
export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Field Değerler | Bilinmeyen[] | Bu sorguyu, sorgunun siparişine göre sona erdirecek değerler. |
İadeler:
QueryendatConstraint'e Geçmek İçin query()
EndBefore (FieldValues)
Sonuç kümesini, verilen alanlardan önce sorgunun sırasına göre sonuna kadar değiştiren bir queryendAconstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.
İmza:
export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Field Değerler | Bilinmeyen[] | Alan, sorgunun siparişine göre bu sorguyu daha önce bitirmek için değerler. |
İadeler:
QueryendatConstraint'e Geçmek İçin query()
Startafter (FieldValues)
Sonuç kümesini, verilen alanlardan sonra sorgunun sırasına göre başlatacak şekilde değiştiren bir queryStartatConstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.
İmza:
export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Field Değerler | Bilinmeyen[] | Alan, sorgunun siparişine göre bu sorguyu başlatacak değerler. |
İadeler:
QueryStartatConstraint , query()
geçmek için
startat (fieldValues)
Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan başlayacak şekilde değiştiren bir querystartatConstraint oluşturur. Alan değerlerinin sırası, siparişin sırasını sorgunun hükümleriyle eşleştirmelidir.
İmza:
export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Field Değerler | Bilinmeyen[] | Bu sorguyu başlatmak için alan değerleri, sorgunun siparişine göre. |
İadeler:
QueryStartatConstraint , query()
geçmek için .
işlev (sol, ...)
AgregateFieldEqual (sol, sağ)
İki 'agregatefield'i karşılaştırır Eşitlik örnekleri.
İmza:
export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sol | Toplu <bilinmiyor> | Bu AgregateField'ı right karşılaştırın. |
Sağ | Toplu <bilinmiyor> | Bu AgregateField'ı left karşılaştırın. |
İadeler:
boolean
agregatequerysnapshotequal (sol, sağ)
Eşitlik için iki AggregateQuerySnapshot
örneğini karşılaştırır.
İki AggregateQuerySnapshot
örneği, eşit ve aynı verileri karşılaştıran altta yatan sorgular varsa "eşit" olarak kabul edilir.
İmza:
export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sol | Agregatequerysnapshot <Agregatespectype, appModelType, dbmodelType> | Karşılaştırılacak ilk AggregateQuerySnapshot . |
Sağ | Agregatequerysnapshot <Agregatespectype, appModelType, dbmodelType> | Karşılaştırılması için ikinci AggregateQuerySnapshot . |
İadeler:
boolean
Nesneler yukarıda tanımlandığı gibi "eşit" veya başka türlü false
ise true
.
queryEqual(sol, sağ)
Verilen sorgular aynı koleksiyona işaret ederse ve aynı kısıtlamaları uyguladığında true döndürür.
İmza:
export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sol | Sorgu <AppModelType, dbmodelType> | Karşılaştırmak için bir Query . |
Sağ | Sorgu <AppModelType, dbmodelType> | Karşılaştırmak için bir Query . |
İadeler:
boolean
Referanslar aynı Firestore veritabanında aynı konuma işaret ediyorsa.
Refequal (sol, sağ)
Sağlanan referanslar eşitse true döndürür.
İmza:
export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sol | Belge <AppModelType, dbmodelType> | Toplama <AppModelType, dbmodelType> | Karşılaştırmak için bir referans. |
Sağ | Belge <AppModelType, dbmodelType> | Toplama <AppModelType, dbmodelType> | Karşılaştırmak için bir referans. |
İadeler:
boolean
Referanslar aynı Firestore veritabanında aynı konuma işaret ediyorsa.
Snapshotequal (sol, sağ)
Sağlanan anlık görüntüler eşitse true döndürür.
İmza:
export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sol | BelgelerNapshot <AppModelType, dbmodelType> | Querysnapshot <AppModelType, dbmodelType> | Karşılaştırılacak bir anlık görüntü. |
Sağ | BelgelerNapshot <AppModelType, dbmodelType> | Querysnapshot <AppModelType, dbmodelType> | Karşılaştırılacak bir anlık görüntü. |
İadeler:
boolean
Anlık görüntüler eşitse doğru.
fonksiyon(limit, ...)
limit(limit)
Yalnızca ilk eşleşen belgeleri döndüren bir queryLimitConstraint oluşturur.
İmza:
export declare function limit(limit: number): QueryLimitConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sınır | sayı | Geri dönecek maksimum öğe sayısı. |
İadeler:
Oluşturulan querylimitconstraint .
limitToLast(sınır)
Yalnızca son eşleşen belgeleri döndüren bir queryLimitConstraint oluşturur.
limitToLast
sorguları için en az bir orderBy
Maddesi belirtmelisiniz, aksi takdirde yürütme sırasında bir istisna atılacaktır.
İmza:
export declare function limitToLast(limit: number): QueryLimitConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sınır | sayı | Geri dönecek maksimum öğe sayısı. |
İadeler:
Oluşturulan querylimitconstraint .
işlev (loglevel, ...)
Setloglevel (Loglevel)
Bulut Firestore günlüklerinin (hata ayıklama, hata veya sessiz) meselesini ayarlar.
İmza:
export declare function setLogLevel(logLevel: LogLevel): void;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Loglevel | Loglevel | Etkinlik ve hata günlüğü için belirlediğiniz tekerlek. Aşağıdaki değerlerden herhangi biri olabilir:
|
İadeler:
geçersiz
işlev (n, ...)
artış(n)
Sunucuya verilen değere göre alanın geçerli değerini artırmasını söyleyen setDoc () veya updatedoc () ile kullanılabilecek özel bir değer döndürür.
İşlenen veya mevcut alan değeri yüzen nokta hassasiyetini kullanıyorsa, tüm aritmetik IEEE 754 anlambilimini takip eder. Her iki değer de tamsayılar ise, JavaScript'in güvenli sayı aralığının dışındaki değerler ( Number.MIN_SAFE_INTEGER
- Number.MAX_SAFE_INTEGER
) ayrıca hassas kayıplara tabidir. Ayrıca, Firestore arka ucu tarafından işlendikten sonra, tüm tamsayı işlemleri -2^63 ve 2^63-1 arasında sınırlıdır.
Geçerli alan değeri tür number
değilse veya alan henüz mevcut değilse, dönüşüm alanı verilen değere ayarlar.
İmza:
export declare function increment(n: number): FieldValue;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
N | sayı | Artış değeri. |
İadeler:
setDoc()
veya updateDoc()
çağrısında kullanılmak üzere FieldValue
Sentinel
işlev (sorgu, ...)
getAgregate (sorgu, agregatespec)
Belgeleri gerçekten indirmeden verilen sorgunun sonuç kümesindeki belgeler üzerindeki belirtilen toplamaları hesaplar.
Toplama yapmak için bu işlevi kullanmak etkilidir, çünkü belgelerin verileri değil, yalnızca son toplama değerleri indirilir. Bu işlev, sonuç setinin tamamen indirilmesi (binlerce belge) için hassas bir şekilde büyük olduğu durumlarda belgelerin toplamalarını gerçekleştirebilir.
İmza:
export declare function getAggregate<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sorgu | Sorgu <AppModelType, dbmodelType> | Sonuç seti üzerinde toplanan sorgu. |
agregatespec | Agregatespecpectype | Agregatları sonuç kümesi üzerinde gerçekleştirecek şekilde belirten bir AggregateSpec nesnesi. AgregateSpec, toplam sonucu almak için kullanılabilen her bir agrega için takma adlar belirtir. |
İadeler:
Promise < agregatequerysnapshot <Agregatespectype, appModelType, dbmodelType >>
Örnek
const aggregateSnapshot = await getAggregate(query, {
countOfDocs: count(),
totalHours: sum('hours'),
averageScore: average('score')
});
const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;
getCount (sorgu)
Belgeleri gerçekten indirmeden verilen sorgunun sonuç kümesindeki belge sayısını hesaplar.
Belgeleri saymak için bu işlevi kullanmak etkilidir, çünkü yalnızca belgelerin verileri değil, son sayı indirilir. Bu işlev, sonuç kümesinin tamamen indirmek için çok büyük olduğu durumlarda belgeleri sayabilir (binlerce belge).
İmza:
export declare function getCount<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
count: AggregateField<number>;
}, AppModelType, DbModelType>>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sorgu | Sorgu <AppModelType, dbmodelType> | Sonuç set boyutu hesaplanan sorgu. |
İadeler:
Promise < agregatequerysnapshot <{Count: AgregateField <Suster>; }, AppModelType, dbmodelType >>
Sayımla çözülecek bir söz; Sayım snapshot.data().count
burada snapshot
, iade edilen sözün çözüldüğü AggregateQuerySnapshot
.
getDocs (sorgu)
Sorguyu yürütür ve sonuçları querysnapshot olarak döndürür .
Sorgu daha önce yürütülmüş olsa bile, tüm sorgular doğrudan sunucu tarafından yürütülür. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışsa alınan sonuçlara yansıtılır. Müşteri çevrimdışı ise işlem başarısız olur. Daha önce önbelleğe alınmış sonucu ve yerel değişiklikleri görmek için tam Firestore SDK'sını kullanın.
İmza:
export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sorgu | Sorgu <AppModelType, dbmodelType> | Yürütülecek Query . |
İadeler:
Söz < querysnapshot <AppModelType, dbmodelType >>
Sorgunun sonuçlarıyla çözülecek bir söz.
Sorgu (Sorgu, CompositeFilter, QueryConstraints)
Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.
İmza:
export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sorgu | Sorgu <AppModelType, dbmodelType> | Yeni kısıtlamalar için bir temel olarak kullanılacak sorgu örneği. |
compositfilter | QueryCompositeFilterConstraint | Uygulanacak QueryCompositeFilterConstraint . Ve () veya veya () kullanarak queryCompositeFilterConstraint oluşturun . |
queryconstraints | Querynonfilterconstraint [] | Ek QueryNonFilterConstraint Saplamak için (örneğin sipariş () , limit () ). |
İadeler:
Sorgu <AppModelType, dbmodelType>
İstisnalar
Sağlanan sorgu kısıtlamalarından herhangi biri mevcut veya yeni kısıtlamalarla birleştirilemezse.
sorgu(sorgu, queryConstraints)
Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.
İmza:
export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sorgu | Sorgu <AppModelType, dbmodelType> | Yeni kısıtlamalar için bir temel olarak kullanılacak sorgu örneği. |
queryconstraints | Sorgu Kısıtlaması [] | QueryConstraint listesi uygulamak için. |
İadeler:
Sorgu <AppModelType, dbmodelType>
İstisnalar
Sağlanan sorgu kısıtlamalarından herhangi biri mevcut veya yeni kısıtlamalarla birleştirilemezse.
işlev (queryConstraints, ...)
ve (QueryConstraints)
Verilen filtre kısıtlamalarının bir birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir bağlaç filtresi, verilen tüm filtreleri karşılıyorsa bir belge içerir.
İmza:
export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
queryconstraints | QueryFilterConstraint [] | İsteğe bağlı. QueryFilterConstraint listesi s. Bunlar , WHERE () ' , veya() veya ve () . |
İadeler:
QueryCompositeFilterConstraint
Yeni oluşturulan QueryCompositeFilterConstraint .
veya (QueryConstraints)
Verilen filtre kısıtlamalarının bir ayrıştırılması olan yeni bir QueryCompositeFilterConstraint oluşturur. Bir ayrışma filtresi, verilen filtrelerden herhangi birini karşılıyorsa bir belge içerir.
İmza:
export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
queryconstraints | QueryFilterConstraint [] | İsteğe bağlı. QueryFilterConstraint listesi Siken bir ayrılık gerçekleştirmek için. Bunlar , WHERE () ' , veya() veya ve () . |
İadeler:
QueryCompositeFilterConstraint
Yeni oluşturulan QueryCompositeFilterConstraint .
işlev (referans, ...)
AddDoc (referans, veriler)
Verilen verilerle belirtilen CollectionReference
referansına yeni bir belge ekleyin ve otomatik olarak bir belge kimliği atayın.
Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Toplama <AppModelType, dbmodelType> | Bu belgeyi eklemek için koleksiyona bir referans. |
veri | WithfieldValue <PppModelType> | Yeni belgenin verilerini içeren bir nesne. |
İadeler:
Söz < DocumentReference <AppModelType, dbmodelType >>
Bir Promise
arka ucuna yazıldıktan sonra yeni oluşturulan belgeye işaret eden bir DocumentReference
referansı ile çözüldü.
İstisnalar
Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.
Koleksiyon (Referans, Yol, PathSegments)
Belirtilen göreceli yolda reference
alt koleksiyonuna atıfta bulunan bir CollectionReference
örneği alır.
İmza:
export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Toplama <AppModelType, dbmodelType> | Bir koleksiyona referans. |
yol | sicim | Bir koleksiyona doğru ayrılmış bir yol. |
yol | sicim[] | İlk argümana göre uygulanacak ek yol segmentleri. |
İadeler:
Toplama < DocumentData , DocumentData >
CollectionReference
örneği.
İstisnalar
Son yolun eşit sayıda segmenti varsa ve bir koleksiyona işaret etmiyorsa.
Koleksiyon (Referans, Yol, PathSegments)
Belirtilen göreceli yolda reference
alt koleksiyonuna atıfta bulunan bir CollectionReference
örneği alır.
İmza:
export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Bir Firestore belgesine referans. |
yol | sicim | Bir koleksiyona doğru ayrılmış bir yol. |
yol | sicim[] | İlk argümana göre uygulanacak ek yol segmentleri. |
İadeler:
Toplama < DocumentData , DocumentData >
CollectionReference
örneği.
İstisnalar
Son yolun eşit sayıda segmenti varsa ve bir koleksiyona işaret etmiyorsa.
Deletedoc (referans)
Belirtilen DocumentReference
tarafından atıfta bulunulan belgeyi siler .
Silme yalnızca iade edilen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, silme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Silecek belgeye bir referans. |
İadeler:
Söz <void>
Belge arka uçtan başarıyla silindikten sonra bir Promise
çözüldü.
Doc (referans, yol, yolsegmentler)
Belirtilen göreli yolda reference
olarak bir belgeyi ifade eden bir DocumentReference
örneği alır. Herhangi bir yol belirtilmezse, döndürülen DocumentReference
için otomatik olarak oluşturulan benzersiz bir kimlik kullanılacaktır .
İmza:
export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Toplama <AppModelType, dbmodelType> | Bir koleksiyona referans. |
yol | sicim | Bir belgeye eğik çizgi ile ayrılmış bir yol. Otomatik olarak oluşturulan kimlikler kullanmayı ihmal edilmelidir. |
yol | sicim[] | İlk argümana göre uygulanacak ek yol segmentleri. |
İadeler:
Belge <AppModelType, dbmodelType>
DocumentReference
örneği.
İstisnalar
Son yolun tek sayıda segmenti varsa ve bir belgeye işaret etmiyorsa.
Doc (referans, yol, yolsegmentler)
Belirtilen göreli yolda reference
olarak bir belgeyi ifade eden bir DocumentReference
örneği alır.
İmza:
export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Bir Firestore belgesine referans. |
yol | sicim | Bir belgeye eğik çizgi ile ayrılmış bir yol. |
yol | sicim[] | İlk argümana göre uygulanacak ek yol segmentleri. |
İadeler:
Belge < DocumentData , DocumentData >
DocumentReference
örneği.
İstisnalar
Son yolun tek sayıda segmenti varsa ve bir belgeye işaret etmiyorsa.
getDoc (referans)
Belirtilen belge referansıyla belirtilen belgeyi okur.
Belge daha önce okunmuş veya değiştirilmiş olsa bile, tüm belgeler doğrudan sunucudan getirilir. Son değişiklikler yalnızca arka uç tarafından zaten uygulanmışlarsa, alınan DocumentSnapshot
yansıtılır. Müşteri çevrimdışı ise, okuma başarısız olur. Önbellekleme kullanmayı veya yerel değişiklikleri görmek isterseniz, lütfen tam Firestore SDK'sını kullanın.
İmza:
export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Belgenin getirilmesi için referansı. |
İadeler:
Söz < DocumentsNapShot <AppModelType, dbmodelType >>
Mevcut belge içeriğini içeren bir DocumentSnapshot
çözülmüş bir söz.
setDoc (referans, veriler)
Belirtilen DocumentReference
tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse, oluşturulacaktır.
Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Yazılacak belgeye bir referans. |
veri | WithfieldValue <PppModelType> | Belge için alanların ve değerlerin haritası. |
İadeler:
Söz <void>
Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise
çözüldü.
İstisnalar
Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.
setDoc (referans, veri, seçenekler)
Belirtilen DocumentReference
tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse, oluşturulacaktır. merge
veya mergeFields
sağlarsanız , sağlanan veriler mevcut bir belgede birleştirilebilir.
Bu yazının sonucu yalnızca döndürülen vaat çözülmesinden sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, yazma başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Yazılacak belgeye bir referans. |
veri | Kısmiwithfieldvalue <PppModelType> | Belge için alanların ve değerlerin haritası. |
seçenekler | Setoptions | Set davranışını yapılandırmak için bir nesne. |
İadeler:
Söz <void>
Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise
çözüldü.
İstisnalar
Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.
UpdateC (referans, veriler)
Belgedeki alanları, belirtilen DocumentReference
referansıyla atıfta bulunun . Var olmayan bir belgeye uygulanırsa güncelleme başarısız olur.
Bu güncellemenin sonucu yalnızca döndürülen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Güncelleme belgesine bir referans. |
veri | Veriyi güncelle <DbmodelType> | Belgeyi güncellemek için alanları ve değerleri içeren bir nesne. Alanlar, belgedeki iç içe geçmiş alanlara referans vermek için noktalar içerebilir. |
İadeler:
Söz <void>
Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise
çözüldü.
İstisnalar
Hata - Sağlanan giriş geçerli değilse, FIRESTORE verileri.
Updateoc (referans, alan, değer, mazeriye kanadvalues)
Belgedeki alanları, belirtilen DocumentReference
tarafından atıfta bulunulan güncelleme, mevcut olmayan bir belgeye uygulanırsa güncelleme başarısız olur.
Yuvalanmış alanlar, nokta tarafından ayrılmış alan yolu dizeleri sağlayarak veya FieldPath
nesneleri sağlayarak güncellenebilir.
Bu güncellemenin sonucu yalnızca döndürülen vaat çözüldükten sonra meydana gelen belge okumalarına yansıtılacaktır. Müşteri çevrimdışı ise, güncelleme başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz, tam Firestore SDK'sını kullanın.
İmza:
export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
referans | Belge <AppModelType, dbmodelType> | Güncelleme belgesine bir referans. |
alan | Dize | Saha yağı | Güncellenecek ilk alan. |
değer | Bilinmeyen | İlk değer. |
MorefieldsandValues | Bilinmeyen[] | Ek anahtar değer çiftleri. |
İadeler:
Söz <void>
Veriler arka ucuna başarıyla yazıldıktan sonra bir Promise
çözüldü.
İstisnalar
Hata - Sağlanan giriş geçerli değilse, FIRESTORE verileri.
Fonksiyon (Snapshot, ...)
Endat (anlık görüntü)
Verilen belgede (dahil) sonucunu değiştiren bir queryendAconstraint oluşturur (dahil). Son konum sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.
İmza:
export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
enstantane fotoğraf | BelgelerNapshot <AppModelType, dbmodelType> | Belgenin anlık görüntüsü bitecek. |
İadeler:
QueryendatConstraint'e Geçmek İçin query()
EndBefore (Snapshot)
Verilen belgeden (özel) önce sonucunu değiştiren bir queryendAconstraint oluşturur (özel). Son konum sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.
İmza:
export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
enstantane fotoğraf | BelgelerNapshot <AppModelType, dbmodelType> | Belgenin enstantane daha önce bitecek. |
İadeler:
QueryendatConstraint'e Geçmek İçin query()
startafter (anlık görüntü)
Verilen belgeden sonra (özel) başlayacak olan sonucu değiştiren bir querystartatConstraint oluşturur. Başlangıç konumu sorgunun sırasına göre. Belge, sorgunun siparişinde sağlanan tüm alanları içermelidir.
İmza:
export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
enstantane fotoğraf | BelgelerNapshot <AppModelType, dbmodelType> | Belgenin anlık görüntüsü sonra başlayacak. |
İadeler:
QueryStartatConstraint , query()
geçmek için
startat (anlık görüntü)
Verilen belgede (dahil) başlayacak olan sonucu değiştiren bir queryStartatConstraint oluşturur. Başlangıç konumu sorgunun sırasına göre. Belge, bu sorgunun orderBy
sağlanan tüm alanları içermelidir.
İmza:
export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
enstantane fotoğraf | BelgelerNapshot <AppModelType, dbmodelType> | Belgenin başlaması için anlık görüntü. |
İadeler:
QueryStartatConstraint , query()
geçmek için .
Addprefixtokeys
Her anahtarın bir noktaya eklenen dış anahtarla önek olduğu yeni bir harita döndürür.
İmza:
export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
[K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};
AgregateFieldType
Firestore tarafından desteklenen tüm AggregateField
türlerinin birleşmesi.
İmza:
export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;
Agregatespecdata
Anahtarları bir AggregateSpec
alınan bir tür ve değerleri, giriş AggregateSpec
karşılık gelen AggregateField
tarafından gerçekleştirilen toplama sonucu olan .
İmza:
export declare type AggregateSpecData<T extends AggregateSpec> = {
[P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};
AgregateType
Gerçekleştirilecek toplam türü temsil eden sendika tipi.
İmza:
export declare type AggregateType = 'count' | 'avg' | 'sum';
Childupdatefields
Belirli bir T1 tipi için iç içe geçmiş alanları hesaplamak için yardımcı. Bu, undefined | {...}
(isteğe bağlı sahne için olur) veya {a: A} | {b: B}
.
Bu kullanım durumunda V
, T[K]
sendika türlerini Record
üzerine dağıtmak için kullanılır , çünkü T[K]
bir ifade olarak değerlendirilir ve dağıtılmaz.
Bkz.
İmza:
export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
Firestoreerrorcode
Firestore durum kodları kümesi. Kodlar GRPC tarafından maruz kalanlarda aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
Olası değerler: - 'iptal edildi': işlem iptal edildi (tipik olarak arayan tarafından). - 'Bilinmeyen': Bilinmeyen hata veya farklı bir hata alanından bir hata. - 'Geçersiz-Argument': Müşteri geçersiz bir argüman belirtti. Bunun 'Başarısızlıktan' farklı olduğunu unutmayın. 'Geçersiz argüman', sistemin durumundan bağımsız olarak sorunlu olan argümanları gösterir (örneğin geçersiz bir alan adı). - 'Son tarih aşıldı': İşlem tamamlanmadan önce son teslim tarihi süresi dolmadan. Sistemin durumunu değiştiren işlemler için, işlem başarıyla tamamlanmış olsa bile bu hata döndürülebilir. Örneğin, bir sunucudan başarılı bir yanıt, son başvuru tarihinin süresi dolabın yeterince gecikmiş olabilir. - 'Bulunmayan': İstenen bazı belgeler bulunamadı. - 'Zaten var': Oluşturmaya çalıştığımız bazı belgeler zaten var. - 'İzinten Denetimli': Arayanın belirtilen işlemi yürütme izni yoktur. -'Kaynak tarafından tükenmiş': Bazı kaynaklar tükenmiştir, belki de kullanıcı başına bir kota veya belki de tüm dosya sistemi alanın dışındadır. - 'Başarısızlık-Koşul': Sistem, işlemin yürütülmesi için gerekli bir durumda olmadığı için işlem reddedildi. - 'Durgun': Tipik olarak işlem iptalleri vb. Gibi eşzamanlılık sorunu nedeniyle işlemi iptal edildi.- 'Aralık dışı': Operasyon geçerli aralığın ötesine geçti. - 'Uygulanmamış': İşlem uygulanmaz veya desteklenmez/etkinleştirilmez. - 'Dahili': Dahili hatalar. Altta yatan sistem tarafından beklenen bazı değişmezlerin kırıldığı anlamına gelir. Bu hatalardan birini görürseniz, bir şey çok kırılır. - 'Kullanılamaz': Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve bir geri çekilme ile yeniden denenerek düzeltilebilir. - 'Veri kaybı': Tahmin edilemez veri kaybı veya yolsuzluk. - 'Kemerin Eklenmemiş': Talep, işlem için geçerli kimlik doğrulama kimlik bilgileri yoktur.
İmza:
export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
Nestedupdatefields
Her alan için (örn. 'Bar'), tüm iç içe anahtarları bulun (örn. { 'Bar.baz': t1, 'bar.qux': t2 } ). Hepsi isteğe bağlı olarak işaretlenmiş tüm olası anahtarları içeren tek bir harita yapmak için bunları birbirine takın
İmza:
export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
[K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;
Sipariş
Bir sipariş () maddesinin yönü 'desc' veya 'ASC' (azalan veya yükselen) olarak belirtilir.
İmza:
export declare type OrderByDirection = 'desc' | 'asc';
Kısmiwithfieldvalue
TypeScript'in Partial<T>
, ancak iç içe geçmiş alanların atlanmasına ve mülk değerleri olarak aktarılmasına izin verir.
İmza:
export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
[K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);
İlkel
İlkel türler.
İmza:
export declare type Primitive = string | number | boolean | undefined | null;
Sorgu Kısıtlaması Türü
Bu SDK'da bulunan farklı sorgu kısıtlamalarını açıklar.
İmza:
export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';
QueryFilterConstraint
QueryFilterConstraint
, QueryFieldFilterConstraint ve QueryCompositeFilterConstraint'i temsil eden bir yardımcı sendika türüdür .
İmza:
export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
Querynonfilterconstraint
QueryNonFilterConstraint
belge kümesini daraltmak veya sipariş etmek için kullanılan, ancak bir belge alanında açıkça filtrelemeyen sorgulamaları temsil eden bir yardımcı birlik türüdür. QueryNonFilterConstraint
S , Düzen () çağırarak oluşturulur () , başlamak() , startAfter() , endBefore() , sonunda() , Limit () veya Limittolast () ve daha sonra QueryConstraint
de içeren yeni bir sorgu örneği oluşturmak için query () ' e aktarılabilir .
İmza:
export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;
Setoptions
SetDoc () davranışını yapılandıran bir seçenek nesnesi ve çağrılar. Bu çağrılar, bir SetOptions
ile merge: true
.
İmza:
export declare type SetOptions = {
readonly merge?: boolean;
} | {
readonly mergeFields?: Array<string | FieldPath>;
};
UnionTointersection
Birlik tipi U = T1 | T2 | ...
, kesişen bir tür döndürür (T1 & T2 & ...)
.
Koşullu tiplerden dağıtım koşullu türleri ve çıkarım kullanır. Bu çalışır, çünkü aynı tip değişken için birden fazla aday, varyant pozisyonlarında bir kavşak türünün çıkarılmasına neden olur. https://www.typescriptlang.org/docs/handbook/adved-types.html#type-in-inditional-types https: https: https: -tip
İmza:
export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
Veriyi güncelle
Verileri Güncelle ( UpdateC () ile kullanım için ) değerlerle eşlenen alan yollarından (örneğin 'foo' veya 'foo.baz') oluşur. Nokta içeren alanlar belgede iç içe geçmiş alanlara başvurur. Field Değerleri mülk değerleri olarak aktarılabilir.
İmza:
export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
[K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;
Where Filterop
Bir WHERE () maddesindeki filtre koşulları '& lt;', '==', '! =', '& Gt; =', '& gt;', 'dizi-contains' dizeleri kullanılarak belirtilir. , 'in', 'dizi-contains-herhangi bir' ve 'no-in'.
İmza:
export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
WithfieldValue
Tür güvenliğini korurken alan değerlerinin bir özellik değeri olarak aktarılmasına izin verir.
İmza:
export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
[K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);