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 |
Wymagane. Nazwa zasobu nadrzędnego. W formacie Na przykład: |
collectionId |
Opcjonalnie. Identyfikator kolekcji względem listy np. Jest to opcjonalne. Jeśli jej nie podasz, Firestore wyświetli listę dokumentów ze wszystkich kolekcji w ramach podanego atrybutu |
Parametry zapytania
Parametry | |
---|---|
pageSize |
Opcjonalnie. Maksymalna liczba dokumentów zwracanych w jednej odpowiedzi. Firestore może zwrócić mniej niż ta wartość. |
pageToken |
Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi Podaj je, aby pobrać kolejną stronę. Podczas podziału na strony wszystkie pozostałe parametry (z wyjątkiem |
orderBy |
Opcjonalnie. Opcjonalna kolejność zwracanych dokumentów. Przykład: Odzwierciedla to |
mask |
Opcjonalnie. Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola. Jeśli dokument zawiera pole, którego nie ma w tej masce, nie zostanie ono zwrócone w odpowiedzi. |
showMissing |
Czy lista powinna zawierać brakujące dokumenty? Dokument, który nie istnieje, nie istnieje, ale znajdują się pod nim zagnieżdżone dokumenty podrzędne. Jeśli ma wartość true (prawda), takie brakujące dokumenty będą zwracane z kluczem, ale bez ustawionych pól Żądania z atrybutem |
Parametr sumy funkcji consistency_selector . Tryb spójności tej transakcji. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może być tylko jedną z tych wartości: |
|
transaction |
Przeprowadź odczyt w ramach aktywnej transakcji. Ciąg zakodowany w standardzie base64. |
readTime |
Wykonaj odczyt o podanej godzinie. Musi to być sygnatura czasowa precyzji określona w mikrosekundach z ostatniej godziny lub jeśli włączona jest funkcja odzyskiwania do określonego momentu, może to być dodatkowo sygnatura czasowa obejmująca całą minutę z ostatnich 7 dni. Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ListDocumentsResponse
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.