Method: projects.databases.documents.list

Wyświetla listę dokumentów.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

To pole jest wymagane. Nazwa zasobu nadrzędnego. W formacie: projects/{projectId}/databases/{databaseId}/documents lub projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Na przykład: projects/my-project/databases/my-database/documents lub projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

Opcjonalnie. Identyfikator kolekcji względem parent, do listy.

Na przykład: chatrooms lub messages.

Jest to opcjonalne. Jeśli nie zostanie podany, Firestore będzie wyświetlać dokumenty ze wszystkich kolekcji w ramach podanego parent.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba dokumentów do zwrócenia w jednej odpowiedzi.

Firestore może zwrócić mniej niż ta wartość.
pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi documents.list.

Podaj go, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry (z wyjątkiem pageSize) muszą być zgodne z wartościami ustawionymi w żądaniu, które wygenerowało token strony.
orderBy

string

Opcjonalnie. Opcjonalna kolejność zwracanych dokumentów.

Na przykład: priority desc, __name__ desc.

Powiela to pole ORDER BY używane w zapytaniach Firestore, ale w postaci ciągu. Gdy go nie ma, dokumenty są uporządkowane według: __name__ ASC.
mask

object (DocumentMask)

Opcjonalnie. Pola do zwrócenia. Jeśli zasada nie jest skonfigurowana, zwraca wszystkie pola.

Jeśli dokument ma pole, którego nie ma w masce, to pole nie zostanie zwrócone w odpowiedzi.
showMissing

boolean

Czy na liście powinny być widoczne brakujące dokumenty.

Brakuje dokumentu, jeśli nie istnieje, ale znajdują się pod nim umieszczone dokumenty podrzędne. Jeśli ma wartość prawda, takie brakujące dokumenty są zwracane z kluczem, ale nie mają ustawionych pól oraz pól createTime ani updateTime.

Żądania z showMissing nie mogą określać właściwości where ani orderBy.
Parametr sumy consistency_selector. Tryb spójności tej transakcji. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może mieć tylko jedną z tych wartości:
transaction

string (bytes format)

Wykonaj odczyt w ramach już aktywnej transakcji.

Ciąg zakodowany w formacie base64.
readTime

string (Timestamp format)

Wykonaj odczyt w podanym czasie.

Musi to być sygnatura czasowa z dokładnością do mikrosekundy z ostatniej godziny. Jeśli odzyskiwanie do określonego momentu jest włączone, może to być dodatkowo pełna sygnatura czasowa z ostatnich 7 dni.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała instancję ListDocumentsResponse.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).