Indeks
Firestore
(interfejs)AggregationResult
(komunikat)ArrayValue
(komunikat)BatchGetDocumentsRequest
(komunikat)BatchGetDocumentsResponse
(komunikat)BatchWriteRequest
(komunikat)BatchWriteResponse
(komunikat)BeginTransactionRequest
(komunikat)BeginTransactionResponse
(komunikat)BitSequence
(komunikat)BloomFilter
(komunikat)CommitRequest
(komunikat)CommitResponse
(komunikat)CreateDocumentRequest
(komunikat)Cursor
(komunikat)DeleteDocumentRequest
(komunikat)Document
(komunikat)DocumentChange
(komunikat)DocumentDelete
(komunikat)DocumentMask
(komunikat)DocumentRemove
(komunikat)DocumentTransform
(komunikat)DocumentTransform.FieldTransform
(komunikat)DocumentTransform.FieldTransform.ServerValue
(wyliczenie)ExecutionStats
(komunikat)ExistenceFilter
(komunikat)ExplainMetrics
(komunikat)ExplainOptions
(komunikat)GetDocumentRequest
(komunikat)ListCollectionIdsRequest
(komunikat)ListCollectionIdsResponse
(komunikat)ListDocumentsRequest
(komunikat)ListDocumentsResponse
(komunikat)ListenRequest
(komunikat)ListenResponse
(komunikat)MapValue
(komunikat)PartitionQueryRequest
(komunikat)PartitionQueryResponse
(komunikat)PlanSummary
(komunikat)Precondition
(komunikat)RollbackRequest
(komunikat)RunAggregationQueryRequest
(komunikat)RunAggregationQueryResponse
(komunikat)RunQueryRequest
(komunikat)RunQueryResponse
(komunikat)StructuredAggregationQuery
(komunikat)StructuredAggregationQuery.Aggregation
(komunikat)StructuredAggregationQuery.Aggregation.Avg
(komunikat)StructuredAggregationQuery.Aggregation.Count
(komunikat)StructuredAggregationQuery.Aggregation.Sum
(komunikat)StructuredQuery
(komunikat)StructuredQuery.CollectionSelector
(komunikat)StructuredQuery.CompositeFilter
(komunikat)StructuredQuery.CompositeFilter.Operator
(wyliczenie)StructuredQuery.Direction
(wyliczenie)StructuredQuery.FieldFilter
(komunikat)StructuredQuery.FieldFilter.Operator
(wyliczenie)StructuredQuery.FieldReference
(komunikat)StructuredQuery.Filter
(komunikat)StructuredQuery.FindNearest
(komunikat)StructuredQuery.FindNearest.DistanceMeasure
(wyliczenie)StructuredQuery.Order
(komunikat)StructuredQuery.Projection
(komunikat)StructuredQuery.UnaryFilter
(komunikat)StructuredQuery.UnaryFilter.Operator
(wyliczenie)Target
(komunikat)Target.DocumentsTarget
(komunikat)Target.QueryTarget
(komunikat)TargetChange
(komunikat)TargetChange.TargetChangeType
(wyliczenie)TransactionOptions
(komunikat)TransactionOptions.ReadOnly
(komunikat)TransactionOptions.ReadWrite
(komunikat)UpdateDocumentRequest
(komunikat)Value
(komunikat)Write
(komunikat)WriteRequest
(komunikat)WriteResponse
(komunikat)WriteResult
(komunikat)
Firestore
Usługa Cloud Firestore.
Cloud Firestore to szybka, w pełni zarządzana, bezserwerowa baza danych dokumentów NoSQL w chmurze, która upraszcza przechowywanie i synchronizowanie danych, a także wysyłanie do nich zapytań w przypadku aplikacji mobilnych, internetowych i IoT w skali globalnej. Biblioteki klienta zapewniają synchronizację na żywo i obsługę offline, a jego funkcje zabezpieczeń i integracje z Firebase i Google Cloud Platform przyspieszają tworzenie naprawdę bezserwerowych aplikacji.
BatchGetDocuments |
---|
Pobiera wiele dokumentów. Nie możemy zagwarantować, że dokumenty zwrócone przez tę metodę zostaną zwrócone w takiej kolejności, w jakiej były żądane.
|
BatchWrite |
---|
Stosuje grupę operacji zapisu. Metoda BatchWrite nie stosuje atomów do operacji zapisu i może je stosować w niewłaściwej kolejności. Metoda nie pozwala na więcej niż 1 zapis w dokumencie. Każdy zapis kończy się sukcesem lub niepowodzeniem. Informacje o stanie powodzenia każdego zapisu znajdziesz w sekcji Jeśli potrzebujesz zestawu zapisów stosowanych atomowo, użyj
|
BeginTransaction |
---|
Rozpoczyna nową transakcję.
|
Zatwierdź |
---|
Zatwierdzanie transakcji i opcjonalne aktualizowanie dokumentów.
|
CreateDocument |
---|
Tworzy nowy dokument.
|
DeleteDocument |
---|
Usuwa dokument.
|
GetDocument |
---|
Pobiera pojedynczy dokument.
|
ListCollectionIds |
---|
Wyświetla listę wszystkich identyfikatorów kolekcji pod dokumentem.
|
ListDocuments |
---|
Wyświetla listę dokumentów.
|
Posłuchaj |
---|
Wykrywa zmiany. Ta metoda jest dostępna tylko przez gRPC lub WebChannel (nie REST).
|
PartitionQuery |
---|
Partycjonuje zapytanie przez zwrócenie kursorów partycji, których można używać do równoległego wykonywania zapytania. Zwrócone kursory partycji to punkty podziału, których RunQuery może używać jako punktów początkowych i końcowych wyników zapytania.
|
Przywróć |
---|
Wycofuje transakcję.
|
RunAggregationQuery |
---|
Uruchamia zapytanie agregacji. Zamiast generować wyniki Przykład wysokiego poziomu:
|
RunQuery |
---|
Uruchamia zapytanie.
|
UpdateDocument |
---|
Aktualizuje lub wstawia dokument.
|
Zapis |
---|
Strumieniowo przesyła w kolejności partie aktualizacji i usuwania dokumentów. Ta metoda jest dostępna tylko przez gRPC lub WebChannel (nie REST).
|
AggregationResult
Wynik pojedynczego zasobnika z zapytania agregacji Firestore.
Klucze funkcji aggregate_fields
są takie same dla wszystkich wyników zapytania agregacji w przeciwieństwie do zapytań dotyczących dokumentów, które dla każdego wyniku mogą mieć inne pola.
Pola | |
---|---|
aggregate_fields |
Wynik funkcji agregacji, np. Klucz to |
ArrayValue
Wartość tablicy.
Pola | |
---|---|
values[] |
Wartości w tablicy. |
BatchGetDocumentsRequest
Prośba dotycząca: Firestore.BatchGetDocuments
.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
documents[] |
Nazwy dokumentów do pobrania. W formacie: |
mask |
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. |
Pole 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 być tylko jedną z tych wartości: |
|
transaction |
Odczytywanie dokumentów w transakcji. |
new_transaction |
Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie transakcja jest tylko do odczytu. Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu. |
read_time |
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. |
BatchGetDocumentsResponse
Przesłana odpowiedź przesłana strumieniowo dla użytkownika Firestore.BatchGetDocuments
.
Pola | |
---|---|
transaction |
Transakcja rozpoczęta w ramach tego żądania. Zostanie ustawiona tylko w pierwszej odpowiedzi i tylko wtedy, gdy w żądaniu ustawiono parametr |
read_time |
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ą. |
Pole sumy result . Jeden wynik. To pole może być puste, jeśli serwer tylko zwraca transakcję. result może być tylko jedną z tych wartości: |
|
found |
Dokument, którego dotyczyło żądanie. |
missing |
Podana nazwa dokumentu nie istnieje. W formacie: |
BatchWriteRequest
Prośba dotycząca: Firestore.BatchWrite
.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
writes[] |
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. |
labels |
Etykiety powiązane z tym zapisem wsadowym. |
BatchWriteResponse
Odpowiedź od użytkownika Firestore.BatchWrite
.
Pola | |
---|---|
write_results[] |
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. |
BeginTransactionRequest
Prośba dotycząca: Firestore.BeginTransaction
.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
options |
Opcje transakcji. Domyślnie jest to transakcja odczytu-zapisu. |
BeginTransactionResponse
Odpowiedź dotycząca: Firestore.BeginTransaction
.
Pola | |
---|---|
transaction |
Transakcja, która została rozpoczęta. |
BitSequence
Sekwencja bitów zakodowana w tablicy bajtów.
Każdy bajt w tablicy bajtów bitmap
przechowuje 8 bitów sekwencji. Jedynym wyjątkiem jest ostatni bajt, który może przechowywać do 8 lub mniej bitów. Pole padding
określa liczbę bitów ostatniego bajtu, które mają być ignorowane jako „dopełnienie”. Wartości tych bitów „dopełnienie” są nieokreślone i należy je zignorować.
Aby pobrać pierwszy bit (bit 0), wykonaj obliczenia: (bitmap[0] & 0x01) != 0
. Aby pobrać drugi bit (bit 1), wykonaj obliczenia: (bitmap[0] & 0x02) != 0
. Aby pobrać trzeci bit, czyli bit 2, wykonaj obliczenia: (bitmap[0] & 0x04) != 0
. Aby pobrać czwarty bit (bit 3), wykonaj obliczenia: (bitmap[0] & 0x08) != 0
. Aby pobrać bit n, wykonaj obliczenia: (bitmap[n / 8] & (0x01 << (n % 8))) != 0
.
„Rozmiar” elementu BitSequence
(liczba zawartych w nim bitów) jest obliczany według tego wzoru: (bitmap.length * 8) - padding
.
Pola | |
---|---|
bitmap |
Bajty, które kodują sekwencję bitów. Może mieć długość zero. |
padding |
Liczba bitów ostatniego bajtu w argumencie |
BloomFilter
Filtr kwiatów (https://en.wikipedia.org/wiki/Bloom_filter).
Filtr Blooma szyfruje wpisy za pomocą MD5 i traktuje wynikowy 128-bitowy hasz jako 2 różne 64-bitowe wartości skrótu, interpretowane jako liczby całkowite bez znaku przy użyciu kodowania uzupełniającego 2.
Te 2 wartości skrótu, o nazwach h1
i h2
, są następnie używane do obliczania wartości skrótu hash_count
za pomocą formuły, zaczynając od i=0
:
h(i) = h1 + (i * h2)
Otrzymane wartości są następnie modyfikowane przez liczbę bitów w filtrze kwiatu w celu pobrania bitów filtra rozkwitu do przetestowania dla danego wpisu.
Pola | |
---|---|
bits |
Dane filtra kwiatów. |
hash_count |
Liczba haszów używanych przez algorytm. |
CommitRequest
Prośba dotycząca: Firestore.Commit
.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
writes[] |
Zapisy do zastosowania. Zawsze wykonywane atomowo i w kolejności. |
transaction |
Jeśli zasada jest skonfigurowana, stosuje i zatwierdza wszystkie zapisy w tej transakcji. |
CommitResponse
Odpowiedź dotycząca: Firestore.Commit
.
Pola | |
---|---|
write_results[] |
Wynik zastosowania zapisów. Ten i-ty wynik zapisu odpowiada i-temu zapisowi w żądaniu. |
commit_time |
Czas wystąpienia zatwierdzenia. Każdy odczyt o wartości |
CreateDocumentRequest
Prośba dotycząca: Firestore.CreateDocument
.
Pola | |
---|---|
parent |
To pole jest wymagane. Zasób nadrzędny. Na przykład: |
collection_id |
To pole jest wymagane. Identyfikator kolekcji względem listy |
document_id |
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 |
mask |
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. |
Kursor
Pozycja w zestawie wyników zapytania.
Pola | |
---|---|
values[] |
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. |
before |
Jeśli pozycja znajduje się tuż przed podanymi wartościami lub tuż po nich, w odniesieniu do kolejności sortowania zdefiniowanej przez zapytanie. |
DeleteDocumentRequest
Prośba dotycząca: Firestore.DeleteDocument
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa zasobu dokumentu do usunięcia. W formacie: |
current_document |
Opcjonalny warunek wstępny w dokumencie. Żądanie nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku. |
Dokumenty
Dokument Firestore.
Nie może przekraczać 1 MiB do 4 bajtów.
Pola | |
---|---|
name |
Nazwa zasobu dokumentu, na przykład |
fields |
|
create_time |
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 |
update_time |
Tylko dane wyjściowe. Godzina ostatniej modyfikacji dokumentu. Początkowo ustawiana jest wartość |
DocumentChange
Zmieniono element: Document
.
Może to być wynikiem wielu czynności writes
, w tym usunięć, które ostatecznie skutkowały nową wartością parametru Document
.
Jeśli ta sama zmiana logiczna ma wpływ na wiele komunikatów DocumentChange
, może ona zostać zwrócona.
Pola | |
---|---|
document |
Nowy stan: Jeśli ustawiona jest wartość |
target_ids[] |
Zestaw identyfikatorów elementów docelowych, które pasują do tego dokumentu. |
removed_target_ids[] |
Zestaw identyfikatorów elementów docelowych, które nie pasują już do tego dokumentu. |
DocumentDelete
Element Document
został usunięty.
Może to być spowodowane wieloma procesami writes
, łącznie z aktualizacjami, z których ostatnia usunięto Document
.
Jeśli problem dotyczy wielu wiadomości docelowych, to samo usunięcie logiczne może spowodować zwrócenie wielu wiadomości DocumentDelete
.
Pola | |
---|---|
document |
Nazwa usuniętego zasobu ( |
removed_target_ids[] |
Zestaw identyfikatorów elementów docelowych, które wcześniej pasowały do tego elementu. |
read_time |
Sygnatura czasowa odczytu, w którym zaobserwowano usunięcie. Większe lub równe |
DocumentMask
Zbiór ścieżek pól w dokumencie. Służy do ograniczania operacji pobierania lub aktualizacji dokumentu do podzbioru jego pól. Różni się od standardowych masek pól, ponieważ zawsze jest ograniczony do Document
i uwzględnia dynamiczny charakter obiektu Value
.
Pola | |
---|---|
field_paths[] |
Lista ścieżek pól w masce. Informacje o składni ścieżek pól znajdziesz w sekcji |
DocumentRemove
Element Document
został usunięty z widoku celów.
Wysyłane, jeśli dokument nie jest już odpowiedni dla obiektu docelowego i nie jest już widoczny. Można ją wysłać zamiast metody DocumentDelete lub DocumentChange, jeśli serwer nie może wysłać nowej wartości dokumentu.
Jeśli problem ma wpływ na wiele wiadomości docelowych, podczas tego samego zapisu lub usuwania logicznego może zostać zwróconych wiele wiadomości DocumentRemove
.
Pola | |
---|---|
document |
Nazwa zasobu zasobu |
removed_target_ids[] |
Zestaw identyfikatorów elementów docelowych, które wcześniej pasowały do tego dokumentu. |
read_time |
Sygnatura czasowa odczytu, w którym zaobserwowano usunięcie. Co najmniej tyle samo co |
DocumentTransform
Przekształcenie dokumentu.
Pola | |
---|---|
document |
Nazwa dokumentu do przekształcenia. |
field_transforms[] |
Lista przekształceń, które mają zostać zastosowane do pól dokumentu (w kolejności). To pole nie może być puste. |
FieldTransform
Przekształcenie pola dokumentu.
Pola | |
---|---|
field_path |
Ścieżka pola. Informacje o składni ścieżek pól znajdziesz w sekcji |
Pole sumy transform_type . Przekształcenie do zastosowania w polu. transform_type może być tylko jedną z tych wartości: |
|
set_to_server_value |
Ustawia w polu podaną wartość serwera. |
increment |
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ą. |
maximum |
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. |
minimum |
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. |
append_missing_elements |
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. |
remove_all_from_array |
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. |
ServerValue
Wartość obliczana przez serwer.
Wartości w polu enum | |
---|---|
SERVER_VALUE_UNSPECIFIED |
Nie określono. Tej wartości nie można używać. |
REQUEST_TIME |
Czas, w którym serwer przetworzył żądanie, z dokładnością do milisekundy. Jeśli transakcji użyjesz w kilku polach (tym samym lub różnych dokumentach), wszystkie te pola otrzymają tę samą sygnaturę czasową serwera. |
ExecutionStats
Statystyki wykonywania zapytania.
Pola | |
---|---|
results_returned |
Łączna liczba zwróconych wyników, w tym dokumentów, prognoz, wyników agregacji i kluczy. |
execution_duration |
Łączny czas wykonywania zapytania w backendzie. |
read_operations |
Łączna liczba płatnych operacji odczytu. |
debug_stats |
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" } } |
ExistenceFilter
Podsumowanie wszystkich dokumentów pasujących do danego elementu docelowego.
Pola | |
---|---|
target_id |
Identyfikator miejsca docelowego, do którego ma zastosowanie ten filtr. |
count |
Łączna liczba dokumentów zgodnych z 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 |
Filtr kwiatów, który mimo swojej nazwy zawiera kodowanie UTF-8 nazw zasobów WSZYSTKICH dokumentów zgodnych z 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. |
ExplainMetrics
Wyjaśnij dane dla zapytania.
Pola | |
---|---|
plan_summary |
Informacje o etapie planowania dotyczące zapytania. |
execution_stats |
Zbiorcze statystyki wykonywania zapytania. Widoczny tylko wtedy, gdy zasada |
ExplainOptions
Wyjaśnij opcje zapytania.
Pola | |
---|---|
analyze |
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. |
GetDocumentRequest
Prośba dotycząca: Firestore.GetDocument
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa zasobu dokumentu do pobrania. W formacie: |
mask |
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. |
Pole 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 być tylko jedną z tych wartości: |
|
transaction |
Odczytuje dokument w transakcji. |
read_time |
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. |
ListCollectionIdsRequest
Prośba dotycząca: Firestore.ListCollectionIds
.
Pola | |
---|---|
parent |
To pole jest wymagane. Dokument nadrzędny. W formacie: |
page_size |
Maksymalna liczba wyników do zwrócenia. |
page_token |
Token strony. Musi to być wartość z |
Pole sumy consistency_selector . Tryb spójności dla tego żądania. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może być tylko jedną z tych wartości: |
|
read_time |
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. |
ListCollectionIdsResponse
Odpowiedź od użytkownika Firestore.ListCollectionIds
.
Pola | |
---|---|
collection_ids[] |
Identyfikatory kolekcji. |
next_page_token |
Token strony, który może służyć do kontynuowania listy. |
ListDocumentsRequest
Prośba dotycząca: Firestore.ListDocuments
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa zasobu nadrzędnego. W formacie Na przykład: |
collection_id |
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 |
page_size |
Opcjonalnie. Maksymalna liczba dokumentów zwracanych w jednej odpowiedzi. Firestore może zwrócić mniej niż ta wartość. |
page_token |
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 |
order_by |
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. |
show_missing |
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 |
Pole 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 być tylko jedną z tych wartości: |
|
transaction |
Przeprowadź odczyt w ramach aktywnej transakcji. |
read_time |
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. |
ListDocumentsResponse
Odpowiedź dotycząca: Firestore.ListDocuments
.
Pola | |
---|---|
documents[] |
Znalezione dokumenty. |
next_page_token |
Token pobierania następnej strony dokumentów. Jeśli pominiesz to pole, nie będzie kolejnych stron. |
ListenRequest
Prośba dotycząca: Firestore.Listen
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
labels |
Etykiety powiązane z tą zmianą wartości docelowej. |
Pole sumy target_change . Zmienia się obsługiwana wartość docelowa. target_change może być tylko jedną z tych wartości: |
|
add_target |
Cel, który ma zostać dodany do tego strumienia. |
remove_target |
Identyfikator celu, który ma zostać usunięty z tego strumienia. |
ListenResponse
Odpowiedź dotycząca: Firestore.Listen
.
Pola | |
---|---|
Pole sumy response_type . Obsługiwane odpowiedzi. response_type może być tylko jedną z tych wartości: |
|
target_change |
Cele uległy zmianie. |
document_change |
Zmieniono element: |
document_delete |
Element |
document_remove |
Element |
filter |
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. |
MapValue
Wartość mapy.
Pola | |
---|---|
fields |
Pola mapy. Klucze mapy reprezentują nazwy pól. Nazwy pól pasujące do wyrażenia regularnego |
PartitionQueryRequest
Prośba dotycząca: Firestore.PartitionQuery
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa zasobu nadrzędnego. W formacie: |
partition_count |
Żą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. |
page_token |
Wartość Na przykład 2 kolejne wywołania z użyciem parametru page_token mogą zwrócić:
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 |
page_size |
Maksymalna liczba partycji do zwrócenia w ramach tego wywołania (określana jako Jeśli na przykład |
Pole sumy query_type . Zapytanie do partycjonowania. query_type może być tylko jedną z tych wartości: |
|
structured_query |
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. |
Pole sumy consistency_selector . Tryb spójności dla tego żądania. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może być tylko jedną z tych wartości: |
|
read_time |
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. |
PartitionQueryResponse
Odpowiedź dotycząca: Firestore.PartitionQuery
.
Pola | |
---|---|
partitions[] |
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:
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. |
next_page_token |
Token strony, który może być używany do żądania dodatkowego zestawu wyników, do wartości określonej w polu |
PlanSummary
Informacje o etapie planowania dotyczące zapytania.
Pola | |
---|---|
indexes_used[] |
Indeksy wybrane dla zapytania. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
Warunek wstępny
Warunek wstępny w dokumencie używany w operacjach warunkowych.
Pola | |
---|---|
Pole sumy condition_type . Typ warunku wstępnego. condition_type może być tylko jedną z tych wartości: |
|
exists |
Jeśli zasada ma wartość |
update_time |
Jeśli jest ustawiony, dokument docelowy musi istnieć i w tym czasie być ostatnio zaktualizowany. Sygnatura czasowa musi być wyrównana w mikrosekundach. |
RollbackRequest
Prośba dotycząca: Firestore.Rollback
.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
transaction |
To pole jest wymagane. Transakcja do wycofania. |
RunAggregationQueryRequest
Prośba dotycząca: Firestore.RunAggregationQuery
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa zasobu nadrzędnego. W formacie |
explain_options |
Opcjonalnie. Wyjaśnij opcje zapytania. Jeśli jest skonfigurowana, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania. |
Pole sumy query_type . Zapytanie do wykonania. query_type może być tylko jedną z tych wartości: |
|
structured_aggregation_query |
Zapytanie obejmujące agregację. |
Pole sumy consistency_selector . Tryb spójności zapytania domyślnie ustawia silną spójność. consistency_selector może być tylko jedną z tych wartości: |
|
transaction |
Uruchom agregację w ramach już aktywnej transakcji. Wartością w tym polu jest nieprzejrzysty identyfikator transakcji, w ramach którego zostanie wykonane zapytanie. |
new_transaction |
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. |
read_time |
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. |
RunAggregationQueryResponse
Odpowiedź dotycząca: Firestore.RunAggregationQuery
.
Pola | |
---|---|
result |
Jeden wynik agregacji. Brak w przypadku raportowania częściowego postępu. |
transaction |
Transakcja rozpoczęta w ramach tego żądania. Występuje tylko w pierwszej odpowiedzi, gdy żądanie zażądało rozpoczęcia nowej transakcji. |
read_time |
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ą Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem |
explain_metrics |
Zapytanie dotyczące wskaźników. Jest ona obecna tylko wtedy, gdy podano |
RunQueryRequest
Prośba dotycząca: Firestore.RunQuery
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa zasobu nadrzędnego. W formacie |
explain_options |
Opcjonalnie. Wyjaśnij opcje zapytania. Jeśli jest skonfigurowana, zwracane są dodatkowe statystyki zapytań. W przeciwnym razie zwracane będą tylko wyniki zapytania. |
Pole sumy query_type . Zapytanie do wykonania. query_type może być tylko jedną z tych wartości: |
|
structured_query |
Uporządkowane zapytanie. |
Pole 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 być tylko jedną z tych wartości: |
|
transaction |
Wykonaj zapytanie w ramach już aktywnej transakcji. Wartością w tym polu jest nieprzejrzysty identyfikator transakcji, w ramach którego zostanie wykonane zapytanie. |
new_transaction |
Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie transakcja jest tylko do odczytu. Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu. |
read_time |
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. |
RunQueryResponse
Odpowiedź dotycząca: Firestore.RunQuery
.
Pola | |
---|---|
transaction |
Transakcja rozpoczęta w ramach tego żądania. Można go ustawić tylko w pierwszej odpowiedzi i tylko wtedy, gdy w żądaniu określono |
document |
Wynik zapytania, który nie jest ustawiony podczas raportowania częściowego postępu. |
read_time |
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 Jeśli zapytanie nie zwróci żadnych wyników, zostanie wysłana odpowiedź z parametrem |
skipped_results |
Liczba wyników, które zostały pominięte z powodu opóźnienia między ostatnią odpowiedzią a bieżącą odpowiedzią. |
explain_metrics |
Zapytanie dotyczące wskaźników. Jest ona obecna tylko wtedy, gdy podano |
Pole sumy continuation_selector . Tryb kontynuacji zapytania. Jeśli ta opcja jest dostępna, oznacza to, że bieżący strumień odpowiedzi na zapytanie zakończył się. To ustawienie można ustawić z parametrem document lub bez niego, ale po ustawieniu tego ustawienia żadne wyniki nie będą wyświetlane. continuation_selector może być tylko jedną z tych wartości: |
|
done |
Jeśli usługa Firestore jest dostępna, żądanie zostało już całkowicie wykonane i żadne dokumenty nie będą zwracane. |
StructuredAggregationQuery
Zapytanie Firestore dotyczące uruchomienia agregacji w obiekcie StructuredQuery
.
Pola | |
---|---|
aggregations[] |
Opcjonalnie. Seria agregacji do zastosowania do wyników funkcji Wymagane:
|
Pole sumy query_type . Podstawowe zapytanie, na podstawie którego następuje agregacja. query_type może być tylko jedną z tych wartości: |
|
structured_query |
Zagnieżdżone uporządkowane zapytanie. |
Agregacja
Definiuje agregację, która daje jeden wynik.
Pola | |
---|---|
alias |
Opcjonalnie. Opcjonalna nazwa pola, w którym ma być przechowywany wynik agregacji. Jeśli jej nie podasz, Firestore wybierze nazwę domyślną w formacie
zmienia się w:
Wymagane:
|
Pole sumy operator . Wymagany typ agregacji do przeprowadzenia. operator może być tylko jedną z tych wartości: |
|
count |
Agregator liczników. |
sum |
Agregator sum. |
avg |
Przeciętny pośrednik. |
Śr.
Średnia z wartości żądanego pola.
Agregowane zostaną tylko wartości liczbowe. Wszystkie wartości nieliczbowe, w tym
NULL
, są pomijane.Jeśli wartości zbiorcze zawierają
NaN
, zwracaNaN
. Infinity Math jest zgodny ze standardami IEEE-754.Jeśli zbiór wartości zagregowanych jest pusty, zwraca
NULL
.Zawsze zwraca wynik jako liczbę zmiennoprzecinkową.
Pola | |
---|---|
field |
Pole, na podstawie którego mają być agregowane dane. |
Liczba
Liczba dokumentów pasujących do zapytania.
Funkcja agregacji COUNT(*)
działa w obrębie całego dokumentu, więc nie wymaga odwołania do pola.
Pola | |
---|---|
up_to |
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:
Wymagane:
|
Suma
Suma wartości żądanego pola.
Agregowane zostaną tylko wartości liczbowe. Wszystkie wartości nieliczbowe, w tym
NULL
, są pomijane.Jeśli wartości zbiorcze zawierają
NaN
, zwracaNaN
. Infinity Math jest zgodny ze standardami IEEE-754.Jeśli zestaw wartości zagregowanych jest pusty, zwraca wartość 0.
Zwraca 64-bitową liczbę całkowitą, jeśli wszystkie zagregowane liczby są liczbami całkowitymi, a wynik sumy nie przekracza. W przeciwnym razie wynik jest zwracany jako liczba zmiennoprzecinkowa. Pamiętaj, że nawet jeśli wszystkie zagregowane wartości są liczbami całkowitymi, to wynik jest zwracany jako liczba zmiennoprzecinkowa, jeśli nie mieści się on w 64-bitowej ze znakiem. W takim przypadku zwrócona wartość straci precyzję.
W takim przypadku agregacja liczb zmiennoprzecinkowych nie jest deterministyczna. Oznacza to, że wielokrotne wykonywanie tego samego zapytania bez wprowadzania zmian w wartościach bazowych może za każdym razem przynieść nieco inne wyniki. W takich przypadkach wartości należy przechowywać jako liczby całkowite zamiast liczb zmiennoprzecinkowych.
Pola | |
---|---|
field |
Pole, na podstawie którego mają być agregowane dane. |
StructuredQuery
Zapytanie Firestore.
Etapy zapytania są wykonywane w następującej kolejności: 1. od 2, gdzie 3. wybierz 4. order_by + start_at + end_at 5. przesunięcie 6. limit
Pola | |
---|---|
select |
Opcjonalny podzbiór pól do zwrócenia. Działa jako |
from[] |
Kolekcje, których ma dotyczyć zapytanie. |
where |
Filtr, który ma zostać zastosowany. |
order_by[] |
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ł:
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:
|
start_at |
Potencjalny prefiks pozycji w zestawie wyników, od której rozpoczyna się zapytanie. Kolejność w zestawie wyników jest zgodna z klauzulą
Wyniki tego zapytania są uporządkowane według kolumny 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 Nawiązując do powyższego przykładu, zastosowanie tych kursorów startowych może mieć różny wpływ:
W odróżnieniu od metody Wymagane:
|
end_at |
Potencjalny prefiks pozycji w zestawie wyników, na której kończy się zapytanie. Funkcja jest podobna do Wymagane:
|
offset |
Liczba dokumentów do pominięcia przed zwróceniem pierwszego wyniku. Ma to zastosowanie po ograniczeniach określonych przez Wymagane:
|
limit |
Maksymalna liczba wyników do zwrócenia. Ma zastosowanie po wszystkich innych ograniczeniach. Wymagane:
|
find_nearest |
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. |
CollectionSelector
Wybór kolekcji, na przykład messages as m1
.
Pola | |
---|---|
collection_id |
Identyfikator kolekcji. Po ustawieniu wybiera tylko kolekcje z tym identyfikatorem. |
all_descendants |
Jeśli zasada ma wartość Fałsz, wybiera tylko te kolekcje, które są bezpośrednimi elementami podrzędnymi w elemencie |
CompositeFilter
filtr, który łączy wiele innych filtrów za pomocą podanego operatora;
Pola | |
---|---|
op |
Operator służący do łączenia wielu filtrów. |
filters[] |
Lista filtrów do połączenia. Wymagane:
|
Operator
Operator filtra złożonego.
Wartości w polu enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nie określono. Tej wartości nie można używać. |
AND |
Dokumenty są wymagane w przypadku wszystkich połączonych filtrów. |
OR |
Dokumenty są wymagane w przypadku co najmniej jednego z połączonych filtrów. |
Kierunek
Kierunek sortowania.
Wartości w polu enum | |
---|---|
DIRECTION_UNSPECIFIED |
Nie określono. |
ASCENDING |
Rosnąco. |
DESCENDING |
Malejąco. |
FieldFilter
Filtr konkretnego pola.
Pola | |
---|---|
field |
Pole, według którego chcesz filtrować. |
op |
Operator, według którego chcesz filtrować. |
value |
Wartość do porównania. |
Operator
Operator filtra pól.
Wartości w polu enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nie określono. Tej wartości nie można używać. |
LESS_THAN |
Podana wartość Wymagane:
|
LESS_THAN_OR_EQUAL |
Podana wartość Wymagane:
|
GREATER_THAN |
Podana wartość Wymagane:
|
GREATER_THAN_OR_EQUAL |
Podana wartość Wymagane:
|
EQUAL |
Wartość field jest równa wartości value . |
NOT_EQUAL |
Wartość Wymagane:
|
ARRAY_CONTAINS |
Podana tablica field to tablica, która zawiera podany element value . |
IN |
Podana wartość Wymagane:
|
ARRAY_CONTAINS_ANY |
Podana tablica Wymagane:
|
NOT_IN |
Wartości Wymagane:
|
FieldReference
Odwołanie do pola w dokumencie, np. stats.operations
.
Pola | |
---|---|
field_path |
Odwołanie do pola w dokumencie. Wymagane:
|
Filtruj
Filtr.
Pola | |
---|---|
Pole sumy filter_type . Typ filtra. filter_type może być tylko jedną z tych wartości: |
|
composite_filter |
Filtr złożony. |
field_filter |
Filtr w polu dokumentu. |
unary_filter |
Filtr, który przyjmuje dokładnie 1 argument. |
FindNearest
Konfiguracja wyszukiwania Najbliższych sąsiadów.
Pola | |
---|---|
vector_field |
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. |
query_vector |
To pole jest wymagane. Wektor zapytania, którego używamy do wyszukiwania. Wartość musi być wektorem o maksymalnie 2048 wymiarach. |
distance_measure |
To pole jest wymagane. Wymagana miara odległości. |
limit |
To pole jest wymagane. Liczba najbliższych sąsiadów do zwrócenia. Musi być dodatnią liczbą całkowitą nie większą niż 1000. |
DistanceMeasure
Miara odległości używana przy porównywaniu wektorów.
Wartości w polu enum | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
Nie należy go ustawiać. |
EUCLIDEAN |
Mierzy odległość UECLIDEAN między wektorami. Zobacz euklidesowy, aby dowiedzieć się więcej. |
COSINE |
Porównuje wektory na podstawie kąta między nimi, co pozwala zmierzyć podobieństwo, które nie jest oparte na wielkości wektorów. Zalecamy używanie funkcji DOT_PRODUCT ze znormalizowanymi wektorami jednostowymi zamiast odległości COSINE, ponieważ jest to odpowiednik matematyczny z lepszą wydajnością. Więcej informacji znajdziesz w sekcji Podobieństwo cosinusowe. |
DOT_PRODUCT |
Działa podobnie jak cosinus, ale jest zależna od wielkości wektorów. Więcej informacji znajdziesz w sekcji Iloczyn skalarny. |
Zamówienie
Zamówienie na polu.
Pola | |
---|---|
field |
Pole, według którego chcesz sortować. |
direction |
Kierunek, według którego należy sortować dane. Domyślna wartość to |
Odwzorowanie
Odwzorowanie pól dokumentu do zwrócenia.
Pola | |
---|---|
fields[] |
Pola do zwrócenia. Jeśli jest puste, zwracane są wszystkie pola. Aby zwrócić tylko nazwę dokumentu, użyj funkcji |
UnaryFilter
Filtr z 1 operandem.
Pola | |
---|---|
op |
Operator jednoargumentowy do zastosowania. |
Pole sumy operand_type . Argument filtra. operand_type może być tylko jedną z tych wartości: |
|
field |
Pole, do którego chcesz zastosować operator. |
Operator
Operator jednoargumentowy.
Wartości w polu enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nie określono. Tej wartości nie można używać. |
IS_NAN |
Podana wartość field jest równa NaN . |
IS_NULL |
Podana wartość field jest równa NULL . |
IS_NOT_NAN |
Podana wartość Wymagane:
|
IS_NOT_NULL |
Podana wartość Wymagane:
|
Cel
Specyfikacja zestawu dokumentów do nasłuchiwania.
Pola | |
---|---|
target_id |
Identyfikator elementu docelowego w strumieniu. Musi być liczbą dodatnią i różną od zera. Jeśli Pamiętaj, że jeśli klient wysyła wiele żądań Jeśli |
once |
Czy cel powinien zostać usunięty, gdy jest aktualny i spójny. |
expected_count |
Liczba dokumentów, które ostatnio pasowały do zapytania w tokenie wznawiania lub czasie odczytu. Ta wartość ma znaczenie tylko wtedy, gdy podano |
Pole sumy target_type . Typ celu, którego ma dotyczyć nasłuchiwanie. target_type może być tylko jedną z tych wartości: |
|
query |
Cel określony przez zapytanie. |
documents |
Miejsce docelowe określone przez zbiór nazw dokumentów. |
Pole sumy Jeśli zostanie określony, zwracane będą tylko pasujące dokumenty, które zostały zaktualizowane PO |
|
resume_token |
Token wznowienia z poprzedniego elementu Użycie tokena wznowienia z innym miejscem docelowym nie jest obsługiwane i może się nie powieść. |
read_time |
Zacznij słuchać po określonej wartości Klient musi znać stan dopasowania dokumentów. |
DocumentsTarget
Miejsce docelowe określone przez zbiór nazw dokumentów.
Pola | |
---|---|
documents[] |
Nazwy dokumentów do pobrania. W formacie: |
QueryTarget
Cel określony przez zapytanie.
Pola | |
---|---|
parent |
Nazwa zasobu nadrzędnego. W formacie |
Pole sumy query_type . Zapytanie do wykonania. query_type może być tylko jedną z tych wartości: |
|
structured_query |
Uporządkowane zapytanie. |
TargetChange
Obserwowane cele zmieniły się.
Pola | |
---|---|
target_change_type |
Rodzaj wprowadzonej zmiany. |
target_ids[] |
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. |
cause |
Błąd, który spowodował tę zmianę (w stosownych przypadkach). |
resume_token |
Token, który może być używany do wznawiania strumienia dla danego elementu Nie ustawiono dla każdej zmiany wartości docelowej. |
read_time |
Spójna wartość Gwarantujemy, że strumień W przypadku danego strumienia wartość |
TargetChangeType
rodzaj zmiany.
Wartości w polu enum | |
---|---|
NO_CHANGE |
Nie wprowadzono żadnych zmian. Służy tylko do wysłania zaktualizowanego resume_token . |
ADD |
Cele zostały dodane. |
REMOVE |
Cele zostały usunięte. |
CURRENT |
Wartości docelowe odzwierciedlają wszystkie zmiany wprowadzone przed dodaniem celów do strumienia. Ta wiadomość zostanie wysłana po ustawieniu wartości Detektory mogą zaczekać na tę zmianę, jeśli potrzebna jest semantyka odczytu po zapisaniu. |
RESET |
Cele zostały zresetowane. W kolejnych zmianach zostanie zwrócony ich nowy stan początkowy. Po zakończeniu stanu początkowego wartość |
TransactionOptions
Opcje tworzenia nowej transakcji.
Pola | |
---|---|
Pole sumy mode . Tryb transakcji. mode może być tylko jedną z tych wartości: |
|
read_only |
Transakcja może być używana tylko do operacji odczytu. |
read_write |
Transakcja może być używana zarówno do odczytu, jak i zapisu. |
ReadOnly
Opcje transakcji, których można używać tylko do odczytu dokumentów.
Pola | |
---|---|
Pole 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 być tylko jedną z tych wartości: |
|
read_time |
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. |
ReadWrite
Opcje transakcji, których można używać do odczytu i zapisu dokumentów.
Firestore nie zezwala na tworzenie transakcji odczytu i zapisu przez zewnętrzne żądania uwierzytelniania.
Pola | |
---|---|
retry_transaction |
Opcjonalna transakcja do ponowienia. |
UpdateDocumentRequest
Prośba dotycząca: Firestore.UpdateDocument
.
Pola | |
---|---|
document |
To pole jest wymagane. Zaktualizowany dokument. Tworzy dokument, jeśli jeszcze nie istnieje. |
update_mask |
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. |
mask |
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. |
current_document |
Opcjonalny warunek wstępny w dokumencie. Żądanie nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku. |
Wartość
Wiadomość, która może zawierać dowolny z obsługiwanych typów wartości.
Pola | |
---|---|
Pole sumy value_type . Wymagana jest wartość. value_type może być tylko jedną z tych wartości: |
|
null_value |
Wartość null. |
boolean_value |
Wartość logiczna. |
integer_value |
Liczba całkowita. |
double_value |
Podwójna wartość. |
timestamp_value |
Wartość sygnatury czasowej. Dokładność pomiaru tylko w mikrosekundach. W przypadku przechowywania dodatkowa precyzja jest zaokrąglana w dół. |
string_value |
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_value |
Wartość w bajtach. Nie może przekraczać 1 MiB do 89 bajtów. Zapytania uwzględniają tylko pierwsze 1500 bajtów. |
reference_value |
Odniesienie do dokumentu. Przykład: |
geo_point_value |
Wartość punktu geograficznego reprezentująca punkt na powierzchni Ziemi. |
array_value |
Wartość tablicy. Nie może zawierać bezpośrednio innej wartości tablicy, może jednak zawierać mapę zawierającą inną tablicę. |
map_value |
Wartość mapy. |
Zapis
Pismo w dokumencie.
Pola | |
---|---|
update_mask |
Pola do zaktualizowania w tym zapisie. To pole można skonfigurować tylko wtedy, gdy operacja to |
update_transforms[] |
Przekształcenia, które mają zostać wykonane po aktualizacji. To pole można skonfigurować tylko wtedy, gdy operacja to |
current_document |
Opcjonalny warunek wstępny w dokumencie. Zapis nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku. |
Pole sumy operation . Operacja do wykonania. operation może być tylko jedną z tych wartości: |
|
update |
Dokument do napisania. |
delete |
Nazwa dokumentu do usunięcia. W formacie: |
transform |
Stosuje przekształcenie do dokumentu. |
WriteRequest
Prośba dotycząca: Firestore.Write
.
Pierwsze żądanie powoduje utworzenie strumienia lub wznowienie istniejącego z użyciem tokena.
Podczas tworzenia nowego strumienia serwer wysyła odpowiedź zawierającą tylko identyfikator i token, których należy użyć w kolejnym żądaniu.
Podczas wznawiania strumienia serwer przesyła najpierw wszystkie odpowiedzi, które pojawią się później niż podany token. Następnie odpowiedź zawierająca tylko aktualny token zostanie użyta w następnym żądaniu.
Pola | |
---|---|
database |
To pole jest wymagane. Nazwa bazy danych. W formacie: |
stream_id |
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. |
writes[] |
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ń. |
stream_token |
Token strumienia, który został wcześniej wysłany przez serwer. Klient powinien ustawić w tym polu token z ostatniego otrzymanego parametru 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 Podczas tworzenia nowego strumienia pozostaw to pole nieskonfigurowane. |
labels |
Etykiety powiązane z tym żądaniem zapisu. |
WriteResponse
Odpowiedź dotycząca: Firestore.Write
.
Pola | |
---|---|
stream_id |
Identyfikator strumienia. Ustawiona tylko w pierwszej wiadomości, gdy utworzono nowy strumień. |
stream_token |
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. |
write_results[] |
Wynik zastosowania zapisów. Ten i-ty wynik zapisu odpowiada i-temu zapisowi w żądaniu. |
commit_time |
Czas wystąpienia zatwierdzenia. Gwarantujemy, że każdy odczyt o wartości |
WriteResult
Wynik zastosowania zapisu.
Pola | |
---|---|
update_time |
Czas ostatniej aktualizacji dokumentu po zastosowaniu zapisu. Nie ustawiono po: Jeśli zapis nie spowodował zmiany dokumentu, będzie to poprzednia wartość update_time. |
transform_results[] |
Wyniki zastosowania każdego z elementów typu |