Package google.firestore.v1

map<string, Value>

Toplama işlevlerinin sonucu, ör. COUNT(*) AS total_docs.

Anahtar, girişte toplama işlevine atanan alias değeridir ve bu haritanın boyutu, sorgudaki toplama işlevlerinin sayısına eşittir.

Value

Dizideki değerler.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

string

Alınacak dokümanların adları. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}. Belgelerden herhangi biri, belirtilen database öğesinin alt kaynağı değilse istek başarısız olur. Yinelenen adlar çıkarılır.

DocumentMask

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Bir dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

bytes

Bir işlemdeki belgeleri okur.

TransactionOptions

Yeni bir işlem başlatır ve dokümanları okur. Varsayılan olarak işlem salt okunurdur. Yeni işlem kimliği, akışta ilk yanıt olarak döndürülür.

Timestamp

Dokümanları verilen zaman olduğu gibi okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

bytes

Bu isteğin bir parçası olarak başlatılan işlem. Yalnızca ilk yanıtta ve istekte BatchGetDocumentsRequest.new_transaction ayarlanmışsa ayarlanır.

Timestamp

Belgenin okunduğu saat. Bu artış tek bir şekilde artabilir. Bu durumda, sonuç akışındaki önceki dokümanların, read_time ile bu zaman arasında değişmemesi garanti edilir.

Document

İstenen bir belge.

string

İstenen ancak mevcut olmayan bir belge adı. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

Write

Uygulanacak yazmalar.

Yöntem, yazma işlemlerini atomik olarak uygulamaz ve sıralamayı garanti etmez. Her yazma işlemi bağımsız olarak başarılı veya başarısız olur. Aynı dokümana istek başına birden fazla kez yazamazsınız.

map<string, string>

Bu toplu yazma işlemiyle ilişkili etiketler.

WriteResult

Yazmalar uygulandığında elde edilen sonuç.

Bu yazma sonucu, istekteki son yazma işlemine karşılık gelir.

Status

Yazmaların uygulanma durumu.

Bu yazma durumu, istekteki son yazma işlemine karşılık gelir.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

TransactionOptions

İşlemle ilgili seçenekler. Varsayılan olarak okuma-yazma işlemi kullanılır.

bytes

Başlatılan işlem.

bytes

Bit dizisini kodlayan baytlardır. Uzunluğu sıfır olabilir.

int32

bitmap içindeki son baytın "dolgu" olarak yoksayılacak bit sayısı. bitmap uzunluğu sıfırsa bu değer 0 olmalıdır. Aksi takdirde, bu değer 0 ile 7 (ikisi de dahil) arasında olmalıdır.

BitSequence

Çiçek filtresi verileri.

int32

Algoritma tarafından kullanılan karmaların sayısı.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

Write

Uygulanacak yazmalar.

Her zaman anatomik olarak ve sırayla yürütülür.

bytes

Ayarlanırsa bu işlemdeki tüm yazma işlemlerini uygular ve kaydeder.

WriteResult

Yazmalar uygulandığında elde edilen sonuç.

Bu yazma sonucu, istekteki son yazma işlemine karşılık gelir.

Timestamp

Kaydetmenin gerçekleştiği saat. Eşit veya daha yüksek read_time değerine sahip tüm okumalar, kaydetmenin etkilerini görür.

string

Zorunlu. Üst kaynak. Örneğin, projects/{project_id}/databases/{database_id}/documents veya projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Zorunlu. parent ile göreli olarak listelenecek koleksiyon kimliği. Örneğin: chatrooms.

string

Bu doküman için kullanılacak, istemci tarafından atanan doküman kimliği.

İsteğe bağlı. Belirtilmezse, hizmet tarafından bir kimlik atanır.

Document

Zorunlu. Oluşturulacak doküman. name ayarlanmamalıdır.

DocumentMask

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

Value

Bir konumu ifade eden, sorgunun her bir yan tümcesine göre sıralanmış olarak görünen değerler.

Yan cümleye göre sıralamada belirtilenden daha az değer içerebilir.

bool

Konum, sorgu tarafından tanımlanan sıralama düzenine göre verilen değerlerden hemen önce veya hemen sonraysa.

string

Zorunlu. Silinecek Dokümanın kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Dokümandaki isteğe bağlı bir ön koşul. Bu değer ayarlanırsa ve hedef doküman tarafından karşılanmazsa istek başarısız olur.

string

Belgenin kaynak adı. Örneğin, projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Yalnızca çıkış. Dokümanın oluşturulduğu saat.

Bir doküman silinip yeniden oluşturulduğunda bu değer tekdüze şekilde artar. Ayrıca, diğer dokümanlardaki değerlerle ve bir sorgunun read_time ile karşılaştırılabilir.

Timestamp

Yalnızca çıkış. Dokümanın en son değiştirildiği saat.

Bu değer başlangıçta create_time olarak ayarlanır, daha sonra dokümanda yapılan her değişiklikle tekdüze şekilde artar. Ayrıca, diğer dokümanlardaki değerlerle ve bir sorgunun read_time ile karşılaştırılabilir.

Document

Document öğesinin yeni durumu.

mask ayarlanırsa yalnızca güncellenen veya eklenen alanları içerir.

int32

Bu dokümanla eşleşen hedeflerin hedef kimlikleri grubu.

int32

Artık bu dokümanla eşleşmeyen hedeflerin bir hedef kimlikleri grubu.

string

Silinen Document kaynağının adı.

int32

Daha önce bu varlıkla eşleşen hedeflerin hedef kimlikleri grubu.

Timestamp

Silme işleminin gözlemlendiği okuma zaman damgası.

Silme işleminin commit_time değerinden büyük veya ona eşit.

string

Maskedeki alan yollarının listesi. Alan yolu söz dizimi referansı için Document.fields bölümüne bakın.

string

Görünümden kaldırılan Document kaynak adı.

int32

Bu dokümanla daha önce eşleşen hedeflerin hedef kimlikleri grubu.

Timestamp

Kaldırma işleminin gözlemlendiği okuma zaman damgası.

Değişiklik/silme/kaldırma işleminin commit_time değerinden büyük veya bu değere eşit.

string

Dönüştürülecek dokümanın adı.

FieldTransform

Sırayla dokümanın alanlarına uygulanacak dönüşümlerin listesi. Bu alan boş bırakılamaz.

string

Alanın yolu. Alan yolu söz dizimi referansı için Document.fields bölümüne bakın.

ServerValue

Alanı verilen sunucu değerine ayarlar.

Value

Verilen değeri alanın mevcut değerine ekler.

Bu bir tam sayı veya çift değer olmalıdır. Alan bir tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüşüm işlemi, alanı verilen değere ayarlar. Verilen değerden veya mevcut alan değerinden biri çiftse her iki değer de çift sayı olarak yorumlanır. IEEE 754 semantiği, çift aritmetik ve çift değerlerin gösterimi için geçerlidir. Pozitif/negatif tam sayı taşması varsa alan, en büyük pozitif/negatif tam sayıya çözümlenir.

Value

Alanı, mevcut değerinin ve verilen değerin maksimum değerine ayarlar.

Bu bir tam sayı veya çift değer olmalıdır. Alan bir tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüşüm işlemi, alanı verilen değere ayarlar. Alanın ve giriş değerinin karışık türde (yani, biri tam sayı, diğeri çift olduğunda) maksimum işlem uygulanırsa alan, daha büyük işlenenin türünü alır. İşlem görenler eşdeğerse (ör. 3 ve 3,0) alan değişmez. 0, 0,0 ve -0,0'ın tamamı sıfırdır. Sıfır depolanan değer ve sıfır giriş değerinin maksimum değeri her zaman kayıtlı değerdir. x ve NaN sayısal değerlerinin maksimum değeri NaN'dir.

Value

Alanı, mevcut değerinin ve verilen değerin en düşük değerine ayarlar.

Bu bir tam sayı veya çift değer olmalıdır. Alan bir tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüşüm işlemi, alanı giriş değerine ayarlar. Alanın ve giriş değerinin karışık türde (biri tam sayı, diğeri çift sayı) olduğu minimum işlem uygulanırsa alan, daha küçük işlenenin türünü alır. İşlem görenler eşdeğerse (ör. 3 ve 3,0) alan değişmez. 0, 0,0 ve -0,0'ın tamamı sıfırdır. Minimum değer sıfır ve sıfır giriş değeri her zaman kayıtlı değerdir. x ve NaN sayısal değerlerinin minimum değeri NaN'dir.

ArrayValue

Belirtilen alan değerinde zaten mevcut değillerse verilen öğeleri sırayla ekleyin. Alan bir dizi değilse veya alan henüz mevcut değilse öncelikle boş dizi olarak ayarlanır.

Bir değerin eksik olup olmadığı kontrol edilirken farklı türlerdeki eşdeğer sayılar (ör. 3L ve 3,0) eşit kabul edilir. NaN, NaN'ye, Null ise Null'a eşittir. Giriş birden çok eşdeğer değer içeriyorsa yalnızca ilki dikkate alınır.

Karşılık gelen conversion_result null değer olacaktır.

ArrayValue

Verilen öğelerin tümünü alandaki diziden kaldırın. Alan bir dizi değilse veya alan henüz mevcut değilse boş dizi olarak ayarlanır.

Bir öğenin kaldırılıp kaldırılmayacağına karar verilirken farklı türlerin eşdeğer sayıları (ör. 3L ve 3,0) eşit olarak kabul edilir. NaN, NaN'ye, Null ise Null'a eşittir. Yinelenen öğeler varsa bu işlem tüm eşdeğer değerleri kaldırır.

Karşılık gelen conversion_result null değer olacaktır.

int64

Dokümanlar, projeksiyonlar, toplama sonuçları ve anahtarlar dahil olmak üzere döndürülen toplam sonuç sayısı.

Duration

Sorguyu arka uçta yürütmek için geçen toplam süre.

int64

Toplam faturalandırılabilir okuma işlemi sayısı.

Struct

Sorgunun yürütülmesinden itibaren istatistiklerde hata ayıklama. Hata ayıklama istatistiklerinin Firestore geliştikçe değişebileceğini unutmayın. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

Bu filtrenin uygulanacağı hedef kimlik.

int32

target_id ile eşleşen dokümanların toplam sayısı.

İstemcideki, eşleşen dokümanların sayısından farklıysa istemci hangi belgelerin artık hedefle eşleşmediğini manuel olarak belirlemelidir.

İstemci unchanged_names çiçek filtresini bu tespite yardımcı olmak için TÜM doküman adlarını filtreyle karşılaştırarak test edebilir. Doküman adı filtrede DEĞİLSE bu, dokümanın artık hedefle eşleşmediği anlamına gelir.

BloomFilter

Adına rağmen, target_id ile eşleşen TÜM dokümanların kaynak adlarının UTF-8 bayt kodlamalarını projects/{project_id}/databases/{database_id}/documents/{document_path} biçiminde içeren bir çiçek açma filtresi.

Bu çiçek filtresi, sunucunun tercihine bağlı olarak, örneğin istemcinin bunu kullanmayacağına karar verilirse veya hesaplama açısından hesaplanmak ya da iletmek için fazla pahalıysa atlanabilir. İstemciler, bu alan mevcut olmadan önce kullanılan mantığa dönerek bu alanın eksik olduğunu sorunsuz şekilde ele almalıdır. Bir başka deyişle, istemcinin önbelleğindeki hangi dokümanların senkronize olmadığını anlamak için hedefi, devam ettirme jetonu olmadan yeniden eklemelidir.

PlanSummary

Sorgunun planlama aşaması bilgileri.

ExecutionStats

Sorgunun yürütülmesinden elde edilen toplu istatistikler. Yalnızca ExplainOptions.analyze doğru değerine ayarlandığında mevcut olur.

bool

İsteğe bağlı. Bu sorgunun yürütülüp yürütülmeyeceği.

Yanlış olduğunda (varsayılan) sorgu planlanır ve yalnızca planlama aşamalarındaki metrikler döndürülür.

Doğru olduğunda sorgu planlanır ve yürütülür, hem planlama hem de yürütme aşaması metrikleriyle birlikte tam sorgu sonuçları döndürülür.

string

Zorunlu. Alınacak Dokümanın kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

bytes

Bir işlemde dokümanı okur.

Timestamp

Belgenin belirtilen zamandaki sürümünü okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

string

Zorunlu. Üst doküman. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}. Örneğin: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Döndürülecek maksimum sonuç sayısı.

string

Sayfa jetonu. ListCollectionIdsResponse arasında bir değer olmalıdır.

Timestamp

Dokümanları verilen zaman olduğu gibi okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

string

Koleksiyon kimlikleri.

string

Listeye devam etmek için kullanılabilecek bir sayfa jetonu.

string

Zorunlu. Üst kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents veya projects/{project_id}/databases/{database_id}/documents/{document_path}.

Örneğin, projects/my-project/databases/my-database/documents veya projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

İsteğe bağlı. parent ile göreli olarak listelenecek koleksiyon kimliği.

Örneğin, chatrooms veya messages.

Bu isteğe bağlıdır. Bu belirtilmediğinde Firestore, tüm koleksiyonlardaki belgeleri sağlanan parent altında listeler.

int32

İsteğe bağlı. Tek bir yanıtta döndürülecek maksimum doküman sayısı.

Firestore bu değerden daha düşük sonuç döndürebilir.

string

İsteğe bağlı. Önceki bir ListDocuments yanıtından alınan sayfa jetonu.

Sonraki sayfayı almak için bu kodu sağlayın. Sayfalara ayırırken, diğer tüm parametreler (page_size hariç), sayfa jetonunu oluşturan istekte ayarlanan değerlerle eşleşmelidir.

string

İsteğe bağlı. İade edilecek belgelerin isteğe bağlı sıralaması.

Örneğin: priority desc, __name__ desc.

Bu, Firestore sorgularında kullanılan ancak dize gösteriminde kullanılan ORDER BY öğesini yansıtır. Yoksa belgeler __name__ ASC tarihine göre sıralanır.

DocumentMask

İsteğe bağlı. Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Bir dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

bool

Listede eksik dokümanların gösterilip gösterilmeyeceği.

Bir doküman yoksa ancak altında iç içe yerleştirilmiş alt dokümanlar varsa eksiktir. Doğru değerine ayarlandığında bu tür eksik dokümanlar bir anahtarla döndürülür ancak create_time veya update_time alanları ayarlanmaz.

show_missing içeren isteklerde where veya order_by belirtilemez.

bytes

Okumayı etkin bir işlemin parçası olarak gerçekleştirin.

Timestamp

Okumayı belirtilen zamanda gerçekleştirin.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

Document

Dokümanlar bulundu.

string

Dokümanların sonraki sayfasını almak için kullanılan jeton.

Bu alan atlanırsa sonraki sayfa yoktur.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

map<string, string>

Bu hedef değişikliğiyle ilişkili etiketler.

Target

Bu akışa eklenecek bir hedef.

int32

Bu akıştan kaldırılacak hedefin kimliği.

TargetChange

Hedefler değişti.

DocumentChange

Bir Document değişti.

DocumentDelete

Bir Document silindi.

DocumentRemove

Bir Document, bir hedeften kaldırıldı (artık söz konusu hedefle alakalı olmadığından).

ExistenceFilter

Belirli bir hedef için daha önce döndürülen doküman grubuna uygulanacak bir filtre.

Dokümanlar belirtilen hedeften kaldırılmış olabileceğinden ancak dokümanlar tam olarak bilinmiyorsa döndürülür.

map<string, Value>

Haritadaki alanlar.

Eşleme anahtarları alan adlarını temsil eder. __.*__ normal ifadesiyle eşleşen alan adları ayrılmıştır. Ayrılmış alan adlarına, belgelenmiş belirli bağlamlar haricinde izin verilmez. UTF-8 olarak gösterilen eşleme anahtarları 1.500 baytı aşmamalıdır ve boş olamaz.

string

Zorunlu. Üst kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents. Doküman kaynağı adları desteklenmez; yalnızca veritabanı kaynağı adları belirtilebilir.

int64

İstenen maksimum bölüm noktası sayısı. Bölümler, birden çok sonuç sayfasında döndürülebilir. Sayı pozitif olmalıdır. Döndürülen bölümlerin gerçek sayısı daha az olabilir.

Örneğin, bu, çalıştırılacak paralel sorgu sayısından veya bir veri ardışık düzeni işi yürütürken, kullanılabilir çalışan ya da bilgi işlem örneği sayısından bir daha az olacak şekilde ayarlanabilir.

string

Ek sonuç grubu almak için kullanılabilecek olan önceki bir PartitionQuery çağrısından döndürülen next_page_token değeri. Sonuç grupları arasında sıralama garantisi verilmez. Bu nedenle, birden fazla sonuç kümesi kullanmak, farklı sonuç kümelerini birleştirmek gerektirir.

Örneğin, page_token kullanılarak art arda yapılan iki çağrı şu sonucu döndürebilir:

• imleç B, imleç M, imleç Q
• imleç A, imleç U, imleç W

BölümSorgusu'na sağlanan sorgunun sonuçlarına göre sıralanmış tam bir sonuç kümesi elde etmek için, sonuç kümeleri birleştirilmelidir: imleç A, imleç B, imleç M, imleç Q, imleç U, imleç W

int32

Bu çağrıda döndürülecek maksimum bölüm sayısı (partition_count şartlarına tabidir.)

Örneğin, partition_count = 10 ve page_size = 8 ise PartitionQuery'ye yapılan ilk çağrı, 8 bölümlendirme ve daha fazla sonuç varsa bir next_page_token döndürür. PartitionQuery'ye yapılan ikinci bir çağrı, partition_count politikasında belirtilen toplam 10 bölümlendirmeyi tamamlamak üzere en fazla 2 bölümlendirme döndürür.

StructuredQuery

Yapılandırılmış bir sorgudur. Sorgu, tüm alt öğeleri içeren koleksiyonu belirtmeli ve artan ada göre sıralanmalıdır. Diğer filtreler, sıralama ölçütleri, sınırlar, ofsetler ve başlangıç/bitiş imleçleri desteklenmez.

Timestamp

Dokümanları verilen zaman olduğu gibi okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

Cursor

Bölüm sonuçları. Her bölüm, RunQuery tarafından sorgu sonuçları için başlangıç veya bitiş noktası olarak kullanılabilen bir bölme noktasıdır. RunQuery istekleri, bu PartitionQuery isteğine sağlanan sorguyla yapılmalıdır. Bölüm imleçleri, PartitionQuery'ye sağlanan sorgunun sonuçlarıyla aynı sıralamaya göre sıralanır.

Örneğin, bir BölümtionQuery isteği A ve B bölüm imleçlerini döndürürse aşağıdaki üç sorgunun çalıştırılması orijinal sorgunun tüm sonuç kümesini döndürür:

• sorgu, A bitişinde
• sorgu, A'nın başında, B bitişinde
• sorgu, B başlangıcında

Boş sonuç, sorguda bölümlendirmek için çok az sonuç olduğunu veya sorgunun bölümlendirme için henüz desteklenmediğini gösterebilir.

string

PartitionQuery isteğinde partition_count tarafından belirtilen sayıya kadar, ek bir sonuç grubu istemek için kullanılabilecek bir sayfa jetonu. Boş bırakılırsa başka sonuç yok.

Struct

Sorgu için seçilen dizinler. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

true olarak ayarlandığında hedef dokümanın mevcut olması gerekir. false olarak ayarlandığında hedef doküman mevcut olmamalıdır.

Timestamp

Ayarlandığında hedef dokümanın mevcut olması ve o tarihte en son güncellenmiş olması gerekir. Zaman damgası, mikrosaniye hizalı olmalıdır.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}.

bytes

Zorunlu. Geri alınacak işlem.

string

Zorunlu. Üst kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents veya projects/{project_id}/databases/{database_id}/documents/{document_path}. Örneğin: projects/my-project/databases/my-database/documents veya projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

İsteğe bağlı. Sorguyla ilgili seçenekleri açıklayın. Ayarlanırsa ek sorgu istatistikleri döndürülür. Aksi takdirde, yalnızca sorgu sonuçları döndürülür.

StructuredAggregationQuery

Toplama sorgusu.

bytes

Toplamayı zaten etkin olan bir işlem içinde çalıştırın.

Buradaki değer, sorgunun yürütüleceği opak işlem kimliğidir.

TransactionOptions

Sorgu kapsamında yeni bir işlem başlatır ve varsayılan olarak salt okunurdur.

Yeni işlem kimliği, akışta ilk yanıt olarak döndürülür.

Timestamp

Sorguyu belirtilen zaman damgasında yürütür.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

AggregationResult

Tek bir toplama sonucu.

Kısmi ilerleme bildirilirken mevcut değildir.

bytes

Bu isteğin bir parçası olarak başlatılan işlem.

Yalnızca istek yeni bir işlem başlatma isteğinde bulunduğunda ilk yanıtta mevcut olur.

Timestamp

Toplam sonucun hesaplandığı zaman. Bu değer her zaman tekdüze artmaktadır. Bu durumda, sonuç akışındaki önceki AggregationResult öğesinin read_time ve bu değer arasında değişmemesi garanti edilir.

Sorgu hiçbir sonuç döndürmezse read_time içeren ve result içermeyen bir yanıt gönderilir ve bu, sorgunun çalıştırıldığı zamanı temsil eder.

ExplainMetrics

Sorgu açıklama metrikleri. Bu yalnızca RunAggregationQueryRequest.explain_options sağlandığında mevcuttur ve akıştaki son yanıtla birlikte yalnızca bir kez gönderilir.

string

Zorunlu. Üst kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents veya projects/{project_id}/databases/{database_id}/documents/{document_path}. Örneğin: projects/my-project/databases/my-database/documents veya projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

İsteğe bağlı. Sorguyla ilgili seçenekleri açıklayın. Ayarlanırsa ek sorgu istatistikleri döndürülür. Aksi takdirde, yalnızca sorgu sonuçları döndürülür.

StructuredQuery

Yapılandırılmış bir sorgudur.

bytes

Sorguyu etkin bir işlem içinde çalıştırın.

Buradaki değer, sorgunun yürütüleceği opak işlem kimliğidir.

TransactionOptions

Yeni bir işlem başlatır ve dokümanları okur. Varsayılan olarak işlem salt okunurdur. Yeni işlem kimliği, akışta ilk yanıt olarak döndürülür.

Timestamp

Dokümanları verilen zaman olduğu gibi okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

bytes

Bu isteğin bir parçası olarak başlatılan işlem. Yalnızca ilk yanıtta ve yalnızca istekte RunQueryRequest.new_transaction ayarlanmışsa ayarlanabilir. Ayarlanırsa bu yanıtta başka alan ayarlanmaz.

Document

Kısmi ilerleme bildirilirken ayarlanmayan bir sorgu sonucu.

Timestamp

Belgenin okunduğu saat. Bu artış tekdüze olabilir. Bu durumda, sonuç akışındaki önceki dokümanların read_time ve bu doküman arasında değişmemesi garanti edilir.

Sorgu hiçbir sonuç döndürmezse read_time içeren ve document içermeyen bir yanıt gönderilir ve bu, sorgunun çalıştırıldığı zamanı temsil eder.

int32

Son yanıt ile geçerli yanıt arasındaki ofset nedeniyle atlanan sonuç sayısı.

ExplainMetrics

Sorgu açıklama metrikleri. Bu yalnızca RunQueryRequest.explain_options sağlandığında mevcuttur ve akıştaki son yanıtla birlikte yalnızca bir kez gönderilir.

bool

Mevcutsa, Firestore isteği tamamen tamamlamıştır ve başka doküman döndürülmeyecektir.

Aggregation

İsteğe bağlı. structured_query sonuçları üzerine uygulanacak toplama dizisi.

Gereken:

• Sorgu başına en az bir, en fazla beş toplama.

StructuredQuery

İç içe yerleştirilmiş yapılandırılmış sorgu.

string

İsteğe bağlı. Toplama sonucunun depolanacağı alanın isteğe bağlı adı.

Belirtilmezse Firestore field_<incremental_id++> biçimini izleyen varsayılan bir ad seçer. Örneğin:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

şu hale gelir:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Gereken:

• Tüm toplama takma adlarında benzersiz olmalıdır.
• document field name sınırlamalarına uyun.

Count

Sayı toplayıcı.

Sum

Toplam toplayıcı.

Avg

Ortalama toplayıcı.

FieldReference

Toplama yapılacak alan.

Int64Value

İsteğe bağlı. Sayılacak maksimum doküman sayısıyla ilgili isteğe bağlı sınırlama.

Bu, taranacak doküman sayısı için bir üst sınır ayarlama yolu sağlar, gecikmeyi ve maliyeti sınırlar.

Belirtilmemiş ifadesi, sınır yok olarak yorumlanır.

Üst Düzey Örnek:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Gereken:

• Mevcut olduğunda sıfırdan büyük olmalıdır.

FieldReference

Toplama yapılacak alan.

Projection

Döndürülecek alanların isteğe bağlı alt kümesi.

Bu anahtar, sorgudan döndürülen belgeler üzerinde DocumentMask görevi görür. Ayarlanmadığında, arayanın tüm alanların döndürülmesini istediğini varsayar.

CollectionSelector

Sorgulanacak koleksiyonlar.

Filter

Uygulanacak filtre.

Order

Sorgu sonuçlarına uygulanacak sıra.

Firestore, arayanların tam sıralama veya kısmi sıralama yapmalarına ya da hiç sipariş vermemelerine olanak tanır. Firestore her durumda aşağıdaki kurallarla tutarlı bir sıralamayı garanti eder:

• order_by, bir eşitsizlik filtresiyle kullanılan tüm alanlara referans vermek için gereklidir.
• order_by içinde olması gereken ancak halihazırda mevcut olmayan tüm alanlar, alan adının sözlükçe sıralamasına eklenir.
• __name__ üzerindeki bir sipariş belirtilmezse varsayılan olarak eklenir.

Alanlar, belirtilen son düzenle aynı sıralama yönüyle veya herhangi bir sıra belirtilmediyse "ASCENDING" (ASCENDING) ile eklenir. Örneğin:

• ORDER BY a, ORDER BY a ASC, __name__ ASC olur
• ORDER BY a DESC, ORDER BY a DESC, __name__ DESC olur
• WHERE a > 1, WHERE a > 1 ORDER BY a ASC, __name__ ASC olur
• WHERE __name__ > ... AND a > 1, WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC olur

Cursor

Sorgunun başlatılacağı sonuç kümesindeki bir konumun olası ön eki.

Sonuç kümesinin sıralaması, orijinal sorgunun ORDER BY yan tümcesine bağlıdır.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

Bu sorgunun sonuçları (b ASC, __name__ ASC) etiketine göre sıralanmıştır.

İmleçler konumun tam sırasına veya ön ekine başvurabilir ancak sağlanan ORDER BY alanında bulunandan daha fazla alana başvuramaz.

Yukarıdaki örnekten devam edersek, aşağıdaki başlangıç imleçlerini eklemenin çeşitli etkileri olacaktır:

• START BEFORE (2, /k/123): Sorguyu a = 1 AND b > 2 AND __name__ > /k/123 öncesinde başlatın.
• START AFTER (10): Sorguyu a = 1 AND b > 10 ifadesinden hemen sonra başlatın.

Atlamak için ilk N sonucun taranmasını gerektiren OFFSET'den farklı olarak, başlatma imleci, sorgunun mantıksal bir konumda başlamasını sağlar. Bu konum, gerçek bir sonuçla eşleşmesi gerekmez. Bir sonraki dokümanı bulmak için bu konumdan ileriye doğru tarar.

Gereken:

• Değer sayısı, ORDER BY yan tümcesinde belirtilen alan sayısından büyük olamaz.

Cursor

Sonuç kümesindeki bir konumun, sorguyu sonlandıracak potansiyel ön eki.

Bu, START_AT özelliğine benzer ancak başlangıç konumunu değil bitiş konumunu kontrol eder.

Gereken:

• Değer sayısı, ORDER BY yan tümcesinde belirtilen alan sayısından büyük olamaz.

int32

İlk sonuç döndürülmeden önce atlanacak doküman sayısı.

Bu durum WHERE, START AT ve END AT tarafından belirtilen kısıtlamalardan sonra, ancak LIMIT yan tümcesinden önce geçerlidir.

Gereken:

• Değer belirtilmişse sıfırdan büyük veya sıfıra eşit olmalıdır.

Int32Value

Döndürülecek maksimum sonuç sayısı.

Diğer tüm kısıtlamalardan sonra uygulanır.

Gereken:

• Değer belirtilmişse sıfırdan büyük veya sıfıra eşit olmalıdır.

FindNearest

İsteğe bağlı. Olası en yakın komşu araması.

Diğer tüm filtre ve sıralamalardan sonra uygulanır.

Verilen sorgu vektörüne en yakın vektör gömmelerini bulur.

string

Koleksiyon kimliği. Ayarlandığında, yalnızca bu kimliğe sahip koleksiyonları seçer.

bool

Yanlış olduğunda, yalnızca RunQueryRequest öğesini içeren parent öğesinin hemen alt öğeleri olan koleksiyonları seçer. Doğru değerine ayarlandığında tüm alt koleksiyonları seçer.

Operator

Birden çok filtreyi birleştirme operatörü.

Filter

Birleştirilecek filtrelerin listesi.

Gereken:

• En az bir filtre mevcut.

FieldReference

Filtreleme ölçütü olarak kullanılacak alan.

Operator

Filtrelemede kullanılacak operatör.

Value

Karşılaştırılacak değer.

string

Dokümandaki bir alana başvuru.

Gereken:

• Her segmentin document field name sınırlamaya uygun olduğu, noktayla ayrılmış (.) bir segment dizesi olması ZORUNLUDUR.

CompositeFilter

Bileşik bir filtre.

FieldFilter

Doküman alanında bir filtre.

UnaryFilter

Tam olarak bir bağımsız değişken alan bir filtre.

FieldReference

Zorunlu. Arama yapılacak dizine eklenmiş bir vektör alanı. Yalnızca, boyutları query_Vektör ile eşleşen vektörler içeren belgeler döndürülebilir.

Value

Zorunlu. Arama yaptığımız sorgu vektörü. 2048'den fazla boyutta olmayan bir vektör olmalıdır.

DistanceMeasure

Zorunlu. Kullanılacak mesafe ölçüsü, gereklidir.

Int32Value

Zorunlu. Döndürülecek en yakın komşuların sayısı. 1.000'den fazla olmayan pozitif bir tam sayı olmalıdır.

FieldReference

Sıralama ölçütü olarak kullanılacak alan.

Direction

Sıralama ölçütü. Varsayılan olarak ASCENDING değerine ayarlanır.

FieldReference

Döndürülecek alanlar.

Boş bırakılırsa tüm alanlar döndürülür. Yalnızca dokümanın adını döndürmek için ['__name__'] değerini kullanın.

Operator

Uygulanacak tekli operatör.

FieldReference

Operatörün uygulanacağı alan.

int32

Akıştaki hedefi tanımlayan hedef kimlik. Pozitif bir sayı olmalı ve sıfır olmamalıdır.

target_id 0 ise (veya belirtilmediyse) sunucu bu hedef için bir kimlik atar ve bir TargetChange::ADD etkinliğinde bunu döndürür. target_id=0 içeren bir hedef eklendikten sonra, sonraki tüm hedeflerin target_id=0 değeri de olmalıdır. target_id=0 içeren bir hedef eklendikten sonra sunucuya target_id != 0 içeren bir AddTarget isteği gönderilirse sunucu hemen TargetChange::Remove etkinliğiyle bir yanıt gönderir.

İstemci, kimlik olmadan birden fazla AddTarget isteği gönderirse TargetChage.target_ids içinde döndürülen kimliklerin sırasının tanımlanmadığını unutmayın. Bu nedenle, istemciler, atama yapması için sunucuya güvenmek yerine, bir hedef kimlik sağlamalıdır.

target_id sıfır değilse bu akışta aynı kimliğe sahip etkin bir hedef bulunmamalıdır.

bool

Güncel ve tutarlı olduktan sonra hedefin kaldırılması gerekip gerekmediği.

Int32Value

Sürdürme jetonunda veya okuma zamanında sorguyla en son eşleşen dokümanların sayısı.

Bu değer yalnızca resume_type sağlandığında geçerlidir. Bu değerin mevcut olması ve sıfırdan büyük olması, istemcinin ExistenceFilter.unchanged_names değerinin yanıta dahil edilmesini istediği anlamına gelir.

QueryTarget

Sorgu tarafından belirtilen hedef.

DocumentsTarget

Bir dizi doküman adıyla belirtilen hedef.

bytes

Aynı hedef için önceki TargetChange öğesinden bir devam ettirme jetonu.

Farklı bir hedefle devam ettirme jetonunun kullanılması desteklenmez ve başarısız olabilir.

Timestamp

Belirli bir read_time sonra dinlemeye başlayın.

Müşterinin şu anda eşleşen belgelerin durumunu bilmesi gerekir.

string

Alınacak dokümanların adları. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}. Belgelerden herhangi biri, belirtilen database öğesinin alt kaynağı değilse istek başarısız olur. Yinelenen adlar çıkarılır.

string

Üst kaynak adı. Biçimi: projects/{project_id}/databases/{database_id}/documents veya projects/{project_id}/databases/{database_id}/documents/{document_path}. Örneğin: projects/my-project/databases/my-database/documents veya projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Yapılandırılmış bir sorgudur.

TargetChangeType

Gerçekleşen değişikliğin türü.

int32

Değişen hedeflerin hedef kimlikleri.

Boş bırakılırsa değişiklik tüm hedeflere uygulanır.

Hedef kimliklerin sırası tanımlanmamış.

Status

Bu değişikliğe neden olan hata (varsa).

bytes

Belirtilen target_ids için akışı devam ettirmek amacıyla kullanılabilecek bir jeton veya target_ids boşsa tüm hedefler.

Her hedef değişikliğinde ayarlanmadı.

Timestamp

Belirtilen target_ids için tutarlı read_time (target_id'ler tutarlı bir anlık görüntüde olmadığında atlanır).

Akışın tamamı yeni ve tutarlı bir anlık görüntüye ulaştığında akışın target_ids boş olan bir read_time göndermesi garanti edilir. ADD, CURRENT ve RESET iletilerinin yeni ve tutarlı bir anlık görüntü sağlaması garanti edilir (ancak NO_CHANGE ve REMOVE iletileri için geçerli değildir).

Belirli bir akış için read_time değerinin tekdüze artacağı garanti edilir.

ReadOnly

İşlem yalnızca okuma işlemleri için kullanılabilir.

ReadWrite

İşlem, hem okuma hem de yazma işlemleri için kullanılabilir.

Timestamp

Verilen zamandaki dokümanları okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

bytes

Yeniden denemek için isteğe bağlı bir işlem.

Document

Zorunlu. Güncellenen doküman. Henüz mevcut değilse dokümanı oluşturur.

DocumentMask

Güncellenecek alanlar. Maskedeki alan yollarının hiçbiri ayrılmış bir ad içeremez.

Doküman sunucuda bulunuyorsa ve maskede başvurulmayan alanlar içeriyorsa bunlar değiştirilmeden bırakılır. Maskede başvurulan ancak giriş dokümanında bulunmayan alanlar, sunucudaki dokümandan silinir.

DocumentMask

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

Precondition

Dokümandaki isteğe bağlı bir ön koşul. Bu değer ayarlanırsa ve hedef doküman tarafından karşılanmazsa istek başarısız olur.

NullValue

Boş değer.

bool

Boole değeridir.

int64

Tam sayı değeridir.

double

Çift değer.

Timestamp

Zaman damgası değeri.

Yalnızca mikrosaniye aralığında kesindir. Depolandığında tüm ek hassasiyetler aşağı yuvarlanır.

string

Dize değeridir.

UTF-8 olarak temsil edilen dize, 1 MiB - 89 baytı aşmamalıdır. Sorgular,UTF-8 temsilinin yalnızca ilk 1.500 baytını dikkate alır.

bytes

Bayt değeri.

1 MiB - 89 bayttan büyük olmamalıdır. Sorgular yalnızca ilk 1.500 baytı dikkate alır.

string

Bir dokümana referans. Örneğin: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Dünya yüzeyindeki bir noktayı temsil eden coğrafi nokta değeri.

ArrayValue

Dizi değeri.

Doğrudan başka bir dizi değeri içeremez, ancak başka bir dizi içeren eşleme içerebilir.

MapValue

Harita değeri.

DocumentMask

Bu yazma sırasında güncellenecek alanlar.

Bu alan yalnızca işlem update olduğunda ayarlanabilir. Maske bir update için ayarlanmadıysa ve doküman varsa mevcut verilerin üzerine yazılır. Maske ayarlanırsa ve sunucudaki dokümanda, maskenin kapsamına girmeyen alanlar varsa bunlar değiştirilmez. Maskede başvurulan ancak giriş dokümanında bulunmayan alanlar, sunucudaki dokümandan silinir. Bu maskedeki alan yolları, ayrılmış bir alan adı içermemelidir.

FieldTransform

Güncellemeden sonra gerçekleştirilecek dönüşümler.

Bu alan yalnızca işlem update olduğunda ayarlanabilir. Mevcut olduğunda bu yazma işlemi, aynı belgeye atomik olarak ve sırayla update ve transform uygulayabilme işlemine eşdeğerdir.

Precondition

Dokümandaki isteğe bağlı bir ön koşul.

Bu ayar yapılırsa ancak hedef doküman tarafından karşılanmazsa yazma işlemi başarısız olur.

Document

Yazılacak bir doküman.

string

Silinecek doküman adı. Biçimi: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Bir dokümana dönüşüm uygular.

string

Zorunlu. Veritabanı adı. Biçimi: projects/{project_id}/databases/{database_id}. Bunu yalnızca ilk mesajda belirtmeniz gerekir.

string

Devam ettirilecek yazma akışının kimliği. Bu seçenek yalnızca ilk mesajda ayarlanabilir. Boş bırakıldığında yeni bir yazma akışı oluşturulur.

Write

Uygulanacak yazmalar.

Her zaman anatomik olarak ve sırayla yürütülür. İlk istekte boş olmalıdır. Bu, son istekte boş olabilir. Diğer tüm isteklerde bu alan boş olmamalıdır.

bytes

Daha önce sunucu tarafından gönderilen bir akış jetonu.

İstemci bu alanı, aldığı en son WriteResponse jetonuna ayarlamalıdır. Bu onay, istemcinin bu jetona kadar yanıtlar aldığını onaylar. Bu jeton gönderildikten sonra, eski jetonlar artık kullanılamaz.

Çok fazla onaylanmamış yanıt varsa sunucu akışı kapatabilir.

Yeni bir yayın oluştururken bu alanı ayarlamadan bırakın. Bir akışı belirli bir noktada devam ettirmek için bu alanı ve stream_id alanını ayarlayın.

Yeni bir yayın oluştururken bu alanı ayarlamadan bırakın.

map<string, string>

Bu yazma isteğiyle ilişkili etiketler.

string

Akışın kimliği. Yalnızca ilk mesajda, yeni bir akış oluşturulduğunda ayarlanır.

bytes

Bu yanıtın akıştaki konumunu temsil eden jeton. Bu noktada, istemci akışı bu noktada devam ettirmek için kullanılabilir.

Bu alan her zaman ayarlanır.

WriteResult

Yazmalar uygulandığında elde edilen sonuç.

Bu yazma sonucu, istekteki son yazma işlemine karşılık gelir.

Timestamp

Kaydetmenin gerçekleştiği saat. Eşit veya daha büyük read_time değerine sahip tüm okumalarda, yazmanın etkileri kesin olarak görülür.

Timestamp

Yazma işlemi uygulandıktan sonra dokümanın son güncellenme zamanı. delete sonrasında ayarlanmadı.

Yazma işlemi dokümanı gerçekten değiştirmediyse bu önceki update_time işlemi olur.

Value

Her bir DocumentTransform.FieldTransform aynı sırada uygulandığında elde edilen sonuçlar.