Method: projects.databases.documents.listDocuments

Belgeleri listeler.

HTTP isteği

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}/{collectionId}

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Üst kaynak adı. Şu biçimde: projects/{projectId}/databases/{databaseId}/documents veya projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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

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.

Sorgu parametreleri

Parametreler
pageSize

integer

İ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.
pageToken

string

İsteğe bağlı. Önceki documents.list 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 (pageSize hariç), sayfa jetonunu oluşturan istekte ayarlanan değerlerle eşleşmelidir.
orderBy

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.
mask

object (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.
showMissing

boolean

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 createTime veya updateTime alanları ayarlanmaz.

showMissing içeren isteklerde where veya orderBy belirtilemez.
Birleştirme parametresi consistency_selector. Bu işlem için tutarlılık modu. Ayarlanmazsa varsayılan olarak güçlü tutarlılık kullanılır. consistency_selector şunlardan yalnızca biri olabilir:
transaction

string (bytes format)

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

base64 kodlu bir dize.
readTime

string (Timestamp format)

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.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

İstek içeriği

İsteğin gövdesi boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, ListDocumentsResponse öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.