Package google.firestore.v1beta1

map<string, Value>

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

Anahtar, girişteki toplama işlevine atanan alias öğesidir. Bu haritanın boyutu, sorgudaki toplama işlevlerinin sayısına eşittir.

Value

Dizideki değerler.

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}.

string

Alınacak dokümanların adları. Belirtilen biçimde: 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ümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

bytes

Bir işlemdeki belgeleri okur.

TransactionOptions

Yeni bir işlem başlatır ve belgeleri okur. Varsayılan olarak salt okunur işlem kullanılır. Yeni işlem kimliği, akıştaki ilk yanıt olarak döndürülür.

Timestamp

Belgeleri belirtilen zamanda olduğu gibi okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

bytes

Bu istek kapsamında başlatılan işlem. Yalnızca ilk yanıtta ve istekte BatchGetDocumentsRequest.new_transaction ayarlanmışsa ayarlanır.

Timestamp

Belgenin okunma zamanı. Bu değer tekdüze şekilde artıyor olabilir. Bu durumda, sonuç akışında yer alan önceki dokümanların Read_time ve bu doküman arasında değişmediği garanti edilir.

Document

İstenen bir belge.

string

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

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}.

Write

Uygulanacak yazma işlemleri.

Yöntem yazma işlemleri atomik olarak uygulanmaz 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 çok kez yazamazsınız.

map<string, string>

Bu toplu yazma işlemiyle ilişkilendirilen etiketler.

WriteResult

Yazma işlemlerinin uygulanmasının sonucu.

Bu i-'inci yazma sonucu, istekteki i'inci yazmaya karşılık gelir.

Status

Yazma işlemlerinin uygulanma durumu.

Bu i-'inci yazma durumu, istekteki i. yazma durumuna karşılık gelir.

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: 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 baytlar. Uzunluğu sıfır olabilir.

int32

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

BitSequence

Çiçek filtresi verileri.

int32

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

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}.

Write

Uygulanacak yazma işlemleri.

Her zaman atomik ve sıralı bir şekilde yürütülür.

bytes

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

WriteResult

Yazma işlemlerinin uygulanmasının sonucu.

Bu i-'inci yazma sonucu, istekteki i'inci yazmaya karşılık gelir.

Timestamp

Kaydetmenin gerçekleştiği zaman. read_time değerine eşit veya daha yüksek olan tüm okumalar, kaydetmenin etkilerini görecektir.

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. Listelenecek parent ile ilişkili koleksiyon kimliği. Örnek: chatrooms.

string

Bu doküman için kullanılacak, müşteri tarafından atanmış 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ümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

Value

Bir sorgunun ifade gücüne göre sıralanmış sırayla bir konumu temsil eden değerler.

İfadeye 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ı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Dokümandaki isteğe bağlı bir ön koşul. Bu ayar yapılırsa ve hedef belge tarafından karşılanmazsa istek başarısız olur.

string

Dokümanın kaynak adı (ör. 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 sorgunun read_time metriğiyle karşılaştırılabilir.

Timestamp

Yalnızca çıkış. Belgenin son değiştirildiği saat.

Bu değer başlangıçta create_time olarak ayarlanır ve ardından dokümanda yapılan her değişiklikle birlikte tekdüze olarak artar. Ayrıca, diğer dokümanlardaki değerlerle ve sorgunun read_time metriğiyle karşılaştırılabilir.

Document

Document cihazının yeni durumu.

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

int32

Bu belgeyle eşleşen hedeflerin hedef kimlikleri grubu.

int32

Artık bu dokümanla eşleşmeyen hedeflere yönelik bir hedef kimlik grubu.

string

Silinen Document öğesinin kaynak adı.

int32

Bu varlıkla daha önce eşleşen hedeflere ait 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 sayfasına bakın.

string

Görünümden çıkan Document öğesinin kaynak adı.

int32

Bu dokümanla daha önce eşleşen hedefler için bir hedef kimlik 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 ona eşit.

string

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

FieldTransform

Dokümanın alanlarına sırayla 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 sayfasına 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 tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüştürme işlemi, alanı verilen değere ayarlar. Verilen değerden veya geçerli alan değerinden biri çift olursa her iki değer de çiftler olarak yorumlanır. Çift aritmetik ve çift değerlerin gösterimi IEEE 754 anlamında geçerlidir. Pozitif/negatif tam sayı taşması varsa alan, en büyük büyüklükteki pozitif/negatif tam sayıya çözümlenir.

Value

Alanı, geçerli değerinin ve verilen değerin maksimum değerine ayarlar.

Bu, bir tam sayı veya çift değer olmalıdır. Alan tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüştürme işlemi, alanı verilen değere ayarlar. Alan ve giriş değerinin karma türde olduğu (yani biri tam sayı, diğeri çift sayı olduğu) bir 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 değerlerinin tamamı sıfırdır. Sıfır depolanan değerin ve sıfır giriş değerinin maksimum değeri her zaman depolanan değerdir. x ve NaN sayısal değerlerinin maksimum değeri NaN'dir.

Value

Alanı, geçerli değerinin ve verilen değerin minimum değerine ayarlar.

Bu, bir tam sayı veya çift değer olmalıdır. Alan tam sayı veya çift değilse ya da alan henüz mevcut değilse dönüştürme işlemi, alanı giriş değerine ayarlar. Alan ve giriş değeri karışık türde (yani bir tam sayı, diğeri çift sayı) 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 değerlerinin tamamı sıfırdır. Sıfır depolanan değer ve sıfır giriş değerinin minimum değeri her zaman depolanan değerdir. x ve NaN sayısal değerlerinin minimum değeri NaN'dir.

ArrayValue

Geçerli alan değerinde zaten mevcut değillerse belirtilen öğeleri sırayla ekleyin. Alan bir dizi değilse veya alan henüz mevcut değilse önce boş diziye ayarlanır.

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

Karşılık gelen transform_result, boş değer olur.

ArrayValue

Alandaki diziden belirtilen öğelerin tümünü kaldırın. Alan bir dizi değilse veya alan henüz mevcut değilse boş diziye 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 kabul edilir. NaN, NaN'ye eşittir. Boş değer ise Null'a eşittir. Bu işlem, yinelenen öğeler varsa tüm eşdeğer değerleri kaldırır.

Karşılık gelen transform_result, boş değer olur.

int64

Belgeler, 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 toplam süre.

int64

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

Struct

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

int32

Bu filtrenin geçerli olduğu hedef kimliği.

int32

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

Müşterideki eşleşen dokümanların sayısından farklıysa müşteri, hedefle eşleşen dokümanları manuel olarak belirlemelidir.

Müşteri, TÜM belge adlarını filtreye göre test ederek bu tespite yardımcı olması için unchanged_names çiçeklik filtresini kullanabilir; belge adı filtrede YOKSA, 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 filtresi.

Bu çiçeklenme filtresi, sunucunun şahsi karar verme yetkisiyle (örneğin, istemcinin kullanmayacağına kanaat getirilirse veya hesaplanması ya da iletilmesinin çok pahalıya mal olacağı durumlarda) atlanabilir. Müşteriler, bu alanın mevcut olmamasından önce kullanılan mantığa dönerek bu alanın eksikliğini titizlikle ele almalıdır; diğer bir deyişle, istemcinin önbelleğindeki hangi dokümanların senkronize olmadığını anlamak için hedefi devam ettirme jetonu olmadan yeniden ekleyin.

PlanSummary

Sorgu için planlama aşaması bilgileri.

ExecutionStats

Sorgunun yürütülmesine dair toplu istatistikler. Yalnızca ExplainOptions.analyze doğru olarak ayarlandığında mevcut olur.

bool

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

Politika, yanlış değerine ayarlandığında (varsayılan) sorgu planlanır ve yalnızca planlama aşamalarındaki metrikleri döndürür.

Doğru olduğunda sorgu planlanır ve yürütülür, böylece 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ı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

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

Dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

bytes

Bir işlemde belgeyi okur.

Timestamp

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

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

string

Zorunlu. Üst doküman. Belirtilen biçimde: projects/{project_id}/databases/{database_id}/documents/{document_path}. Örnek: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

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

string

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

Timestamp

Belgeleri belirtilen zamanda olduğu gibi okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam 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ı. Şu biçimde: 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ı. Listelenecek parent ile ilişkili koleksiyon kimliği.

Örneğin: chatrooms veya messages.

Bu isteğe bağlıdır ve sağlanmadığında Firestore, sağlanan parent altındaki tüm koleksiyonlardaki dokümanları listeler.

int32

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

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

string

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

Sonraki sayfayı almak için bunu sağlayın. Sayfalara ayırma işlemi sırasında 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ı.

Örnek: priority desc, __name__ desc.

Bu, Firestore sorgularında kullanılan ancak dize biçiminde olan ORDER BY öğesini yansıtır. Eksik olduğunda dokümanlar __name__ ASC temel alınarak sıralanır.

DocumentMask

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

Bir dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

bool

Listede eksik dokümanların gösterilip gösterilmediğ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 belgeler 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

Okuma işlemini, zaten etkin olan bir işlemin parçası olarak gerçekleştirin.

Timestamp

Okumayı belirtilen zamanda gerçekleştir.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

Document

Bulunan dokümanlar.

string

Dokümanların sonraki sayfasını alma jetonu.

Bu alan atlanırsa sonraki sayfa olmaz.

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}.

map<string, string>

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

Target

Bu akışa eklenecek bir hedef.

int32

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

TargetChange

Hedefler değişti.

DocumentChange

Document değişti.

DocumentDelete

Document silindi.

DocumentRemove

Bir Document, hedeften kaldırıldı (artık o hedefle alakalı olmadığı için).

ExistenceFilter

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

Belgelerin belirtilen hedeften kaldırılmış olmasına rağmen belgelerin tam olarak bilinmediği durumlarda döndürülür.

map<string, Value>

Haritanın alanları.

Eşleme anahtarları alan adlarını temsil eder. __.*__ normal ifadesiyle eşleşen alan adları ayrılmıştır. Ayrılmış alan adları, belirli belgelenen bağlamlar dışında kullanılamaz. UTF-8 olarak temsil edilen harita anahtarları 1.500 baytı aşmamalı ve boş olamaz.

string

Zorunlu. Üst kaynak adı. Belirtilen biçimde: 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 gerçek bölüm 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 çalıştırırken mevcut çalışan ya da işlem örneği sayısından bir daha az olacak şekilde ayarlanabilir.

string

Ek bir sonuç grubu almak için kullanılabilecek önceki bir PartitionQuery çağrısından döndürülen next_page_token değeri. Sonuç grupları arasında sıralama garantisi yoktur. Dolayısıyla, birden fazla sonuç kümesi kullanmak için farklı sonuç kümelerinin birleştirilmesi gerekir.

Örneğin, page_token değerini kullanan sonraki iki çağrı şu sonucu döndürebilir:

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

PartitionQuery'ye 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ç U, imleç W

int32

partition_count şartlarına tabi olarak, bu çağrıda döndürülecek maksimum bölüm sayısı.

Örneğin, partition_count = 10 ve page_size = 8 ise, PartitionQuery'ye yapılan ilk çağrı en fazla 8 bölüm ve daha fazla sonuç varsa bir next_page_token döndürür. PartitionQuery'ye yapılan ikinci bir çağrı, partition_count içinde belirtilen toplam 10 bölümün tamamlanması için en fazla 2 bölüm döndürür.

StructuredQuery

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

Timestamp

Belgeleri belirtilen zamanda olduğu gibi okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam 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 PartitionQuery 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, bitiş_A
• sorgu, başlangıç_A, bitiş_at B
• sorgu, başlangıç_B

Boş bir sonuç, sorguda bölümlendirilemeyecek kadar 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 grup sonuç istemek için kullanılabilecek bir sayfa jetonu. Boş bırakılırsa başka sonuç yoktur.

Struct

Sorgu için seçilen dizinler. Örneğin: [ {"query_scope": "Collection", "properties": "(foo ASC, ad ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, ad 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 düzeyinde olmalıdır.

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}.

bytes

Zorunlu. Geri alınacak işlem.

string

Zorunlu. Üst kaynak adı. Şu biçimde: 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

Toplama işlemini zaten etkin olan bir işlemde çalıştırın.

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

TransactionOptions

Sorgunun bir parçası olarak yeni bir işlem başlatır. Bu işlem varsayılan olarak salt okunur olur.

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

Timestamp

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

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

AggregationResult

Tek bir toplama sonucu.

Kısmi ilerleme bildirilirken mevcut değildir.

bytes

Bu istek kapsamında başlatılan işlem.

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

Timestamp

Toplu sonucun hesaplandığı zaman. Bu değişim sürekli monoton bir şekilde artmaktadır. Bu durumda, sonuç akışındaki önceki AggregationResult öğesinin, read_time ve bu sonuç arasında değişmediği garanti edilir.

Sorgu herhangi bir sonuç döndürmezse read_time değerini içeren ve result içermeyen bir yanıt gönderilmez. Bu, sorgunun çalıştırıldığı zamanı temsil eder.

ExplainMetrics

Sorgu, metrikleri açıklar. Bu mesaj 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ı. Şu biçimde: 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 sorgu.

bytes

Sorguyu zaten etkin olan bir işlemde ç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 belgeleri okur. Varsayılan olarak salt okunur işlem kullanılır. Yeni işlem kimliği, akıştaki ilk yanıt olarak döndürülür.

Timestamp

Belgeleri belirtilen zamanda olduğu gibi okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

bytes

Bu istek kapsamında 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 durumu raporlanırken ayarlanmayan bir sorgu sonucu.

Timestamp

Belgenin okunma zamanı. Bu artış monoton bir şekilde artıyor olabilir. Bu durumda, sonuç akışında yer alan önceki dokümanların read_time ve bu doküman arasında değişmediği garanti edilir.

Sorgu herhangi bir sonuç döndürmezse read_time değerini içeren ve document içermeyen bir yanıt gönderilmez. Bu, sorgunun çalıştırıldığı zamanı temsil eder.

int32

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

ExplainMetrics

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

bool

Bu kod varsa Firestore, isteği tamamen tamamlamıştır ve başka belge döndürülmeyecektir.

Aggregation

İsteğe bağlı. structured_query sonuçlarına uygulanacak toplama serisi.

Gerekenler:

• 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ı.

Sağlanmazsa Firestore, field_<incremental_id++> biçiminde 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 (
  ...
);

Gerekenler:

• Tüm toplama takma adları genelinde 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 işlemi için kullanılan alan.

Int64Value

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

Bu sayede taranacak doküman sayısı için bir üst sınır ayarlayabilir, gecikmeyi ve maliyeti sınırlandırabilirsiniz.

Belirtilmedi, sınır yok olarak yorumlanır.

Üst Düzey Örnek:

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

Gerekenler:

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

FieldReference

Toplama işlemi için kullanılan alan.

Projection

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

Bu, bir sorgudan döndürülen dokümanlar üzerinde bir DocumentMask işlevi görür. Ayarlanmazsa 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 sipariş veya kısmi sipariş vermelerine ya da hiç sipariş vermemelerine olanak tanır. Firestore her durumda, aşağıdaki kurallar aracılığıyla istikrarlı bir sıralamayı garanti eder:

• order_by, 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 alanlara, alan adının sözlük sıralamasına göre eklenir.
• __name__ üzerinde bir sipariş belirtilmezse varsayılan olarak bu sipariş eklenir.

Alanlara, belirtilen son sırayla aynı sıralama yönü veya "ASCENDING" ifadesi eklenir görebilirsiniz. Ö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

Sonuç kümesindeki sorgunun başlatılacağı konumun potansiyel ön eki.

Sonuç kümesinin sıralaması, orijinal sorgunun ORDER BY ifadesine göredir.

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ıralanıyor.

İmleçler tam sıralamaya veya konumun önekine referans verebilir. Ancak sağlanan ORDER BY alanında bulunandan daha fazla alana atıfta bulunamaz.

Yukarıdaki örnekten devam edeceğimiz için, aşağıdaki başlatma imleçlerini eklemenin çeşitli etkileri olacaktır:

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

Atlanması için ilk N sonucun taranmasını gerektiren OFFSET işlevinin aksine, başlatma imleci sorgunun mantıksal bir konumda başlamasını sağlar. Bu konumun gerçek bir sonuçla eşleşmesi gerekmez. Sonraki dokümanı bulmak için bu konumdan ileriye doğru tarama yapar.

Gerekenler:

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

Cursor

Sonuç kümesinde sorgunun sona ereceği konumun potansiyel ön eki.

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

Gerekenler:

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

int32

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

Bu, WHERE, START AT ve END AT ancak LIMIT deyiminden önce.

Gerekenler:

• Değer belirtilirse 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 geçerlidir.

Gerekenler:

• Değer belirtilirse 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şular araması.

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

Verilen sorgu vektörüne en yakın vektör yerleştirmeleri bulur.

string

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

bool

Yanlış değerine ayarlandığında yalnızca, içeren RunQueryRequest öğesinde belirtilen parent öğesinin en yakın alt öğeleri olan koleksiyonları seçer. Doğru değerine ayarlandığında tüm alt alt koleksiyonları seçer.

Operator

Birden fazla filtreyi birleştirme operatörü.

Filter

Birleştirilecek filtrelerin listesi.

Gerekenler:

• En az bir filtre var.

FieldReference

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

Operator

Filtreleme ölçütü olarak kullanılacak operatör.

Value

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

string

Bir dokümandaki alana yapılan referans.

Gerekenler:

• Her segment document field name sınırlamalarına uygun olan, noktayla ayrılmış (.) bir segment dizesi ZORUNLUDUR.

CompositeFilter

Birleşik filtre.

FieldFilter

Belge alanında bir filtre.

UnaryFilter

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

FieldReference

Zorunlu. Arama yapılacak dizine eklenmiş vektör alanı. Yalnızca boyutları query_vector ile eşleşen vektörleri içeren dokümanlar döndürülebilir.

Value

Zorunlu. Arama yaptığımız sorgu vektörü. Boyutları en fazla 2048 olan bir vektör içermelidir.

DistanceMeasure

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

Int32Value

Zorunlu. Geri dönecek en yakın komşu sayısı. 1000'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şsa tüm alanlar döndürülür. Yalnızca belgenin adını döndürmek için ['__name__'] işlevini kullanın.

Operator

Uygulanacak tekli operatör.

FieldReference

Operatörün uygulanacağı alan.

int32

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

target_id değeri 0 ise (veya belirtilmemişse) sunucu, bu hedef için bir kimlik atar ve bunu bir TargetChange::ADD etkinliğinde döndürür. target_id=0 özelliğini içeren bir hedef eklendikten sonra, sonraki tüm hedeflerin de target_id=0 içermesi gerekir. 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ği içeren bir yanıt gönderir.

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

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

bool

Hedefin güncel ve tutarlı hale geldikten sonra kaldırılması gerekip gerekmediği.

Int32Value

Devam ettirme jetonu veya okunma zamanı sırası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ğer mevcuttur ve istemcinin yanıta ExistenceFilter.unchanged_names dahil edilmesini istediği sinyali sıfırdan büyüktür.

QueryTarget

Sorgu tarafından belirtilen bir hedef.

DocumentsTarget

Bir dizi doküman adıyla belirtilen hedef.

bytes

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

Farklı bir hedefle devam ettirme jetonu kullanmak desteklenmez ve başarısız olabilir.

Timestamp

Belirli bir read_time sonra dinlemeye başlayın.

Müşteri, şu an için eşleşen dokümanların durumunu bilmelidir.

string

Alınacak dokümanların adları. Belirtilen biçimde: 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ı. Şu biçimde: 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 sorgu.

TargetChangeType

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

int32

Değişen hedeflerin hedef kimlikleri.

Boşsa değişiklik tüm hedeflere uygulanır.

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

Status

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

bytes

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

Her hedef değişikliği için ayarlanmaz.

Timestamp

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

Akışın tamamı yeni ve tutarlı bir anlık görüntüye ulaştığında, akışın target_ids ile boş bir read_time göndermesi garanti edilir. ADD, CURRENT ve RESET iletilerinin sonunda (sonuçta) yeni ve tutarlı bir anlık görüntü elde edilmesi garanti edilir (NO_CHANGE ve REMOVE mesajları bu durumu değiştirmez).

Belirli bir akışta read_time değerinin monoton olarak 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

Belgeleri belirtilen zamanda okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

bytes

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

Document

Zorunlu. Güncellenen doküman. Henüz yoksa dokümanı oluşturur.

DocumentMask

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

Doküman sunucuda mevcutsa ve maskede referans verilmeyen alanlar varsa 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ümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

Precondition

Dokümandaki isteğe bağlı bir ön koşul. Bu ayar yapılırsa ve hedef belge tarafından karşılanmazsa istek başarısız olur.

NullValue

Boş değer.

bool

Boole değeri.

int64

Tam sayı değeri.

double

Çift değer.

Timestamp

Zaman damgası değeri.

Yalnızca mikrosaniyelere kadar hassastır. Ek hassasiyetler depolandığında aşağı doğru yuvarlanır.

string

Dize değeri.

UTF-8 olarak temsil edilen dize, 1 MiB ile 89 bayt arasında olmalıdır. UTF-8 temsilinin yalnızca ilk 1.500 baytı sorgular tarafından dikkate alınır.

bytes

Bayt değeri.

1 MiB - 89 bayt arasında olmalıdır. Sorgular,yalnızca ilk 1.500 baytı dikkate alır.

string

Bir dokümana referans. Örnek: 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 diziyi içeren bir eşleme içerebilir.

MapValue

Harita değeri.

DocumentMask

Bu yazmada güncellenecek alanlar.

Bu alan yalnızca update olduğunda ayarlanabilir. update için maske ayarlanmadıysa ve doküman mevcutsa mevcut tüm verilerin üzerine yazılır. Maske ayarlanırsa ve sunucudaki dokümanda maskenin kapsamadığı alanlar varsa bunlar değiştirilmeden bırakılır. Maskede başvurulan ancak giriş dokümanında bulunmayan alanlar sunucudaki dokümandan silinir. Bu maskedeki alan yolları, ayrılmış alan adı içermemelidir.

FieldTransform

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

Bu alan yalnızca update olduğunda ayarlanabilir. Varsa bu yazma işlemi, aynı belgede atomik ve sırayla update ve transform işlemi gerçekleştirmekle eşdeğerdir.

Precondition

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

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

Document

Yazılacak doküman.

string

Silinecek doküman adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

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

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{project_id}/databases/{database_id}. Bu yalnızca ilk mesajda gereklidir.

string

Devam ettirilecek yazma akışının kimliği. Bu ayar yalnızca ilk mesajda yapılabilir. Boş bırakılırsa yeni bir yazma akışı oluşturulur.

Write

Uygulanacak yazma işlemleri.

Her zaman atomik ve sıralı bir şekilde yürütülür. İlk istekte bu alan boş bırakılmalıdır. Bu alan son istekte boş olabilir. Bu alan, diğer tüm isteklerde boş olmamalıdır.

bytes

Sunucu tarafından daha önce gönderilen akış jetonu.

İstemci bu alanı, aldığı en son WriteResponse içindeki jetona ayarlamalıdır. Bu, istemcinin bu jetona kadar yanıt aldığını onaylar. Bu jeton gönderildikten sonra önceki 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. 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şkilendirilen etiketler.

string

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

bytes

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

Bu alan her zaman ayarlıdır.

WriteResult

Yazma işlemlerinin uygulanmasının sonucu.

Bu i-'inci yazma sonucu, istekteki i'inci yazmaya karşılık gelir.

Timestamp

Kaydetmenin gerçekleştiği zaman. read_time değerine eşit veya daha büyük olan tüm okumaların, yazma işleminin etkilerini görmesi garanti edilir.

Timestamp

Yazma uygulandıktan sonra dokümanın son güncelleme zamanı. delete sonrasında ayarlanmaz.

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

Value

Her bir DocumentTransform.FieldTransform öğesinin aynı sırayla uygulanmasının sonuçları.