Package google.firestore.v1

map<string, Value>

Wynik funkcji agregacji, np. COUNT(*) AS total_docs.

Klucz to element alias przypisany do funkcji agregacji na danych wejściowych, a rozmiar tej mapy jest równa liczbie funkcji agregacji w zapytaniu.

Value

Wartości w tablicy.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

string

Nazwy dokumentów do pobrania. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}. Żądanie zakończy się niepowodzeniem, jeśli żaden z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną usunięte.

DocumentMask

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

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

bytes

Odczytywanie dokumentów w ramach transakcji.

TransactionOptions

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie jest to transakcja tylko do odczytu. Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu.

Timestamp

Odczytuje dokumenty w takiej postaci, w jakiej były w danym momencie.

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.

bytes

Transakcja rozpoczęta w ramach tego żądania. Zostanie ustawiona tylko w pierwszej odpowiedzi i tylko wtedy, gdy w żądaniu ustawiono atrybut BatchGetDocumentsRequest.new_transaction.

Timestamp

Czas odczytu dokumentu. Liczba ta może rosnąć monotycznie. W tym przypadku w tym przypadku wcześniejsze dokumenty w strumieniu wyników nie zmienią się między czasem odczytu a tym.

Document

Dokument, o który poproszono.

string

Nazwa dokumentu, która została wysłana, ale nie istnieje. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

Write

Zapisy, które mają zostać zastosowane.

Metoda nie stosuje atomowych zapisów i nie gwarantuje kolejności. Każdy zapis jest sprawdzany lub kończy się niepowodzeniem niezależnie. Nie możesz zapisać w tym samym dokumencie więcej niż raz na jedno żądanie.

map<string, string>

Etykiety powiązane z tym zapisem wsadowym.

WriteResult

Wynik zastosowania zapisów.

Ten wynik i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

Status

Stan zastosowania zapisów.

Ten stan i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

TransactionOptions

Opcje transakcji. Domyślnie jest to transakcja do odczytu i zapisu.

bytes

Transakcja, która została rozpoczęta.

bytes

Bajty, które kodują sekwencję bitów. Jego długość może wynosić zero.

int32

Liczba bitów ostatniego bajtu w argumencie bitmap, które mają zostać zignorowane jako „pełnienie”. Jeśli długość parametru bitmap wynosi 0, ta wartość musi wynosić 0. W przeciwnym razie ta wartość musi mieścić się w zakresie od 0 do 7 włącznie.

BitSequence

Dane filtra kwitnienia.

int32

Liczba haszy używanych przez algorytm.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

Write

Zapisy, które mają zostać zastosowane.

Zawsze wykonywany atomowo i w określonej kolejności.

bytes

Jeśli jest ustawione, stosuje wszystkie zapisy w tej transakcji i je zatwierdza.

WriteResult

Wynik zastosowania zapisów.

Ten wynik i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

Timestamp

Czas realizacji zatwierdzenia. Każdy odczyt o wartości read_time lub większej jest gwarantowany, aby sprawdzić efekty zatwierdzenia.

string

Wymagane. Zasób nadrzędny. Na przykład: projects/{project_id}/databases/{database_id}/documents lub projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Wymagane. Identyfikator kolekcji względem parent, do listy. Na przykład: chatrooms.

string

Przypisany przez klienta identyfikator dokumentu, który ma być używany w tym dokumencie.

Opcjonalnie. Jeśli go nie podasz, usługa otrzyma identyfikator.

Document

Wymagane. Dokument do utworzenia. Pole name nie może być ustawione.

DocumentMask

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

Jeśli dokument zawiera pole, którego nie ma w tej masce, nie zostanie ono zwrócone w odpowiedzi.

Value

Wartości reprezentujące pozycję w kolejności, w jakiej występują w kolejności klauzuli zapytania.

Może zawierać mniej wartości niż określono w klauzuli kolejności.

bool

Określa, czy pozycja znajduje się tuż przed podanymi wartościami lub tuż po nich, zależnie od kolejności sortowania zdefiniowanej przez zapytanie.

string

Wymagane. Nazwa zasobu dokumentu do usunięcia. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Opcjonalny warunek wstępny dotyczący dokumentu. Jeśli ta wartość zostanie ustawiona, a dokument docelowy nie spełni tego żądania, żądanie zakończy się niepowodzeniem.

string

Nazwa zasobu dokumentu, na przykład projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Tylko dane wyjściowe. Czas utworzenia dokumentu.

Ta wartość zwiększa się monotonicznie, gdy dokument jest usuwany, a następnie odtworzony. Można je też porównywać z wartościami z innych dokumentów i elementem read_time zapytania.

Timestamp

Tylko dane wyjściowe. Czas ostatniej modyfikacji dokumentu.

Początkowo ta wartość jest ustawiona na create_time, a następnie monotonicznie zwiększa się z każdą zmianą w dokumencie. Można je też porównywać z wartościami z innych dokumentów i elementem read_time zapytania.

Document

Nowy stan Document.

Jeśli ustawiona jest wartość mask, zawiera tylko pola, które zostały zaktualizowane lub dodane.

int32

Zestaw identyfikatorów celów, które pasują do tego dokumentu.

int32

Zestaw identyfikatorów celów, które nie pasują już do tego dokumentu.

string

Nazwa zasobu usuniętego obiektu Document.

int32

Zestaw identyfikatorów wartości docelowych, które wcześniej pasowały do tej encji.

Timestamp

Sygnatura czasowa odczytu, w którym zaobserwowano usunięcie.

Większe lub równe commit_time usunięcia.

string

Lista ścieżek pól w masce. Informacje o składni ścieżek pól znajdziesz w Document.fields.

string

Nazwa zasobu elementu Document, który przestał być widoczny.

int32

Zestaw identyfikatorów celów, które wcześniej pasowały do tego dokumentu.

Timestamp

Sygnatura czasowa odczytu, w której zaobserwowano usunięcie.

Większe lub równe commit_time zmiany/usunięcia/usunięcia.

string

Nazwa dokumentu do przekształcenia.

FieldTransform

Lista przekształceń, które mają zostać zastosowane do pól dokumentu w określonej kolejności. To pole nie może być puste.

string

Ścieżka pola. Informacje o składni ścieżek pól znajdziesz na Document.fields.

ServerValue

Ustawia w polu podaną wartość serwera.

Value

Dodaje podaną wartość do bieżącej wartości pola.

Musi to być liczba całkowita lub liczba zmiennoprzecinkowa. Jeśli pole nie jest liczbą całkowitą ani zmiennoprzecinkową albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi w polu podaną wartość. Jeśli jedna z podanych wartości lub obecna wartość pola to wartości zmiennoprzecinkowe, obie te wartości zostaną zinterpretowane jako liczby zmiennoprzecinkowe. Podwójna arytmetyka i reprezentacja wartości podwójnej precyzji są zgodne ze standardem IEEE 754. Jeśli występuje dodatnie/ujemne przekroczenie liczby całkowitej, pole jest przekształcane na największą dodatnią/ujemną liczbę całkowitą.

Value

Ustawia maksymalną wartość pola na jego bieżącą i podaną wartość.

Musi to być liczba całkowita lub liczba zmiennoprzecinkowa. Jeśli pole nie jest liczbą całkowitą ani zmiennoprzecinkową albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi w polu podaną wartość. W przypadku zastosowania maksymalnej operacji, w której pole i wartość wejściowa są różnych typów (tzn. jedna jest liczbą całkowitą, a druga to podwójna), pole przyjmuje typ większego operandu. Jeśli operandy są równoważne (np. 3 i 3.0), pole nie zmienia się. 0, 0,0 i -0,0 to zero. Maksymalna wartość środków przedpłaconych i 0 wartości wejściowej to zawsze wartość przedpłacona. Maksymalna wartość liczbowa x i NaN to NaN.

Value

Ustawia w polu minimalną wartość bieżącej i podaną wartość.

Musi to być liczba całkowita lub liczba zmiennoprzecinkowa. Jeśli pole nie jest liczbą całkowitą ani zmiennoprzecinkową albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi w polu wartość wejściową. Jeśli stosowana jest operacja minimalna, w której pole i wartość wejściowa są różnych typów (tzn. jedna jest liczbą całkowitą, a drugą jest liczbą podwójną), pole przyjmuje typ mniejszego operandu. Jeśli operandy są równoważne (np. 3 i 3.0), pole nie zmienia się. 0, 0,0 i -0,0 to zero. Najniższa wartość przedpłaconej i 0 wejściowa to zawsze wartość przedpłacona. Minimalną wartością każdej wartości liczbowej x i NaN jest NaN.

ArrayValue

Dołącz podane elementy w kolejności, jeśli nie występują jeszcze w bieżącej wartości pola. Jeśli pole nie jest tablicą lub jeśli pole jeszcze nie istnieje, najpierw ustawiane jest puste pole.

Liczby równoważne różnych typów (np. 3L i 3,0) są uznawane za równe podczas sprawdzania, czy brakuje wartości. NaN jest równa NaN, a Null jest równa null. Jeśli dane wejściowe zawierają kilka równoważnych wartości, brana jest pod uwagę tylko pierwsza z nich.

Powiązany wynik przekształcenia będzie miał wartość null.

ArrayValue

Usuń z tablicy w polu wszystkie podane elementy. Jeśli pole nie jest tablicą lub jeśli pole jeszcze nie istnieje, jest ustawione na pustą tablica.

Przy podejmowaniu decyzji o usunięciu elementu uznaje się, że liczby równoważne różnych typów (np. 3L i 3.0). NaN jest równa NaN, a Null jest równa null. Spowoduje to usunięcie wszystkich równoważnych wartości, jeśli istnieją duplikaty.

Powiązany wynik przekształcenia będzie miał wartość null.

int64

Łączna liczba zwróconych wyników, w tym dokumentów, prognoz, wyników agregacji i kluczy.

Duration

Całkowity czas wykonania zapytania w backendzie.

int64

Łączna liczba płatnych operacji odczytu.

Struct

Debugowanie statystyk wykonania zapytania. Pamiętaj, że statystyki debugowania mogą się zmieniać wraz z rozwojem Firestore. Może to obejmować: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" }

int32

Identyfikator celu, do którego ma zastosowanie ten filtr.

int32

Łączna liczba dokumentów, które pasują do: target_id.

Jeśli liczba pasujących dokumentów na koncie klienta różni się od liczby pasujących dokumentów, klient musi ręcznie określić, które dokumenty nie pasują już do wartości docelowej.

Aby ułatwić sobie to ustalenie, klient może użyć filtra kwitnienia unchanged_names, testując WSZYSTKIE nazwy dokumentów pod kątem tego filtra; jeśli nazwa dokumentu NIE występuje w filtrze, oznacza to, że dokument nie pasuje już do elementu docelowego.

BloomFilter

Filtr rozkwitu, który pomimo swojej nazwy zawiera kodowanie bajtowe UTF-8 nazw zasobów WSZYSTKICH dokumentów pasujących do reguły target_id. Ma postać projects/{project_id}/databases/{database_id}/documents/{document_path}.

Ten filtr rozkwitu może zostać pominięty przez serwer według własnego uznania, na przykład w przypadku stwierdzenia, że klient nie będzie go używać, lub gdy obliczenia i transmisje są zbyt kosztowne pod względem obliczeń. Klienci muszą właściwie radzić sobie z brakiem tego pola, wracając do logiki użytej przed jego stworzeniem. czyli ponownie dodaj środowisko docelowe bez tokena wznowienia, aby sprawdzić, które dokumenty w pamięci podręcznej klienta są niezsynchronizowane.

PlanSummary

Informacje o fazie planowania dla zapytania.

ExecutionStats

Zbiorcze statystyki z wykonania zapytania. Występuje tylko wtedy, gdy zasada ExplainOptions.analyze ma wartość Prawda.

bool

Opcjonalnie. Określa, czy to zapytanie ma zostać wykonane.

Jeśli wartość domyślna to fałsz (domyślnie), zapytanie zostanie zaplanowane i zwróci tylko dane z etapów planowania.

Jeśli wybrano opcję prawda, zapytanie zostanie zaplanowane i wykonane, tak aby zwracały pełne wyniki zapytania wraz ze wskaźnikami dotyczącymi etapu planowania i wykonania.

string

Wymagane. Nazwa zasobu dokumentu do pobrania. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

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

Jeśli dokument zawiera pole, którego nie ma w tej masce, nie zostanie ono zwrócone w odpowiedzi.

bytes

Odczytywanie dokumentu w ramach transakcji.

Timestamp

Odczytuje wersję dokumentu w danym momencie.

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.

string

Wymagane. Dokument nadrzędny. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}. Przykład: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Maksymalna liczba wyników do zwrócenia.

string

Token strony. Wymagana jest wartość z zakresu od ListCollectionIdsResponse.

Timestamp

Odczytuje dokumenty w takiej postaci, w jakiej były w danym momencie.

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.

string

Identyfikatory kolekcji.

string

Token strony, który może służyć do kontynuowania listy.

string

Wymagane. Nazwa zasobu nadrzędnego. W formacie: projects/{project_id}/databases/{database_id}/documents lub projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

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.

int32

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

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

string

Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi ListDocuments.

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

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.

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 tej masce, nie zostanie ono zwrócone w odpowiedzi.

bool

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 create_time ani update_time.

Żądania z show_missing nie mogą określać właściwości where ani order_by.

bytes

Wykonaj odczyt w ramach już aktywnej transakcji.

Timestamp

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.

Document

Znalezione dokumenty.

string

Token umożliwiający pobranie następnej strony dokumentów.

Jeśli pominiesz to pole, nie będzie kolejnych stron.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

map<string, string>

Etykiety powiązane z tą zmianą docelową.

Target

Cel do dodania do tego strumienia.

int32

Identyfikator elementu docelowego do usunięcia z tego strumienia.

TargetChange

Cele uległy zmianie.

DocumentChange

Element Document został zmieniony.

DocumentDelete

Element Document został usunięty.

DocumentRemove

Wymiar Document został usunięty z celu (ponieważ nie jest już z nim związany).

ExistenceFilter

Filtr, który ma być stosowany do zbioru dokumentów zwróconych wcześniej w przypadku danego miejsca docelowego.

Zwracany, gdy dokumenty mogły zostać usunięte z danego miejsca docelowego, ale dokładne dokumenty są nieznane.

map<string, Value>

Pola mapy.

Klawisze mapy reprezentują nazwy pól. Nazwy pól pasujące do wyrażenia regularnego __.*__ są zarezerwowane. Zarezerwowane nazwy pól są zabronione z wyjątkiem niektórych udokumentowanych kontekstów. Klucze mapy, zakodowane w formacie UTF-8, nie mogą przekraczać 1500 bajtów ani być puste.

string

Wymagane. Nazwa zasobu nadrzędnego. W formacie: projects/{project_id}/databases/{database_id}/documents. Nazwy zasobów dokumentów nie są obsługiwane. można podać tylko nazwy zasobów baz danych.

int64

Żądana maksymalna liczba punktów partycji. Partycje mogą być zwracane na wielu stronach wyników. Liczba musi być liczbą dodatnią. Rzeczywista liczba zwróconych partycji może być mniejsza.

Na przykład można ustawić 1 mniej niż liczba równoległych zapytań do wykonania lub podczas uruchamiania zadania potoku danych wartość ta może być o 1 mniej niż liczba dostępnych instancji roboczych lub instancji obliczeniowych.

string

Wartość next_page_token zwrócona z poprzedniego wywołania PartitionQuery, która może zostać użyta do uzyskania dodatkowego zestawu wyników. Nie ma gwarancji kolejności między zestawami wyników. Dlatego korzystanie z wielu zbiorów wyników wymaga scalania różnych zbiorów.

Na przykład 2 kolejne wywołania z użyciem parametru page_token mogą zwrócić:

• kursor B, kursor M, kursor Q
• kursor A, kursor U, kursor W

Aby uzyskać pełny zestaw wyników uporządkowany według wyników zapytania dostarczonego w narzędziu PartitionQuery, musisz je scalać: kursor A, kursor B, kursor M, kursor Q, kursor U, kursor W.

int32

Maksymalna liczba partycji do zwrócenia w ramach tego wywołania (podlega ona zasadom partition_count).

Na przykład jeśli partition_count = 10, a page_size = 8, pierwsze wywołanie PartitionQuery zwróci do 8 partycji, a next_page_token, jeśli istnieje ich więcej. Drugie wywołanie PartitionQuery zwróci maksymalnie 2 partycje, aby zakończyć ich łączną liczbę podaną w zasadzie partition_count.

StructuredQuery

Uporządkowane zapytanie. Zapytanie musi określać kolekcję ze wszystkimi elementami podrzędnymi i być uporządkowane rosnąco według nazwy. Inne filtry, kolejność według kolejności, granice, przesunięcia ani kursory początku/końca nie są obsługiwane.

Timestamp

Odczytuje dokumenty w takiej postaci, w jakiej były w danym momencie.

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.

Cursor

Wyniki partycjonowania. Każda partycja jest punktem podziału, którego RunQuery może używać jako punktu początkowego lub końcowego wyników zapytania. Żądania RunQuery muszą być wysyłane przy użyciu tego samego zapytania, które zostało dostarczone do tego żądania PartitionQuery. Kursory partycji zostaną uporządkowane w tej samej kolejności co wyniki zapytania dostarczonego do PartitionQuery.

Jeśli na przykład żądanie PartitionQuery zwraca kursory A i B, wykonanie tych 3 zapytań spowoduje zwrócenie całego zestawu wyników pierwotnego zapytania:

• zapytanie, koniec_od A
• zapytanie, początek_od A, koniec_od B
• zapytanie, zaczynając od B

Pusty wynik może oznaczać, że zapytanie zawiera zbyt mało wyników do partycjonowania lub że zapytanie nie jest jeszcze obsługiwane do partycjonowania.

string

Token strony, który może być używany do żądania dodatkowego zestawu wyników, maksymalnie do liczby określonej przez partition_count w żądaniu PartitionQuery. Jeśli pole jest puste, nie ma więcej wyników.

Struct

Indeksy wybrane dla zapytania. Na przykład: [ {"query_scope": "Collection", "properties": "(foo ASC, nazwa ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, nazwa ASC)"} ]

bool

Gdy ustawiona jest wartość true, dokument docelowy musi istnieć. Jeśli zasada ma wartość false, dokument docelowy nie może istnieć.

Timestamp

Jeśli jest ustawiony, dokument docelowy musi istnieć i miał być ostatnio aktualizowany. Sygnatura czasowa musi być wyrównana w mikrosekundach.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

bytes

Wymagane. Transakcja do wycofania.

string

Wymagane. Nazwa zasobu nadrzędnego. W formacie: projects/{project_id}/databases/{database_id}/documents lub projects/{project_id}/databases/{database_id}/documents/{document_path}. Na przykład: projects/my-project/databases/my-database/documents lub projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opcjonalnie. Wyjaśnij opcje zapytania. Jeśli jest ustawione, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania.

StructuredAggregationQuery

Zapytanie agregujące.

bytes

Uruchom agregację w ramach już aktywnej transakcji.

Wartość w tym miejscu to nieprzejrzysty identyfikator transakcji, w której ma zostać wykonane zapytanie.

TransactionOptions

Uruchamia nową transakcję w ramach zapytania z domyślnym ustawieniem „tylko do odczytu”.

Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu.

Timestamp

Wykonuje zapytanie o podanej sygnaturze czasowej.

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.

AggregationResult

Jeden wynik agregacji.

Nie występuje w przypadku raportowania częściowego postępu.

bytes

Transakcja rozpoczęta w ramach tego żądania.

Widoczny tylko w pierwszej odpowiedzi, gdy żądanie dotyczyło rozpoczęcia nowej transakcji.

Timestamp

Godzina obliczenia wyniku zagregowanego. Ta wartość jest zawsze monotonicznie rosnąca. w tym przypadku poprzedni wynik AggregationResult w strumieniu wyników nie zmieni się między read_time a tym.

Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem read_time i brakiem result. Wskazuje ona czas uruchomienia zapytania.

ExplainMetrics

Wskaźniki wyjaśnień zapytania. Ten parametr występuje tylko wtedy, gdy podano RunAggregationQueryRequest.explain_options i jest wysyłany tylko raz z ostatnią odpowiedzią w strumieniu.

string

Wymagane. Nazwa zasobu nadrzędnego. W formacie: projects/{project_id}/databases/{database_id}/documents lub projects/{project_id}/databases/{database_id}/documents/{document_path}. Na przykład: projects/my-project/databases/my-database/documents lub projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opcjonalnie. Wyjaśnij opcje zapytania. Jeśli jest ustawione, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania.

StructuredQuery

Uporządkowane zapytanie.

bytes

Uruchom zapytanie w ramach już aktywnej transakcji.

Wartość w tym miejscu to nieprzejrzysty identyfikator transakcji, w której ma zostać wykonane zapytanie.

TransactionOptions

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie jest to transakcja tylko do odczytu. Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu.

Timestamp

Odczytuje dokumenty w takiej postaci, w jakiej były w danym momencie.

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.

bytes

Transakcja rozpoczęta w ramach tego żądania. Można go ustawić tylko w pierwszej odpowiedzi i tylko wtedy, gdy w żądaniu ustawiono atrybut RunQueryRequest.new_transaction. Jeśli jest ustawione, w odpowiedzi nie zostaną ustawione żadne inne pola.

Document

Wynik zapytania, który nie jest ustawiany podczas raportowania częściowego postępu.

Timestamp

Czas odczytu dokumentu. Może narastać monotonicznie. w takim przypadku poprzednie dokumenty w strumieniu wyników nie zostaną zmienione między dokumentem read_time a tym.

Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem read_time i brakiem document. Wskazuje ona czas uruchomienia zapytania.

int32

Liczba wyników, które zostały pominięte z powodu przesunięcia między ostatnią i bieżącą odpowiedzią.

ExplainMetrics

Wskaźniki wyjaśnień zapytania. Ten parametr występuje tylko wtedy, gdy podano RunQueryRequest.explain_options i jest wysyłany tylko raz z ostatnią odpowiedzią w strumieniu.

bool

Jeśli jest dostępny, Firestore zakończył wykonywanie żądania i żadne dokumenty nie będą zwracane.

Aggregation

Opcjonalnie. Seria agregacji, które zostaną zastosowane do wyników funkcji structured_query.

Wymagane:

• Od co najmniej 1 do 5 agregacji na zapytanie.

StructuredQuery

Zagnieżdżone uporządkowane zapytanie.

string

Opcjonalnie. Opcjonalna nazwa pola, w którym mają być przechowywane wynik agregacji.

Jeśli nie zostanie podana, Firestore wybierze nazwę domyślną w formacie field_<incremental_id++>. Przykład:

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 (
  ...
);

zmienia się w:

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 (
  ...
);

Wymagane:

• Musi być niepowtarzalna wśród wszystkich aliasów agregacji.
• Zachowaj zgodność z ograniczeniami document field name.

Count

Agregator liczb.

Sum

Agregator sum.

Avg

Przeciętny agregator.

FieldReference

Pole do agregacji.

Int64Value

Opcjonalnie. Opcjonalne ograniczenie maksymalnej liczby dokumentów do zliczania.

Umożliwia to ustawienie górnej granicy liczby dokumentów do skanowania, co pozwala ograniczyć czas oczekiwania i koszty.

Wartość nieokreślona jest interpretowana jako brak zakresu.

Ogólny przykład:

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

Wymagane:

• Wartość musi być większa od zera.

FieldReference

Pole do agregacji.

Projection

Opcjonalny podzbiór pól do zwrócenia.

Działa jako element DocumentMask nad dokumentami zwróconymi w wyniku zapytania. Gdy zasada jest nieskonfigurowana, zakładamy, że wywołujący chce zwrócić wszystkie pola.

CollectionSelector

Kolekcje, których ma dotyczyć zapytanie.

Filter

Filtr, który ma zostać zastosowany.

Order

Kolejność, która ma być stosowana do wyników zapytania.

Firestore umożliwia wywołującym użytkownikom określenie pełnego sortowania, częściowego sortowania lub całkowity brak zamówień. We wszystkich przypadkach Firestore gwarantuje stabilną kolejność na podstawie tych reguł:

• Pole order_by jest wymagane, aby odwoływać się do wszystkich pól używanych z filtrem nierówności.
• Wszystkie pola, które muszą znajdować się w elemencie order_by, ale jeszcze go nie występują, są objęte leksykograficzną kolejnością nazw pól.
• Jeśli zamówienie z __name__ nie jest określone, jest dołączane domyślnie.

Pola są dodawane z tym samym kierunkiem sortowania co w przypadku ostatniego określonego porządku, czyli „ASCENDING” jeśli nie określono zamówienia. Przykład:

• ORDER BY a zmienia wartość na ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC zmienia wartość na ORDER BY a DESC, __name__ DESC
• WHERE a > 1 zmienia wartość na WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 zmienia wartość na WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

Potencjalny prefiks pozycji w zestawie wyników, od której ma się rozpoczynać zapytanie.

Kolejność w zbiorze wyników jest określana na podstawie klauzuli ORDER BY w pierwotnym zapytaniu.

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

Wyniki tego zapytania są uporządkowane według: (b ASC, __name__ ASC).

Kursory mogą odwoływać się do pełnej kolejności lub do prefiksu lokalizacji, ale nie mogą odwoływać się do większej liczby pól niż podano w ORDER BY.

Wracając do powyższego przykładu, umieszczenie następujących kursorów początkowych będzie miało różny wpływ:

• START BEFORE (2, /k/123): rozpocznij zapytanie tuż przed a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): rozpocznij zapytanie po a = 1 AND b > 10.

W przeciwieństwie do funkcji OFFSET, która wymaga skanowania pierwszych N wyników do pominięcia, kursor początkowy umożliwia rozpoczęcie zapytania w pozycji logicznej. To położenie nie musi odpowiadać rzeczywistemu wynikowi. Urządzenie przeskanuje od tej pozycji w celu znalezienia następnego dokumentu.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określonych w klauzuli ORDER BY.

Cursor

Potencjalny prefiks pozycji w zestawie wyników, na której kończy się zapytanie.

Jest to podobne do funkcji START_AT, ale kontroluje pozycję końcową, a nie pozycję początkową.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określonych w klauzuli ORDER BY.

int32

Liczba dokumentów do pominięcia przed zwróceniem pierwszego wyniku.

Ma to zastosowanie po ograniczeniach określonych przez WHERE, START AT i END AT, ale przed klauzulą LIMIT.

Wymagane:

• Wartość musi być większa niż lub równa 0, jeśli została określona.

Int32Value

Maksymalna liczba wyników do zwrócenia.

Ma zastosowanie po wszystkich innych ograniczeniach.

Wymagane:

• Wartość musi być większa niż lub równa 0, jeśli została określona.

FindNearest

Opcjonalnie. Wyszukiwanie potencjalnych najbliższych sąsiadów.

Ma zastosowanie po wszystkich innych filtrach i kolejności.

Znajduje wektory dystrybucyjne najbliższe danemu wektorowi zapytania.

string

Identyfikator kolekcji. Jeśli jest ustawiony, wybiera tylko kolekcje o tym identyfikatorze.

bool

Jeśli zasada ma wartość Fałsz, wybiera tylko kolekcje, które są bezpośrednimi elementami podrzędnymi elementu parent określonego w elemencie RunQueryRequest. Jeśli ma wartość prawda, wybierane są wszystkie kolekcje podrzędne.

Operator

Operator łączący wiele filtrów.

Filter

Lista filtrów do połączenia.

Wymagane:

• Jest co najmniej 1 filtr.

FieldReference

Pole, według którego chcesz filtrować.

Operator

Operator, według którego chcesz filtrować.

Value

Wartość do porównania.

string

Odwołanie do pola w dokumencie.

Wymagane:

• MUSI być ciągiem segmentów rozdzielonych kropką (.), gdzie każdy segment jest zgodny z ograniczeniami document field name.

CompositeFilter

Filtr złożony.

FieldFilter

Filtr w polu dokumentu.

UnaryFilter

Filtr, który przyjmuje dokładnie 1 argument.

FieldReference

Wymagane. Zindeksowane pole wektora do wyszukania. Zwracane mogą być tylko dokumenty zawierające wektory, których wymiarowość pasuje do parametru query_vector.

Value

Wymagane. Wektor zapytania, którego szukamy. Musi być wektorem o maksymalnie 2048 wymiarach.

DistanceMeasure

Wymagane. Miara odległości do użycia, wymagana.

Int32Value

Wymagane. Liczba najbliższych sąsiadów do zwrócenia. Wartość musi być dodatnią liczbą całkowitą nie większą niż 1000.

FieldReference

Pole, według którego ma być ustalana kolejność.

Direction

Kierunek sortowania. Domyślna wartość to ASCENDING.

FieldReference

Pola do zwrócenia.

Jeśli pole jest puste, zwracane są wszystkie pola. Aby zwrócić tylko nazwę dokumentu, użyj ['__name__'].

Operator

Jednoargumentowy operator do zastosowania.

FieldReference

Pole, do którego ma zostać zastosowany operator.

int32

Identyfikator elementu docelowego, który określa obiekt docelowy w strumieniu. Musi być liczbą dodatnią i inną niż zero.

Jeśli target_id ma wartość 0 (lub jest nieokreślona), serwer przypisuje identyfikator do tego celu i zwraca go w zdarzeniu TargetChange::ADD. Po dodaniu celu z target_id=0 wszystkie kolejne muszą mieć target_id=0. Jeśli po dodaniu elementu docelowego z atrybutem target_id=0 do serwera zostanie wysłane żądanie AddTarget z identyfikatorem target_id != 0, serwer natychmiast wyśle odpowiedź ze zdarzeniem TargetChange::Remove.

Pamiętaj, że jeśli klient wysyła wiele żądań AddTarget bez identyfikatora, kolejność identyfikatorów zwróconych w TargetChage.target_ids jest niezdefiniowana. Dlatego klienty powinny podawać identyfikator docelowy, zamiast polegać na tym, że przypisuje on identyfikator przez serwer.

Jeśli target_id ma wartość różną od 0, w tym strumieniu nie może istnieć aktywny cel o tym samym identyfikatorze.

bool

Czy cel powinien zostać usunięty, gdy będzie aktualny i spójny.

Int32Value

Liczba dokumentów, które ostatnio pasowały do zapytania przy tokenie wznowienia lub czasie odczytu.

Ta wartość ma znaczenie tylko wtedy, gdy podano resume_type. Jeśli ta wartość występuje i jest większa niż 0, wskazuje, że klient chce, aby w odpowiedzi znalazła się wartość ExistenceFilter.unchanged_names.

QueryTarget

Cel określony przez zapytanie.

DocumentsTarget

Cel określony przez zestaw nazw dokumentów.

bytes

Token wznowienia z poprzedniego TargetChange dla identycznego miejsca docelowego.

Użycie tokena CV z innym miejscem docelowym nie jest obsługiwane i może się nie powieść.

Timestamp

Zacznij słuchać po określonym read_time.

W tej chwili klient musi znać stan pasujących dokumentów.

string

Nazwy dokumentów do pobrania. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}. Żądanie zakończy się niepowodzeniem, jeśli żaden z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną usunięte.

string

Nazwa zasobu nadrzędnego. W formacie: projects/{project_id}/databases/{database_id}/documents lub projects/{project_id}/databases/{database_id}/documents/{document_path}. Na przykład: projects/my-project/databases/my-database/documents lub projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Uporządkowane zapytanie.

TargetChangeType

Typ zmiany, która wystąpiła.

int32

Identyfikatory celów, które uległy zmianie.

Jeśli pole będzie puste, zmiana zostanie zastosowana do wszystkich wartości docelowych.

Kolejność identyfikatorów elementów docelowych nie jest zdefiniowana.

Status

Błąd, który spowodował tę zmianę (w stosownych przypadkach).

bytes

Token, którego można użyć do wznowienia strumienia dla danej target_ids lub wszystkich środowisk docelowych, jeśli pole target_ids jest puste.

Nie jest ustawiany przy każdej zmianie wartości docelowej.

Timestamp

Spójna wartość read_time dla danego pola target_ids (pominięta, gdy identyfikatory target_id nie mają spójnego obrazu).

Strumień gwarantuje, że za każdym razem, gdy cały strumień uzyska nowy spójny zrzut, wyśle żądanie read_time z pustą wartością target_ids. Wiadomości ADD, CURRENT i RESET gwarantują (ostatecznie) utworzenie nowego spójnego podsumowania (nie dotyczy to wiadomości NO_CHANGE i REMOVE).

W przypadku danego strumienia read_time będzie monotonicznie rosnąca.

ReadOnly

Tej transakcji można używać tylko do operacji odczytu.

ReadWrite

Transakcje można używać w operacjach odczytu i zapisu.

Timestamp

Odczytuje dokumenty w określonym 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.

bytes

Opcjonalna transakcja do ponowienia.

Document

Wymagane. Zaktualizowany dokument. Tworzy dokument, jeśli jeszcze nie istnieje.

DocumentMask

Pola do zaktualizowania. Żadna ze ścieżek pól w masce nie może zawierać zarezerwowanej nazwy.

Jeśli dokument znajduje się na serwerze, a jego pola nie zawierają odniesień w masce, pozostaną one niezmienione. Pola, do których odwołuje się maska, ale nie ma ich w dokumencie wejściowym, są usuwane z dokumentu na serwerze.

DocumentMask

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

Jeśli dokument zawiera pole, którego nie ma w tej masce, nie zostanie ono zwrócone w odpowiedzi.

Precondition

Opcjonalny warunek wstępny dotyczący dokumentu. Jeśli ta wartość zostanie ustawiona, a dokument docelowy nie spełni tego żądania, żądanie zakończy się niepowodzeniem.

NullValue

Wartość null.

bool

Wartość logiczna.

int64

Wartość całkowita.

double

Wartość podwójnej precyzji.

Timestamp

Wartość sygnatury czasowej.

Dokładny tylko z dokładnością do mikrosekund. Zapisana dodatkowa precyzja jest zaokrąglana w dół.

string

Wartość ciągu znaków.

Ciąg znaków w formacie UTF-8 nie może przekraczać 1 MiB–89 bajtów. Zapytania uwzględniają tylko pierwsze 1500 bajtów reprezentacji UTF-8.

bytes

Wartość w bajtach.

Maksymalny rozmiar to 1 MiB–89 bajtów. Zapytania uwzględniają tylko pierwsze 1500 bajtów.

string

Odwołanie do dokumentu. Na przykład: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Wartość punktu geograficznego reprezentującego punkt na powierzchni Ziemi.

ArrayValue

Wartość tablicowa.

Nie może zawierać bezpośrednio innej wartości tablicy, chociaż może zawierać mapę zawierającą inną tablicę.

MapValue

Wartość mapy.

DocumentMask

Pola do zaktualizowania w tym zapisie.

To pole można ustawić tylko wtedy, gdy operacja to update. Jeśli maska nie jest ustawiona dla update, a dokument istnieje, wszystkie istniejące dane zostaną zastąpione. Jeśli maska jest ustawiona, a w dokumencie na serwerze są pola, które nie są zasłonięte maską, pozostają one niezmienione. Pola, do których odwołuje się maska, ale nie ma ich w dokumencie wejściowym, są usuwane z dokumentu na serwerze. Ścieżki pól w tej masce nie mogą zawierać zarezerwowanej nazwy pola.

FieldTransform

Przekształcenia, które mają zostać wykonane po aktualizacji.

To pole można ustawić tylko wtedy, gdy operacja to update. Jeśli ten zapis jest używany, odpowiada wykonaniu funkcji update i transform w przypadku tego samego dokumentu atomowo i w określonej kolejności.

Precondition

Opcjonalny warunek wstępny dotyczący dokumentu.

Jeśli ta wartość jest ustawiona, a dokument docelowy nie spełnia tego warunku, zapis się nie uda.

Document

Dokument do pisania.

string

Nazwa dokumentu do usunięcia. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Stosuje przekształcenie do dokumentu.

string

Wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}. To pole jest wymagane tylko w pierwszej wiadomości.

string

Identyfikator strumienia zapisu do wznowienia. Można to ustawić tylko w pierwszej wiadomości. Jeśli pozostawisz to pole puste, zostanie utworzony nowy strumień zapisu.

Write

Zapisy, które mają zostać zastosowane.

Zawsze wykonywany atomowo i w określonej kolejności. To pole musi być puste w pierwszym żądaniu. To pole może być puste w ostatnim żądaniu. To pole nie może być puste w przypadku wszystkich innych żądań.

bytes

Token strumienia, który został wcześniej wysłany przez serwer.

Klient powinien ustawić w tym polu token z ostatniego otrzymanego przez siebie zasobu WriteResponse. Jest to potwierdzenie, że klient otrzymał odpowiedzi aż do tego tokena. Po wysłaniu tego tokena wcześniejsze tokeny nie mogą być już używane.

Serwer może zamknąć strumień, jeśli jest zbyt wiele niepotwierdzonych odpowiedzi.

Pozostaw to pole nieskonfigurowane podczas tworzenia nowego strumienia. Aby wznowić strumieniowanie w określonym momencie, ustaw to pole oraz pole stream_id.

Pozostaw to pole nieskonfigurowane podczas tworzenia nowego strumienia.

map<string, string>

Etykiety powiązane z tym żądaniem zapisu.

string

Identyfikator strumienia. Ustawienie tylko dla pierwszej wiadomości po utworzeniu nowego strumienia.

bytes

Token reprezentujący pozycję tej odpowiedzi w strumieniu. Klient może go użyć, aby wznowić strumieniowanie w tym momencie.

To pole jest zawsze ustawione.

WriteResult

Wynik zastosowania zapisów.

Ten wynik i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

Timestamp

Czas realizacji zatwierdzenia. Każdy odczyt o wartości read_time lub większej jest gwarantowany, aby zobaczyć efekty zapisu.

Timestamp

Czas ostatniej aktualizacji dokumentu po zastosowaniu zapisu. Nie ustawiono po delete.

Jeśli zapis nie spowodował zmiany dokumentu, to jest to poprzedni czas aktualizacji.

Value

Wyniki zastosowania wszystkich elementów typu DocumentTransform.FieldTransform w tej samej kolejności.