Package google.firestore.v1

map<string, Value>

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

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

Value

Wartości w tablicy.

string

To pole jest 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 nie powiedzie się, jeśli którykolwiek z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną wykluczone.

DocumentMask

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.

bytes

Odczytywanie dokumentów w transakcji.

TransactionOptions

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie transakcja jest 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 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.

bytes

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

Timestamp

Godzina odczytu dokumentu. Wartość ta może rosnąć monologicznie. W tym przypadku na pewno poprzednie dokumenty w strumieniu wyników nie zmienią się między wartością read_time a tym wartością.

Document

Dokument, którego dotyczyło żądanie.

string

Podana nazwa dokumentu nie istnieje. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

Write

Zapisy do zastosowania.

Metoda nie stosuje się do zapisu atomowego i nie gwarantuje kolejności. Każdy zapis kończy się sukcesem lub niepowodzeniem. W danym żądaniu nie można zapisać w tym samym dokumencie więcej niż jeden raz.

map<string, string>

Etykiety powiązane z tym zapisem wsadowym.

WriteResult

Wynik zastosowania zapisów.

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

Status

Stan stosowania zapisów.

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

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

TransactionOptions

Opcje transakcji. Domyślnie jest to transakcja odczytu-zapisu.

bytes

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

bytes

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

int32

Liczba bitów ostatniego bajtu w argumencie bitmap, które mają być ignorowane jako „dopełnienie”. Jeśli długość elementu 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 kwiatów.

int32

Liczba haszów używanych przez algorytm.

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

Write

Zapisy do zastosowania.

Zawsze wykonywane atomowo i w kolejności.

bytes

Jeśli zasada jest skonfigurowana, stosuje i zatwierdza wszystkie zapisy w tej transakcji.

WriteResult

Wynik zastosowania zapisów.

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

Timestamp

Czas wystąpienia zatwierdzenia. Każdy odczyt o wartości read_time lub większej z gwarancji pokazuje efekty zatwierdzenia.

string

To pole jest 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

To pole jest wymagane. Identyfikator kolekcji względem listy parent. Przykład: chatrooms.

string

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

Opcjonalnie. Jeśli identyfikator nie zostanie podany, usługa go przypisze.

Document

To pole jest wymagane. Dokument do utworzenia. Nie można ustawić zasady name.

DocumentMask

Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

Jeśli dokument zawiera pole, którego nie ma w 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 w zapytaniu.

Może zawierać mniej wartości niż określona w klauzuli kolejności według klauzuli.

bool

Jeśli pozycja znajduje się tuż przed podanymi wartościami lub tuż po nich, w odniesieniu do kolejności sortowania zdefiniowanej przez zapytanie.

string

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

Precondition

Opcjonalny warunek wstępny w dokumencie. Żądanie nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku.

string

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

map<string, Value>

Timestamp

Tylko dane wyjściowe. Godzina utworzenia dokumentu.

Ta wartość rośnie monotonicznie, gdy dokument zostanie usunięty, a następnie ponownie utworzony. Można ją też porównywać z wartościami z innych dokumentów i z read_time zapytania.

Timestamp

Tylko dane wyjściowe. Godzina ostatniej modyfikacji dokumentu.

Początkowo ustawiana jest wartość create_time, a następnie rośnie monotonicznie z każdą zmianą w dokumencie. Można ją też porównywać z wartościami z innych dokumentów i z 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 elementów docelowych, które pasują do tego dokumentu.

int32

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

string

Nazwa usuniętego zasobu (Document).

int32

Zestaw identyfikatorów elementów docelowych, które wcześniej pasowały do tego elementu.

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 sekcji Document.fields.

string

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

int32

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

Timestamp

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

Co najmniej tyle samo co commit_time wartości 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 kolejności). To pole nie może być puste.

string

Ścieżka pola. Informacje o składni ścieżek pól znajdziesz w sekcji 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 wartość podwójnej precyzji. Jeśli pole nie jest liczbą całkowitą ani liczbą podwójną albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi wartość na określoną wartość. Jeśli jedna z podanych wartości lub bieżąca wartość pola to podwojenie, obie wartości zostaną zinterpretowane jako liczby podwójne. Podwójna arytmetyka i reprezentacja wartości podwójnych są zgodne z semantyką IEEE 754. W przypadku nadmiaru liczby dodatniej/ujemnej wartość w polu jest zwracana na największą dodatnią/ujemną liczbę całkowitą.

Value

Ustawia pole na maksymalną wartość spośród podanych nim i bieżących wartości.

Musi to być liczba całkowita lub wartość podwójnej precyzji. Jeśli pole nie jest liczbą całkowitą ani liczbą podwójną albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi wartość na określoną wartość. Jeśli zostanie zastosowana maksymalna operacja, gdy pole i wartość wejściowa są mieszane (jedną liczbą całkowitą, a drugą), pole przyjmuje typ większego argumentu. Jeśli operandy są równoważne (np. 3 i 3.0), pole się nie zmienia. 0, 0,0 i -0,0 mają wartość 0. Maksymalna liczba wartości przedpłaconych i zerowa wartość wejściowa to zawsze wartość przechowywana. Maksymalna wartość liczbowa x i NaN to NaN.

Value

Ustawia w polu minimalną wartość spośród jego bieżącej i podanej wartości.

Musi to być liczba całkowita lub wartość podwójnej precyzji. Jeśli pole nie jest liczbą całkowitą ani liczbą podwójną albo jeśli pole jeszcze nie istnieje, przekształcenie ustawi wartość na wartość wejściową. Jeśli zostanie zastosowana minimalna operacja, gdy pole i wartość wejściowa mają mieszany typ (tzn. jedna jest liczbą całkowitą, a druga podwójna), pole przyjmuje typ mniejszego argumentu. Jeśli operandy są równoważne (np. 3 i 3.0), pole się nie zmienia. 0, 0,0 i -0,0 mają wartość 0. Wartości minimalna: 0 wartości przedpłaconej i 0 wartości wejściowych to zawsze wartość przechowywana. Minimalną wartością liczbową x i NaN jest NaN.

ArrayValue

Jeśli nie ma ich w bieżącej wartości pola, dołącz podane elementy w kolejności. Jeśli pole nie jest tablicą lub jeśli pole jeszcze nie istnieje, jest najpierw ustawiane na pustą tablicę.

Równoważne liczby różnych typów (np. 3L i 3,0) są uważane za równe przy sprawdzaniu, czy brakuje jakiejś wartości. NaN jest równa NaN, a wartość null jest równa zero. Jeśli dane wejściowe zawierają wiele równoważnych wartości, tylko pierwsza z nich zostanie uwzględniona.

Odpowiednia wartość transform_result będzie wartością null.

ArrayValue

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

Równoważne liczby różnych typów (np. 3L i 3.0) są uważane za równe przy podejmowaniu decyzji o usunięciu elementu. NaN jest równa NaN, a wartość null jest równa zero. Spowoduje to usunięcie wszystkich równoważnych wartości, jeśli istnieją duplikaty.

Odpowiednia wartość transform_result będzie wartością null.

int64

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

Duration

Łączny czas wykonywania zapytania w backendzie.

int64

Łączna liczba płatnych operacji odczytu.

Struct

debugowanie statystyk wykonywania zapytania. Pamiętaj, że statystyki debugowania mogą się zmienić w miarę rozwoju Firestore. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

Identyfikator miejsca docelowego, do którego ma zastosowanie ten filtr.

int32

Łączna liczba dokumentów zgodnych z target_id.

Jeśli liczba pasujących dokumentów w kliencie jest inna niż liczba pasujących dokumentów, klient musi ręcznie określić, które dokumenty nie są już zgodne z elementem docelowym.

Aby to sprawdzić, klient może użyć filtra kwiatów unchanged_names, testując WSZYSTKIE nazwy dokumentów pod kątem filtra. Jeśli nazwa dokumentu NIE znajduje się w filtrze, dokument nie jest już zgodny z celem.

BloomFilter

Filtr kwiatów, który mimo swojej nazwy zawiera kodowanie UTF-8 nazw zasobów WSZYSTKICH dokumentów zgodnych z target_id, w formacie projects/{project_id}/databases/{database_id}/documents/{document_path}.

Serwer może pominąć ten filtr kwiatów według własnego uznania, na przykład jeśli uzna, że klient nie będzie z niego korzystać lub jeśli jego obliczenia są zbyt kosztowne pod względem obliczeń. Klienty muszą płynnie obsługiwać to pole, powracając do logiki stosowanej przed jego utworzeniem. Oznacza to, że ponownie dodaj środowisko docelowe bez tokena wznowienia, aby sprawdzić, które dokumenty w pamięci podręcznej klienta nie są zsynchronizowane.

PlanSummary

Informacje o etapie planowania dotyczące zapytania.

ExecutionStats

Zbiorcze statystyki wykonywania zapytania. Widoczny tylko wtedy, gdy zasada ExplainOptions.analyze ma wartość Prawda.

bool

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

Jeśli ustawisz wartość false (wartość domyślna), zapytanie będzie planowane i będzie zwracać tylko dane z etapów planowania.

Jeśli ma wartość true (prawda), zapytanie będzie planowane i wykonane, a zwrócone zostaną pełne wyniki zapytania wraz z danymi dotyczącymi etapu planowania i wykonania.

string

To pole jest wymagane. Nazwa zasobu dokumentu do pobrania. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

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

bytes

Odczytuje dokument w transakcji.

Timestamp

Odczytywanie wersji dokumentu w danym momencie.

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.

string

To pole jest 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. Musi to być wartość z ListCollectionIdsResponse.

Timestamp

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

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.

string

Identyfikatory kolekcji.

string

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

string

To pole jest 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 listy parent.

np. chatrooms lub messages.

Jest to opcjonalne. Jeśli jej nie podasz, Firestore wyświetli listę dokumentów ze wszystkich kolekcji w ramach podanego atrybutu parent.

int32

Opcjonalnie. Maksymalna liczba dokumentów zwracanych w jednej odpowiedzi.

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

string

Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi ListDocuments.

Podaj je, aby pobrać kolejną stronę. Podczas podziału na strony wszystkie pozostałe parametry (z wyjątkiem page_size) muszą odpowiadać wartościom ustawionym w żądaniu, które wygenerowało token strony.

string

Opcjonalnie. Opcjonalna kolejność zwracanych dokumentów.

Przykład: priority desc, __name__ desc.

Odzwierciedla to ORDER BY używane w zapytaniach Firestore, ale w postaci ciągu znaków. Jeśli go nie ma, dokumenty są uporządkowane na podstawie __name__ ASC.

DocumentMask

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.

bool

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

Żądania z atrybutem show_missing nie mogą mieć wartości where ani order_by.

bytes

Przeprowadź odczyt w ramach aktywnej transakcji.

Timestamp

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.

Document

Znalezione dokumenty.

string

Token pobierania następnej strony dokumentów.

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

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

map<string, string>

Etykiety powiązane z tą zmianą wartości docelowej.

Target

Cel, który ma zostać dodany do tego strumienia.

int32

Identyfikator celu, który ma zostać usunięty z tego strumienia.

TargetChange

Cele uległy zmianie.

DocumentChange

Zmieniono element: Document.

DocumentDelete

Element Document został usunięty.

DocumentRemove

Element Document został usunięty z celu (ponieważ nie jest już z nim odpowiedni).

ExistenceFilter

Filtr, który zostanie zastosowany 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.

Klucze mapy reprezentują nazwy pól. Nazwy pól pasujące do wyrażenia regularnego __.*__ są zastrzeżone. Zarezerwowane nazwy pól są niedozwolone z wyjątkiem określonych udokumentowanych kontekstów. Klucze mapy, oznaczone w formacie UTF-8, nie mogą mieć więcej niż 1500 bajtów i nie mogą być puste.

string

To pole jest 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.

Wartość może na przykład być o 1 mniejsza niż liczba równoległych zapytań do wykonania lub o 1 mniej niż w przypadku uruchomienia zadania potoku danych.

string

Wartość next_page_token zwrócona z poprzedniego wywołania do PartitionQuery, która może zostać użyta do uzyskania dodatkowego zestawu wyników. Nie ma gwarancji kolejności różnych zestawów wyników. Dlatego używanie wielu zestawów wyników wymaga scalenia ich 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 zbiór wyników uporządkowany w odniesieniu do wyników zapytania dostarczonego do PartitionQuery, należy scalać zbiory wyników: kursor A, kursor B, kursor M, kursor Q, kursor U, kursor W

int32

Maksymalna liczba partycji do zwrócenia w ramach tego wywołania (określana jako partition_count).

Jeśli na przykład partition_count = 10, a page_size = 8, pierwsze wywołanie PartitionQuery zwróci do 8 partycji i next_page_token, jeśli będzie ich więcej. Drugie wywołanie partycji spowoduje zwrócenie maksymalnie 2 partycji, co daje łącznie 10 podanych w zasadzie partition_count partycji.

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, limity, 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 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.

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 z użyciem tego samego zapytania, które zostało wysłane w odpowiedzi na to żądanie PartitionQuery. Kursory partycji będą uporządkowane zgodnie z tą samą kolejnością co wyniki zapytania dostarczonego do PartitionQuery.

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

• zapytanie, koniec_na A
• zapytanie, początek_od A, koniec_na B
• zapytanie, zaczynając_od B

Pusty wynik może oznaczać, że zapytanie ma zbyt mało wyników, aby go partycjonować, lub że zapytanie nie jest jeszcze obsługiwane w ramach partycjonowania.

string

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

Struct

Indeksy wybrane dla zapytania. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Jeśli zasada ma 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 w tym czasie być ostatnio zaktualizowany. Sygnatura czasowa musi być wyrównana w mikrosekundach.

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{project_id}/databases/{database_id}.

bytes

To pole jest wymagane. Transakcja do wycofania.

string

To pole jest 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 skonfigurowana, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania.

StructuredAggregationQuery

Zapytanie obejmujące agregację.

bytes

Uruchom agregację w ramach już aktywnej transakcji.

Wartością w tym polu jest nieprzejrzysty identyfikator transakcji, w ramach którego zostanie wykonane zapytanie.

TransactionOptions

Rozpoczyna nową transakcję w ramach zapytania. Domyślnie jest on ustawiony jako 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 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.

AggregationResult

Jeden wynik agregacji.

Brak w przypadku raportowania częściowego postępu.

bytes

Transakcja rozpoczęta w ramach tego żądania.

Występuje tylko w pierwszej odpowiedzi, gdy żądanie zażądało rozpoczęcia nowej transakcji.

Timestamp

Czas obliczenia wyniku zbiorczego. Ta wartość jest zawsze rosnąca monotonicznie. W tym przypadku poprzednia wartość AggregationResult w strumieniu wyników na pewno nie zmieniła się między wartością read_time a tym parametrem.

Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem read_time i żadnym atrybutem result, która określa czas wykonania zapytania.

ExplainMetrics

Zapytanie dotyczące wskaźników. Jest ona obecna tylko wtedy, gdy podano RunAggregationQueryRequest.explain_options i jest wysyłana tylko raz z ostatnią odpowiedzią w strumieniu.

string

To pole jest 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 skonfigurowana, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania.

StructuredQuery

Uporządkowane zapytanie.

bytes

Wykonaj zapytanie w ramach już aktywnej transakcji.

Wartością w tym polu jest nieprzejrzysty identyfikator transakcji, w ramach którego zostanie wykonane zapytanie.

TransactionOptions

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie transakcja jest 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 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.

bytes

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

Document

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

Timestamp

Godzina odczytu dokumentu. Ilość ta może rosnąć monotonicznie. W takim przypadku poprzednie dokumenty w strumieniu wyników na pewno nie będą zmieniać się między tym żądaniem a polem read_time.

Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem read_time i żadnym atrybutem document, która określa czas wykonania zapytania.

int32

Liczba wyników, które zostały pominięte z powodu opóźnienia między ostatnią odpowiedzią a bieżącą odpowiedzią.

ExplainMetrics

Zapytanie dotyczące wskaźników. Jest ona obecna tylko wtedy, gdy podano RunQueryRequest.explain_options i jest wysyłana tylko raz z ostatnią odpowiedzią w strumieniu.

bool

Jeśli usługa Firestore jest dostępna, żądanie zostało już całkowicie wykonane i żadne dokumenty nie będą zwracane.

Aggregation

Opcjonalnie. Seria agregacji do zastosowania do wyników funkcji structured_query.

Wymagane:

• Od 1 do 5 agregacji na zapytanie.

StructuredQuery

Zagnieżdżone uporządkowane zapytanie.

string

Opcjonalnie. Opcjonalna nazwa pola, w którym ma być przechowywany wynik agregacji.

Jeśli jej nie podasz, Firestore wybierze nazwę domyślną w formacie field_<incremental_id++>. Na 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.
• Przestrzegaj ograniczeń (document field name).

Count

Agregator liczników.

Sum

Agregator sum.

Avg

Przeciętny pośrednik.

FieldReference

Pole, na podstawie którego mają być agregowane dane.

Int64Value

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

Pozwala to ustawić górną granicę liczby dokumentów do skanowania, ograniczając czas oczekiwania i koszty.

Wartość nieokreślona jest interpretowana jako brak ograniczeń.

Przykład wysokiego poziomu:

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

Wymagane:

• Jeśli występuje, wartość musi być większa niż 0.

FieldReference

Pole, na podstawie którego mają być agregowane dane.

Projection

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

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

CollectionSelector

Kolekcje, których ma dotyczyć zapytanie.

Filter

Filtr, który ma zostać zastosowany.

Order

Kolejność zastosowania wyników zapytania.

Firestore umożliwia użytkownikom złożenie zamówienia w pełnej lub częściowej kolejności bądź w ogóle bez uporządkowania. We wszystkich przypadkach Firestore gwarantuje stabilne porządkowanie według tych reguł:

• order_by jest wymagany, aby odwoływać się do wszystkich pól używanych z filtrem nierówności.
• Wszystkie pola, które muszą się znaleźć w polu order_by, a które jeszcze nie istnieją, są dołączane w kolejności leksykograficznej nazw pól.
• Jeśli zamówienie w __name__ nie zostało określone, jest dołączane domyślnie.

Pola są dołączone z tym samym kierunkiem sortowania co w ostatnim podanym porządku lub „ASCENDING”, jeśli nie określono kolejności. Na 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 rozpoczyna się zapytanie.

Kolejność w zestawie wyników jest zgodna z klauzulą 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 kolumny (b ASC, __name__ ASC).

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

Nawiązując do powyższego przykładu, zastosowanie tych kursorów startowych może mieć 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): rozpoczęcie zapytania zaraz po a = 1 AND b > 10.

W odróżnieniu od metody OFFSET, która wymaga skanowania pierwszych N wyników do pominięcia, kursor początkowy umożliwia rozpoczęcie zapytania w pozycji logicznej. Pozycja nie jest wymagana do dopasowania do rzeczywistego wyniku. Spowoduje to skanowanie od tego miejsca do przodu, aby znaleźć następny dokument.

Wymagane:

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

Cursor

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

Funkcja jest podobna do START_AT, ale kontroluje pozycję końcową, a nie początkową.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określona 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:

• Jeśli została określona, wartość nie może być mniejsza niż 0.

Int32Value

Maksymalna liczba wyników do zwrócenia.

Ma zastosowanie po wszystkich innych ograniczeniach.

Wymagane:

• Jeśli została określona, wartość nie może być mniejsza niż 0.

FindNearest

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

Zostanie zastosowane po wszystkich innych filtrach i kolejności.

Znajduje wektory dystrybucyjne najbliżej danego wektora zapytania.

string

Identyfikator kolekcji. Po ustawieniu wybiera tylko kolekcje z tym identyfikatorem.

bool

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

Operator

Operator służący do łączenia wielu filtrów.

Filter

Lista filtrów do połączenia.

Wymagane:

• Dostępny 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 rozdzielonym kropkami (.) segmentów, przy czym każdy segment musi być 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

To pole jest wymagane. Zindeksowane pole wektorów do wyszukania. Mogą zostać zwrócone tylko dokumenty zawierające wektory, których wymiary pasują do parametru query_vector.

Value

To pole jest wymagane. Wektor zapytania, którego używamy do wyszukiwania. Wartość musi być wektorem o maksymalnie 2048 wymiarach.

DistanceMeasure

To pole jest wymagane. Wymagana miara odległości.

Int32Value

To pole jest wymagane. Liczba najbliższych sąsiadów do zwrócenia. Musi być dodatnią liczbą całkowitą nie większą niż 1000.

FieldReference

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

Direction

Kierunek, według którego należy sortować dane. Domyślna wartość to ASCENDING.

FieldReference

Pola do zwrócenia.

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

Operator

Operator jednoargumentowy do zastosowania.

FieldReference

Pole, do którego chcesz zastosować operator.

int32

Identyfikator elementu docelowego w strumieniu. Musi być liczbą dodatnią i różną od zera.

Jeśli target_id ma wartość 0 (lub nie jest określony), serwer przypisze identyfikator do tego celu i zwróci go w zdarzeniu TargetChange::ADD. Po dodaniu celu z parametrem target_id=0 wszystkie kolejne cele też muszą mieć target_id=0. Jeśli po dodaniu celu z parametrem target_id=0 do serwera zostanie wysłane żądanie AddTarget z 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 zwracanych w funkcji TargetChage.target_ids jest niezdefiniowana. Dlatego klient powinien podać identyfikator docelowy, zamiast czekać na jego przypisanie przez serwer.

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

bool

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

Int32Value

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

Ta wartość ma znaczenie tylko wtedy, gdy podano resume_type. Ta wartość jest obecna i ma więcej niż 0 sygnałów, że klient chce uwzględnić w odpowiedzi parametr ExistenceFilter.unchanged_names.

QueryTarget

Cel określony przez zapytanie.

DocumentsTarget

Miejsce docelowe określone przez zbiór nazw dokumentów.

bytes

Token wznowienia z poprzedniego elementu TargetChange dla identycznego celu.

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

Timestamp

Zacznij słuchać po określonej wartości read_time.

Klient musi znać stan dopasowania dokumentów.

string

Nazwy dokumentów do pobrania. W formacie: projects/{project_id}/databases/{database_id}/documents/{document_path}. Żądanie nie powiedzie się, jeśli którykolwiek z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną wykluczone.

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

Rodzaj wprowadzonej zmiany.

int32

Identyfikatory miejsc docelowych, które uległy zmianie.

Jeśli pole jest 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óry może być używany do wznawiania strumienia dla danego elementu target_ids lub wszystkich celów, jeśli target_ids jest pusty.

Nie ustawiono dla każdej zmiany wartości docelowej.

Timestamp

Spójna wartość read_time w przypadku danego elementu target_ids (pominięta, gdy elementy target_ids nie mają spójnego zrzutu).

Gwarantujemy, że strumień read_time z pole target_ids będzie pusty, gdy cały strumień osiągnie nowy spójny zrzut. Gwarantujemy, że wiadomości ADD, CURRENT i RESETUJ zostaną ostatecznie wygenerowane przez utworzenie nowego spójnego podsumowania. Wyjątkiem są wiadomości NO_CHANGE i REMOVE.

W przypadku danego strumienia wartość read_time na pewno będzie rosnąć monotonicznie.

ReadOnly

Transakcja może być używana tylko do operacji odczytu.

ReadWrite

Transakcja może być używana zarówno do odczytu, jak i zapisu.

Timestamp

Odczyt dokumentów w określonym czasie.

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.

bytes

Opcjonalna transakcja do ponowienia.

Document

To pole jest wymagane. Zaktualizowany dokument. Tworzy dokument, jeśli jeszcze nie istnieje.

DocumentMask

Pola do zaktualizowania. Żadne ścieżki pól w masce nie mogą zawierać zarezerwowanej nazwy.

Jeśli dokument istnieje na serwerze, a pola, do których nie odwołano się w masce, pozostają niezmienione. Pola, do których odwołuje się maska, ale nie występują w dokumencie wejściowym, są usuwane z dokumentu na serwerze.

DocumentMask

Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

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

Precondition

Opcjonalny warunek wstępny w dokumencie. Żądanie nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku.

NullValue

Wartość null.

bool

Wartość logiczna.

int64

Liczba całkowita.

double

Podwójna wartość.

Timestamp

Wartość sygnatury czasowej.

Dokładność pomiaru tylko w mikrosekundach. W przypadku przechowywania dodatkowa precyzja jest zaokrąglana w dół.

string

Wartość ciągu znaków.

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

bytes

Wartość w bajtach.

Nie może przekraczać 1 MiB do 89 bajtów. Zapytania uwzględniają tylko pierwsze 1500 bajtów.

string

Odniesienie do dokumentu. Przykład: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

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

ArrayValue

Wartość tablicy.

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

MapValue

Wartość mapy.

DocumentMask

Pola do zaktualizowania w tym zapisie.

To pole można skonfigurować 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 dokument na serwerze zawiera pola, których nie ma maska, pozostają one bez zmian. Pola, do których odwołuje się maska, ale nie występują 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 skonfigurować tylko wtedy, gdy operacja to update. Jeśli ten zapis jest obecny, jest on odpowiednikiem wykonania funkcji update i transform w tym samym dokumencie atomowo i w kolejności.

Precondition

Opcjonalny warunek wstępny w dokumencie.

Zapis nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku.

Document

Dokument do napisania.

string

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

DocumentTransform

Stosuje przekształcenie do dokumentu.

string

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

string

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

Write

Zapisy do zastosowania.

Zawsze wykonywane atomowo i w kolejności. To pole musi być puste przy pierwszym żądaniu. W ostatnim żądaniu może być puste. To pole nie może być puste w przypadku pozostałych żądań.

bytes

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

Klient powinien ustawić w tym polu token z ostatniego otrzymanego parametru WriteResponse. Jest to potwierdzenie, że klient otrzymał odpowiedzi przesłane na ten token. Po wysłaniu tego tokena wcześniejsze tokeny mogą nie być już używane.

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

Podczas tworzenia nowego strumienia pozostaw to pole nieskonfigurowane. Aby wznowić strumień w określonym momencie, skonfiguruj to pole oraz pole stream_id.

Podczas tworzenia nowego strumienia pozostaw to pole nieskonfigurowane.

map<string, string>

Etykiety powiązane z tym żądaniem zapisu.

string

Identyfikator strumienia. Ustawiona tylko w pierwszej wiadomości, gdy utworzono nowy strumień.

bytes

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

To pole jest zawsze ustawione.

WriteResult

Wynik zastosowania zapisów.

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

Timestamp

Czas wystąpienia zatwierdzenia. Gwarantujemy, że każdy odczyt o wartości read_time lub wyższej z udziału w odczytaniu będzie miał wpływ na zastosowanie zapisu.

Timestamp

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

Jeśli zapis nie spowodował zmiany dokumentu, będzie to poprzednia wartość update_time.

Value

Wyniki zastosowania każdego z elementów typu DocumentTransform.FieldTransform w tej samej kolejności.