@firebase/firestore/lite

Sağlanan uygulamanın Firestore örneği.

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.

Sağlanan FirebaseApp ile ilişkili mevcut Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması	Döndürülen Firestore örneğinin ilişkili olduğu FirebaseApp örneği.
veritabanı kimliği	dize	Veritabanının adı.

Şunu döndürür:

Sağlanan uygulamanın Firestore örneği.

startizeFirestore(uygulama, ayarlar)

Sağlanan ayarlarla yeni bir Cloud Firestore örneğini başlatır. Yalnızca diğer tüm işlevlerden önce çağrılabilir (getFirestore() dahil). Özel ayarlar boşsa bu işlev, getFirestore() çağrısına eşdeğerdir.

İmza:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması	`Firestore` örneğinin ilişkilendirileceği FirebaseApp.
ayarlar	Ayarlar	`Firestore` örneğini yapılandırmak için kullanılan ayarlar nesnesi.

Şunu döndürür:

Yeni başlatılmış Firestore örneği.

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.

İmza:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması	`Firestore` örneğinin ilişkilendirileceği FirebaseApp.
ayarlar	Ayarlar	`Firestore` örneğini yapılandırmak için kullanılan ayarlar nesnesi.
veritabanı kimliği	dize	Veritabanının adı.

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

Yeni başlatılmış Firestore örneği.

fonksiyon(firestore, ...)

koleksiyon(firestore, yol, pathSegments)

Belirtilen mutlak yoldaki koleksiyonu ifade eden bir CollectionReference örneği alır.

İmza:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tür	Açıklama
firestore	Firestore	Kök `Firestore` örneğine referans.
yol	dize	Bir koleksiyonun eğik çizgiyle ayrılmış yolu.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

koleksiyonGrubu(firestore, collectionsId)

Veritabanında bulunan ve belirtilen collectionId değerine sahip bir koleksiyonda veya alt koleksiyonda yer alan tüm dokümanları 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	Tür	Açıklama
firestore	Firestore	Kök `Firestore` örneğine referans.
koleksiyon kimliği	dize	Sorgulanacak koleksiyonları tanımlar. Yolun son segmenti olarak bu kimliğe sahip olan her koleksiyon veya alt koleksiyon dahil edilir. Eğik çizgi içeremez.

Şunu döndürür:

Sorgu<DocumentData, DocumentData>

Oluşturulan: Query.

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.

İmza:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parametreler

Parametre	Tür	Açıklama
firestore	Firestore	Emülatöre bağlanmak için yapılandırılacak `Firestore` örneği.
düzenleyen	dize	emülatör ana makinesi (ör: localhost).
bağlantı noktası	sayı	emülatör bağlantı noktası (ör: 9000).
seçenekler	{ mockUserToken?: EmulatorMockTokenOptions \| string; }

Şunu döndürür:

geçersiz

doc(firestore, path; pathSegments)

Belirtilen mutlak yoldaki belgeye işaret eden bir DocumentReference örneği alır.

İmza:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tür	Açıklama
firestore	Firestore	Kök `Firestore` örneğine referans.
yol	dize	Dokümanın eğik çizgiyle ayrılmış yolu.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

DocumentReference<DocumentData, DocumentData>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

runTransaction(firestore, updateFunction, seçenekler)

Belirtilen updateFunction işlemini yürütür ve ardından işlemde uygulanan değişiklikleri uygulamaya çalışır. İşlem kapsamında okunan herhangi bir belge değiştiyse Cloud Firestore, updateFunction yöntemini yeniden dener. 5 denemeden sonra başarısız olursa 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	Tür	Açıklama
firestore	Firestore	Bu işlemin çalıştırılacağı Firestore veritabanına referans.
güncelleme işlevi	(işlem: İşlem) => Söz<T>	İşlem bağlamında yürütülecek işlev.
seçenekler	İşlem Seçenekleri	Maksimum kaydetme deneme sayısını yapılandıran bir seçenekler nesnesi.

Şunu döndürür:

Söz<T>

İşlem başarıyla tamamlanırsa veya açıkça iptal edilirse (updateFunction, başarısız bir söz verdiyse) updateFunction tarafından verilen taahhüt buraya döndürülür. Aksi takdirde, işlem başarısız olursa reddedilmiş bir taahhüt ve karşılık gelen hata hatası döndürülü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. Diğer herhangi bir işlev FirestoreError gönderir. Fesih işlemi, beklemedeki yazma işlemlerini iptal etmez ve sunucudan yanıt bekleyen taahhütler çözümlenmez.

Sonlandırmadan 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	Tür	Açıklama
firestore	Firestore	Sonlandırılacak `Firestore` örneği.

Şunu döndürür:

Taahhüt<void>

Örnek başarıyla sonlandırıldığında çözülen bir Promise.

WriteBatch(firestore)

Tek bir atomik işlem olarak birden fazla yazma işlemi gerçekleştirmek için kullanılan bir yazma grubu oluşturur. Tek bir WriteBatch için izin verilen maksimum yazma sayısı 500'dür.

Bu yazma işlemlerinin sonucu, yalnızca döndürülen taahhüt tamamlandıktan sonra gerçekleşen belge okumalarına yansıtılır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci internete bağlanana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz Firestore SDK'sının tamamını kullanın.

İmza:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Parametreler

Parametre	Tür	Açıklama
firestore	Firestore

Şunu döndürür:

WriteBatch

Birden fazla yazma işlemini atomik olarak yürütmek için kullanılabilecek bir WriteBatch.

fonksiyon()

count()

Sorgunun sonuç kümesindeki belge sayısını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

export declare function count(): AggregateField<number>;

Şunu döndürür:

AggregateField<sayı>

deleteField()

Bir alanı silinmek üzere işaretlemek için updateDoc() veya setDoc() ile kullanılacak {merge: true} ile birlikte kullanılacak bir sentinel döndürür.

İmza:

export declare function deleteField(): FieldValue;

Şunu döndürür:

dokümanKimliği()

Bir dokümanın kimliğine başvuruda bulunmak için özel bir koruyucu FieldPath döndürür. Sorgularda doküman kimliğine göre sıralama veya filtreleme yapmak için kullanılabilir.

İmza:

export declare function documentId(): FieldPath;

Şunu döndürür:

FieldPath

getFirestore()

Varsayılan FirebaseApp ile ilişkili mevcut varsayılan Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

export declare function getFirestore(): Firestore;

Şunu döndürür:

Sağlanan uygulamanın Firestore örneği.

sunucuZaman Damgası()

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;

Şunu döndürür:

function(veritabanıId; ...)

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 FirebaseApp ile ilişkilendirilmiş mevcut Firestore örneğini döndürür. Herhangi bir örnek yoksa varsayılan ayarlarla yeni bir örnek başlatır.

İmza:

export declare function getFirestore(databaseId: string): Firestore;

Parametreler

Parametre	Tür	Açıklama
veritabanı kimliği	dize	Veritabanının adı.

Şunu döndürür:

Sağlanan uygulamanın Firestore örneği.

function(öğeler; ...)

stringRemove(öğeler)

setDoc() ile kullanılabilecek veya sunucuya, belirtilen öğeleri sunucuda zaten bulunan herhangi bir dizi değerinden kaldırmasını bildiren özel değeri döndürür. Belirtilen her bir öğenin tüm örnekleri diziden kaldırılır. Değiştirilen alan halihazırda bir dizi değilse boş bir diziyle bu alanın üzerine yazılır.

İmza:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Parametreler

Parametre	Tür	Açıklama
öğeler	bilinmiyor[]	Diziden kaldırılacak öğeler.

Şunu döndürür:

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu

diziUnion(öğeler)

setDoc() veya updateDoc() ile kullanılabilecek özel değeri döndürür. Bu değer, sunucuya belirtilen öğeleri sunucuda zaten mevcut olan herhangi bir dizi değeriyle birleştirmesini bildirir. Dizide mevcut olmayan belirtilen her bir öğe sona eklenir. Değiştirilen alan halihazırda bir dizi değilse, tam olarak belirtilen öğeleri içeren bir dizi bu alanın üzerine yazılır.

İmza:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Parametreler

Parametre	Tür	Açıklama
öğeler	bilinmiyor[]	Dizide birleştirilecek öğeler.

Şunu döndürür:

QueryFieldFilterConstraint

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu.

fonksiyon(alan; ...)

ortalama(alan)

Sorgunun sonuç grubundaki bir dizi belge üzerinde belirtilen bir alanın ortalamasını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Parametreler

Parametre	Tür	Açıklama
alan	dize \| FieldPath	Sonuç kümesi genelinde ortalaması alınacak alanı belirtir.

Şunu döndürür:

AggregateField<sayı | null>

sum(alan)

Sorgunun sonuç kümesindeki bir dizi belge üzerinde belirtilen bir alanın toplamını hesaplamak için kullanılabilecek bir AggregateField nesnesi oluşturun.

İmza:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Parametreler

Parametre	Tür	Açıklama
alan	dize \| FieldPath	Sonuç kümesinde toplanacak alanı belirtir.

Şunu döndürür:

AggregateField<sayı>

function(fieldPath; ...)

orderBy(fieldPath;DirectionStr)

Sorgu sonucunu belirtilen alana göre ve isteğe bağlı olarak artan yerine azalan düzende sıralayan bir QueryOrdersByConstraint oluşturur.

İmza:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Parametreler

Parametre	Tür	Açıklama
FieldPath	dize \| FieldPath	Sıralama ölçütü olarak kullanılacak alan.
yönStr	OrderByDirection	Sıralama ölçütü olarak kullanılacak isteğe bağlı yön ("artan" veya "azalan"). Belirtilmezse sıra artan düzende olacaktır.

Şunu döndürür:

QueryOrderByConstraint

Oluşturulan Query OrderByConstraint.

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 zorunlu kılan bir QueryFieldFilterConstraint oluşturur.

İmza:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Parametreler

Parametre	Tür	Açıklama
FieldPath	dize \| FieldPath	Karşılaştırma yolu
opStr	WhereFilterOp	İşlem dizesi (ör. "<", "<=", "==", "<", "<=", "!=").
value	bilinmiyor	Karşılaştırma değeri

Şunu döndürür:

Oluşturulan QueryFieldFilterConstraint.

function(fieldValues; ...)

endAt(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlarda sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametreler

Parametre	Tür	Açıklama
alanDeğerleri	bilinmiyor[]	Sorgunun sıralama ölçütüne göre, bu sorgunun sona ereceği alan değerleri.

Şunu döndürür:

query() öğesine iletilecek bir QueryEndAtConstraint

endBefore(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan önce sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametreler

Parametre	Tür	Açıklama
alanDeğerleri	bilinmiyor[]	Sorgunun sıralama ölçütüne göre, bu sorguyu daha önce sonlandıracak alan değerleri.

Şunu döndürür:

query() öğesine iletilecek bir QueryEndAtConstraint

startAfter(fieldValues)

Sonuç kümesini, sorgunun sırasına göre sağlanan alanlardan sonra başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametreler

Parametre	Tür	Açıklama
alanDeğerleri	bilinmiyor[]	Sorgunun sıralama ölçütüne göre, sonra bu sorgunun başlatılacağı alan değerleri.

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek QueryStartAtConstraint öğesi

startAt(fieldValues)

Sonuç kümesini sorgunun sırasına göre sağlanan alanlarda başlayacak şekilde değiştiren bir QueryStartAtConstraint oluşturur. Alan değerlerinin sırası, sorgudaki ifadelere göre sıralamayla aynı olmalıdır.

İmza:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametreler

Parametre	Tür	Açıklama
alanDeğerleri	bilinmiyor[]	Sorgunun sıralama ölçütüne göre, bu sorgunun başlatılacağı alan değerleri.

Şunu döndürür:

QueryStartAtConstraint (Sorgu Başlatma Kısıtlaması)

query() öğesine iletilecek bir QueryStartAtConstraint.

işlev(sol; ...)

totalFieldEqual(sol; sağ)

Eşitlik için iki "AggregateField" örneğini karşılaştırır.

İmza:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Parametreler

Parametre	Tür	Açıklama
sol	AggregateField<unknown>	Bu AggregateField ile `right` karşılaştırmasını yapın.
sağ	AggregateField<unknown>	Bu AggregateField ile `left` karşılaştırmasını yapın.

Şunu döndürür:

boolean

totalQuerySnapshotEqual(sol, sağ)

Eşitlik için iki AggregateQuerySnapshot örneğini karşılaştırır.

İki AggregateQuerySnapshot örneği "eşit" olarak kabul edilir ve aynı verileri karşılaştıran temel sorguları olup olmadığını gösterir.

İ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	Tür	Açıklama
sol	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	Karşılaştırılacak ilk `AggregateQuerySnapshot`.
sağ	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	Karşılaştırılacak ikinci `AggregateQuerySnapshot`.

Şunu döndürür:

boolean

Nesneler yukarıda tanımlandığı gibi "eşit"se true, aksi takdirde false.

queryEqual(sol; sağ)

Sağlanan sorgular aynı koleksiyonu işaret ederse ve aynı kısıtlamaları uygularsa true değerini döndürür.

İmza:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Parametreler

Parametre	Tür	Açıklama
sol	Sorgu<AppModelType, DbModelType>	Karşılaştırmak için `Query`.
sağ	Sorgu<AppModelType, DbModelType>	Karşılaştırmak için `Query`.

Şunu döndürür:

boolean

Referanslar aynı Firestore veritabanında aynı konumu işaret ediyorsa true

refEqual(sol; sağ)

Sağlanan referanslar eşitse true değerini 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	Tür	Açıklama
sol	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Karşılaştırılacak bir referans.
sağ	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Karşılaştırılacak bir referans.

Şunu döndürür:

boolean

Referanslar aynı Firestore veritabanında aynı konumu işaret ediyorsa true

SnapshotEqual(sol, sağ)

Sağlanan anlık görüntüler eşitse true değerini 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	Tür	Açıklama
sol	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	Karşılaştırılacak bir anlık görüntü.
sağ	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	Karşılaştırılacak bir anlık görüntü.

Şunu döndürür:

boolean

anlık görüntüler eşitse true.

function(sınır; ...)

limit(limit)

Yalnızca ilk eşleşen dokümanları döndüren bir QueryLimitConstraint oluşturur.

İmza:

export declare function limit(limit: number): QueryLimitConstraint;

Parametreler

Parametre	Tür	Açıklama
sınır	sayı	Döndürülecek maksimum öğe sayısı.

Şunu döndürür:

QueryLimitConstraint

Oluşturulan QueryLimitConstraint.

limitToLast(sınır)

Yalnızca son eşleşen dokümanları döndüren bir QueryLimitConstraint oluşturur.

limitToLast sorguları için en az bir orderBy ifadesi belirtmeniz gerekir, aksi takdirde yürütme sırasında bir istisna oluşur.

İmza:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Parametreler

Parametre	Tür	Açıklama
sınır	sayı	Döndürülecek maksimum öğe sayısı.

Şunu döndürür:

QueryLimitConstraint

Oluşturulan QueryLimitConstraint.

function(logLevel; ...)

setLogLevel(logLevel)

Cloud Firestore günlüklerinin ayrıntısını ayarlar (hata ayıklama, hata veya sessiz).

İmza:

export declare function setLogLevel(logLevel: LogLevel): void;

Parametreler

Parametre	Tür	Açıklama
logLevel	LogLevel	Etkinlik ve hata günlüğü için ayarladığınız ayrıntı düzeyi. Aşağıdaki değerlerden herhangi biri olabilir: Temel olarak hata ayıklama amacıyla, en ayrıntılı günlük kaydı düzeyi için `debug`. Yalnızca hataları günlüğe kaydetmek için `error`. `silent to turn off logging.`

Şunu döndürür:

geçersiz

işlev(n; ...)

artış(n)

setDoc() veya updateDoc() ile kullanılabilecek özel değeri döndürür. Bu değer, sunucuya alanın geçerli değerini verilen değere göre artırmasını bildirir.

İşlenen veya geçerli alan değeri kayan nokta kesinliğini kullanıyorsa tüm aritmetikler IEEE 754 anlamını izler. Her iki değer de tam sayıysa JavaScript'in güvenli sayı aralığının (Number.MIN_SAFE_INTEGER - Number.MAX_SAFE_INTEGER) dışındaki değerler de kesinlik kaybına tabi olur. Ayrıca, Firestore arka ucu tarafından işlendikten sonra tüm tam sayı işlemleri -2^63 ile 2^63-1 arasında sınırlandırılır.

Geçerli alan değeri number türünde değilse veya alan henüz mevcut değilse dönüşüm işlemi, alanı verilen değere ayarlar.

İmza:

export declare function increment(n: number): FieldValue;

Parametreler

Parametre	Tür	Açıklama
n	sayı	Artımlılık değeri.

Şunu döndürür:

QueryCompositeFilterConstraint

setDoc() veya updateDoc() numaralı telefona yapılan bir çağrıda kullanılacak FieldValue koruyucu

function(sorgu; ...)

getAggregate(query, aggregateSpec)

Belgeleri indirmeden, belirtilen sorgunun sonuç kümesindeki dokümanlar üzerinden belirtilen toplamaları hesaplar.

Dokümanların değil yalnızca nihai toplama değerleri geçerli olduğundan, toplama işlemleri için bu işlevin kullanılması verimlidir. indirilerek oluşturulur. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda (binlerce doküman) belgeleri toplama işlemini 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	Tür	Açıklama
query	Sorgu<AppModelType, DbModelType>	Sonuç kümesi toplanan sorgu.
toplamÖzellikleri	AggregateSpecType	Sonuç kümesinde gerçekleştirilecek toplamaları belirten `AggregateSpec` nesnesi. AggregateSpec, toplu sonucu almak üzere kullanılabilecek her bir toplama işlemi için takma adlar belirtir.

Şunu döndürür:

Promise<AggregateQuerySnapshot<AggregateSpecType, 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)

Belirli bir sorgunun sonuç kümesindeki dokümanların sayısını, dokümanları indirmeden hesaplar.

Dokümanları saymak için bu işlevi kullanmak verimlidir çünkü dokümanların sayımında değil, indirilerek yüklenir. Bu işlev, sonuç kümesinin tamamen indirilemeyecek kadar büyük olduğu durumlarda dokümanları da sayabilir (binlerce doküman).

İmza:

export declare function getCount<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Parametreler

Parametre	Tür	Açıklama
query	Sorgu<AppModelType, DbModelType>	Sonuç kümesi boyutu hesaplanan sorgu.

Şunu döndürür:

Promise<AggregateQuerySnapshot<{ count: AggregateField<number>; }, AppModelType, DbModelType>>

Sayıyla birlikte sonuçlanacak bir Taahhüt; Sayı, snapshot.data().count konumundan alınabilir. Burada snapshot, döndürülen Vaat'in çözdüğü AggregateQuerySnapshot değeridir.

getDokümanlar(sorgu)

Sorguyu yürütür ve sonuçları bir QuerySnapshot olarak döndürür.

Tüm sorgular, daha önce yürütülmüş olsa bile doğrudan sunucu tarafından yürütülür. Son değişiklikler, yalnızca arka uç tarafından önceden uygulanmışsa alınan sonuçlara yansıtılır. İstemci çevrimdışıysa işlem başarısız olur. Önceden önbelleğe alınmış sonucu ve yerel değişiklikleri görmek için Firestore SDK'sının tamamını kullanın.

İmza:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre	Tür	Açıklama
query	Sorgu<AppModelType, DbModelType>	Yürütülecek `Query`.

Şunu döndürür:

Promise<QuerySnapshot<AppModelType, DbModelType>>

Sorgunun sonuçlarıyla sonuçlanacak bir Vaat.

sorgu(sorgu; bileşen Filtresi; queryConstraints)

Ek sorgu kısıtlamaları içerecek şekilde genişletilen yeni bir sabit Query örneğini oluşturur.

İmza:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Parametreler

Parametre	Tür	Açıklama
query	Sorgu<AppModelType, DbModelType>	Yeni kısıtlamalar için temel olarak kullanılacak Query örneği.
birleşik Filtre	QueryCompositeFilterConstraint	Uygulanacak QueryCompositeFilterConstraint değeri. and() veya or() kullanarak QueryCompositeFilterConstraint oluşturun.
sorguKısıtlamaları	QueryNonFilterConstraint[]	Uygulanacak ek QueryNonFilterConstraint öğeleri (ör. orderBy(), limit()).

Şunu döndürür:

Sorgu<AppModelType, DbModelType>

İstisnalar

değerini girin.

sorgu(sorgu; queryConstraints)

Ek sorgu kısıtlamaları içerecek şekilde genişletilen yeni bir sabit Query örneğini oluşturur.

İmza:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Parametreler

Parametre	Tür	Açıklama
query	Sorgu<AppModelType, DbModelType>	Yeni kısıtlamalar için temel olarak kullanılacak Query örneği.
sorguKısıtlamaları	SorguKısıtlaması[]	Uygulanacak QueryConstraint listesi.

Şunu döndürür:

Sorgu<AppModelType, DbModelType>

İstisnalar

değerini girin.

function(queryConstraints, ...)

and(queryConstraints)

Belirtilen filtre kısıtlamalarının bir birleşimi olan yeni bir QueryCompositeFilterConstraint oluşturur. Bağlaç filtreleri, belirtilen tüm filtreleri karşılıyorsa dokümanı içerir.

İmza:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametreler

Parametre	Tür	Açıklama
sorguKısıtlamaları	QueryFilterConstraint[]	İsteğe bağlı. Bağlama işlemi uygulanacak QueryFilterConstraint listesi. Bunlar, where(), or() veya and() çağrılarıyla oluşturulmalıdır.

Şunu döndürür:

Yeni oluşturulan QueryCompositeFilterConstraint.

veya(queryConstraints)

Belirtilen filtre kısıtlamalarının ayırması olan yeni bir QueryCompositeFilterConstraint oluşturur. Ayırma filtreleri, belirtilen filtrelerden herhangi birine uyan dokümanı içerir.

İmza:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametreler

Parametre	Tür	Açıklama
sorguKısıtlamaları	QueryFilterConstraint[]	İsteğe bağlı. Ayırma işlemi gerçekleştirilecek QueryFilterConstraint listesi. Bunlar, where(), or() veya and() çağrılarıyla oluşturulmalıdır.

Şunu döndürür:

QueryCompositeFilterConstraint

Yeni oluşturulan QueryCompositeFilterConstraint.

fonksiyon(başvuru; ...)

addDoc(başvuru; veriler)

Belirtilen CollectionReference için belirtilen verilerle yeni bir doküman ekleyin ve bu dokümana otomatik olarak doküman kimliği atayın.

Bu yazma işleminin sonucu, yalnızca döndürülen taahhüt tamamlandıktan sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci internete bağlanana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz Firestore SDK'sının tamamı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	Tür	Açıklama
referans	CollectionReference<AppModelType, DbModelType>	Bu dokümanın ekleneceği koleksiyon için referans.
veri	WithFieldValue<AppModelType>	Yeni dokümana ait verileri içeren bir Nesne.

Şunu döndürür:

Promise<DocumentReference<AppModelType, DbModelType>>

Arka uca yazıldıktan sonra yeni oluşturulan dokümanı işaret eden DocumentReference ile çözümlenen Promise.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

koleksiyon(referans, yol, yolSegmentleri)

Belirtilen göreli yoldaki bir reference alt koleksiyonuna referans veren CollectionReference örneğini alır.

İmza:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tür	Açıklama
referans	CollectionReference<AppModelType, DbModelType>	Bir koleksiyona referans.
yol	dize	Bir koleksiyonun eğik çizgiyle ayrılmış yolu.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

koleksiyon(referans, yol, yolSegmentleri)

Belirtilen göreli yoldaki bir reference alt koleksiyonuna referans veren CollectionReference örneğini alır.

İmza:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Bir Firestore belgesine referans.
yol	dize	Bir koleksiyonun eğik çizgiyle ayrılmış yolu.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

CollectionReference<DocumentData, DocumentData>

CollectionReference örneği.

İstisnalar

Son yolda çift sayıda segment varsa ve bir koleksiyona işaret etmiyorsa.

deleteDoc(başvuru)

Belirtilen DocumentReference tarafından atıfta bulunulan dokümanı siler.

Silme işlemi yalnızca döndürülen taahhüt çözüme ulaştırıldıktan sonra gerçekleştirilen belge okumalarına yansıtılır. İstemci çevrimdışıysa silme işlemi başarısız olur. İstemci internete bağlanana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz Firestore SDK'sının tamamını kullanın.

İmza:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Silinecek dokümana referans.

Şunu döndürür:

Taahhüt<void>

Doküman arka uçtan başarıyla silindikten sonra Promise sorunu çözüldü.

doc(başvuru; yol; yolSegmentleri)

Belirtilen göreli yolda reference içindeki bir dokümana referans veren DocumentReference örneğini alır. Herhangi bir yol belirtilmezse döndürülen DocumentReference için otomatik olarak oluşturulmuş benzersiz bir kimlik kullanılır.

İmza:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Parametreler

Parametre	Tür	Açıklama
referans	CollectionReference<AppModelType, DbModelType>	Bir koleksiyona referans.
yol	dize	Dokümanın eğik çizgiyle ayrılmış yolu. Otomatik oluşturulan kimlikleri kullanmak için atlanması gerekir.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

DocumentReference<AppModelType, DbModelType>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

doc(başvuru; yol; yolSegmentleri)

Belirtilen göreli yolda reference içindeki bir dokümana referans veren DocumentReference örneğini alır.

İmza:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Bir Firestore belgesine referans.
yol	dize	Dokümanın eğik çizgiyle ayrılmış yolu.
yolSegmentleri	dize[]	İlk bağımsız değişkene göre uygulanacak ek yol segmentleri.

Şunu döndürür:

DocumentReference<DocumentData, DocumentData>

DocumentReference örneği.

İstisnalar

Son yolda tek sayıda segment varsa ve bir dokümana işaret etmiyorsa.

getDoc(başvuru)

Belirtilen belge referansının atıfta bulunduğu dokümanı okur.

Doküman daha önce okunmuş veya değiştirilmiş olsa bile tüm dokümanlar doğrudan sunucudan getirilir. Son değişiklikler, yalnızca arka uç tarafından önceden uygulanmışsa alınan DocumentSnapshot öğesine yansıtılır. İstemci çevrimdışıysa okuma işlemi başarısız olur. Önbelleğe almayı kullanmak veya yerel değişiklikleri görmek istiyorsanız lütfen Firestore SDK'sının tamamını kullanın.

İmza:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Getirilecek dokümanın referansı.

Şunu döndürür:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

Bir söz, mevcut doküman içeriğini içeren bir DocumentSnapshot ile çözümlendi.

setDoc(başvuru; veri)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur.

İmza:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Yazılacak belge için bir referans.
veri	WithFieldValue<AppModelType>	Dokümandaki alanların ve değerlerin haritası.

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

setDoc(başvuru; veriler; seçenekler)

Belirtilen DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur. merge veya mergeFields sağlarsanız, sağlanan veriler mevcut bir belgede birleştirilebilir.

İmza:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Yazılacak belge için bir referans.
veri	partWithFieldValue<AppModelType>	Dokümandaki alanların ve değerlerin haritası.
seçenekler	SetOptions	Belirlenen davranışı yapılandıracak bir nesne.

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

updateDoc(başvuru; veri)

Dokümanda, belirtilen DocumentReference tarafından belirtilen alanları günceller. Mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur.

Bu güncellemenin sonucu yalnızca döndürülen taahhüt tamamlandıktan sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa güncelleme başarısız olur. İstemci internete bağlanana kadar yerel değişiklikleri veya arabellek yazmalarını görmek isterseniz Firestore SDK'sının tamamını kullanın.

İmza:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Güncellenecek dokümana referans.
veri	UpdateData<DbModelType>	Dokümanın güncelleneceği alanları ve değerleri içeren bir nesne. Alanlar, doküman içindeki iç içe yerleştirilmiş alanlara referans vermek için noktalar içerebilir.

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli Firestore verileri değilse.

updateDoc(başvuru; alan; değer; moreFieldsAndValues)

Belirtilen DocumentReference tarafından atıfta bulunulan dokümandaki güncelleme alanları , mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur.

İç içe geçmiş alanlar, noktayla ayrılmış alan yolu dizeleri veya FieldPath nesneleri sağlanarak güncellenebilir.

İmza:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
referans	DocumentReference<AppModelType, DbModelType>	Güncellenecek dokümana referans.
alan	dize \| FieldPath	Güncellenecek ilk alan.
value	bilinmiyor	İlk değer.
diğerAlanlarVeDeğerler	bilinmiyor[]	Ek anahtar/değer çiftleri.

Şunu döndürür:

Taahhüt<void>

Veriler arka uca başarıyla yazıldıktan sonra Promise sorunu çözüldü.

İstisnalar

Hata - Sağlanan giriş geçerli Firestore verileri değilse.

Functions(anlık görüntü; ...)

endAt(anlık görüntü)

Sonuç grubunu, sağlanan belgede (dahil) sona erecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu, sorgunun sırasına göre değişir. Belge, sorgunun OrderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametreler

Parametre	Tür	Açıklama
anlık görüntü	DocumentSnapshot<AppModelType, DbModelType>	Dokümanın bitecek anlık görüntüsü.

Şunu döndürür:

query() öğesine iletilecek bir QueryEndAtConstraint

endBefore(anlık görüntü)

Sonuç grubunu, sağlanan dokümandan (hariç) önce bitecek şekilde değiştiren bir QueryEndAtConstraint oluşturur. Bitiş konumu, sorgunun sırasına göre değişir. Belge, sorgunun OrderBy bölümünde sağlanan tüm alanları içermelidir.

İmza:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametreler

Parametre	Tür	Açıklama
anlık görüntü	DocumentSnapshot<AppModelType, DbModelType>	Öncesinde bitecek olan dokümanın anlık görüntüsü.

Şunu döndürür: